...
Name
Get-JobSchedulerOrder
SYNOPSIS
Returns a number of active orders from the JobScheduler Master.
SYNTAX
Get-JobSchedulerOrder [[-
DirectoryOrderId] <String>] [[-JobChain] <String>] [[-
OrderDirectory] <String>] [-Recursive] [-Compact] [-WithHistory] [-WithLog
-NoSubfolders [-N
oPermanent] -Suspended -Setback -NoCache <CommonParameters>
DESCRIPTION
Orders are returned if they are present in the JobScheduler Master.
No ad hoc orders are returned that are completed and not active
with a Master. For information on such orders consider the Get-JobSchedulerOrderHistory cmdlet.
Orders are selected from a JobScheduler Master
] [[-MaxLastHistoryItems] <Int32>] [-Permanent] [-Temporary] [-FileOrder] [-Pending] [-Running] [-WaitingForResource] [-Suspended] [-Setback] [-Blacklist] [<CommonParameters>]
DESCRIPTION
Orders are selected from the JobScheduler Master
* by the folder of the order location including
...
sub-folders,
* by the job chain that is assigned to an order,
* by an individual order.
Resulting orders can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
...
OrderId
-
Directory OrderId <String>
Optionally specifies the folder for which orders path and name of an order that should be returned. The directory is determined
from the root folder, i.e. the "live" directory.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
d.
...
If the name of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Order parameter is assumed to include the full path and name of the order.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
JobChain
-JobChain <String>
Optionally specifies the path and name of a job chain for which orders should be returned.
If the name of a job chain is specified then the -Directory parameter is used to determine the folder.
Otherwise the -JobChain parameter is assumed to include the full path and name of the job chain.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
dprovided.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
...
Directory
-
Order Directory <String>
Optionally specifies the path and name of an order that folder for which orders should be returned. The directory is determined
If the name of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Order parameter is assumed to include the full path and name of the orderfrom the root folder, i.e. the "live" directory.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
dare provided.
Required? | false |
Position? | 3 |
Default value | / |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up if the -Directory parameter is used.
By default no sub-folders will be searched for orders.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
Specifies that fewer attributes of orders are returned.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
WithHistory
-WithHistory <SwitchParameter>
Specifies the order history to be returned, i.e. the history of previous executions of orders.
The parameter -MaxLastHstoryitems specifies the number of history items to be returned.
Required? | false |
Position? |
...
named | |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
WithLog
-WithLog <SwitchParameter>
Specifies the order log to be returned. This implicitely includes to return the order history.
For each history item - up to the number speicifed with the -MaxLastHistoryItems parameter -
the order log is returned.
This operation is can be time-consuming and should be restricted to selecting individual orders.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | false |
MaxLastHistoryItems
-MaxLastHistoryItems <Int32>
Specifies the number of the most recent history items of order executions to be returned.
Default: 1
Required? | false |
Position? | 4 |
Default value | 1 |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? |
...
false |
Permanent
-
NoSubfolders Permanent <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for ordersorders of the permanent type are returned, i.e. orders that have been pre-configured and
that optionally include run-time settings for an automated start.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? |
...
true (ByPropertyName) | |
Accept wildcard characters? |
...
false |
Temporary
-
NoPermanent Temporary <SwitchParameter>
Specifies that no permanent orders should be looked up but instead ad hoc orders only.
Such orders are added on-the-fly to existing job chains.
By default only permanent orders will be looked up.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
FileOrder
-FileOrder <SwitchParameter>
Specifies that file orders should be returned, i.e. orders that are represented by files
arriving in directories that are configured for file watching.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? |
...
false |
Pending
-
Suspended Pending <SwitchParameter>
Specifies that only suspended orders in a pending state should be returned. Such orders are scheduled
for a later start. This state can apply to permanent orders and to ad hoc orders.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? |
...
true (ByPropertyName) | |
Accept wildcard characters? |
...
false |
Running
-
Setback Running <SwitchParameter>
Specifies that only setback orders in a running state should be returned, i.e. orders for which a job is
executed in a job chain.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? |
...
true (ByPropertyName) | |
Accept wildcard characters? |
...
false |
WaitingForResource
-
NoCache WaitingForResource <SwitchParameter>
Specifies that the cache for JobScheduler objects is ignored.
This results in the fact that for each Get-JobScheduler* cmdlet execution the response is
retrieved directly from the JobScheduler Master and is not resolved from the cache.Required? false
Position? named
Default value
Accept pipeline input? falseorders should be returned that are waiting e.g. for an Agent or for a task
to become available for the underlying job that is executed for the order.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Suspended
-Suspended <SwitchParameter>
Specifies that orders in suspended state should be returned. An order can be suspended
e.g. in case of failure of the underlying job or when being affected by the
Suspend-JobSchedulerOrder cmdlet or the respective manual operation from the GUI.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Setback
-Setback <SwitchParameter>
Specifies that orders in a setback state should be returned. Such orders make use of an interval
- specified by the underlying job - for which they are repeated in case that the job fails.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Blacklist
-Blacklist <SwitchParameter>
Specifies that orders should be returned that represent incoming files that a Master or Agent
is watching for and for which errors occurred when moving the incoming file from its location.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$orders PS > $orders = Get-JobSchedulerOrder
Returns all permanent orders.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$orders PS > $orders = Get-JobSchedulerOrder -Directory /some_path -
NoSubfoldersRecursive
Returns all orders that are configured with the root folder ( "live" directory)
without consideration of subfolderssome_path" inclluding any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$orders PS > $orders = Get-JobSchedulerOrder -JobChain /test/globals/chain1
Returns the orders for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 4 --------------------------
C:\PS>$orders PS > $orders = Get-JobSchedulerOrder -Order /test/globals/order1
Returns the order "order1" from the folder "/test/globals".
-------------------------- EXAMPLE 5 --------------------------
PS > $orders = Get-JobSchedulerOrder -Suspended -WaitingForResource
Returns any orders that have been suspended, e.g. due to job failures, or that are waiting for Agents or tasks to become available for the underlying job.
-------------------------- EXAMPLE 6 --------------------------
PS > $orders = Get-JobSchedulerOrder -Setback
Returns any orders that are waiting for a time interval to be repeated after failure of the underlying job.