Name
Get-JobSchedulerOrder
SYNOPSIS
Returns orders from the JobScheduler Master.
...
-OrderId <String>
Optionally specifies the path and name of an order that should be returned.
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 provided.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder for which orders 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 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 can be time-consuming.
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
-Permanent <SwitchParameter>
Specifies that orders 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
-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
-Pending <SwitchParameter>
Specifies that 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
-Running <SwitchParameter>
Specifies that 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
-WaitingForResource <SwitchParameter>
Specifies that orders 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
...