...
Get-JobSchedulerOrder
SYNOPSIS
Returns a number of active orders from the JobScheduler Master.
...
Get-JobSchedulerOrder [[-OrderIdDirectory] <String>] [[-JobChain] <String>] [[-DirectoryOrder] <String>] [-Recursive] [-Compact] [-WithHistory] [-WithLog] [ [-MaxLastHistoryItems] <Int32>NoSubfolders] [-Permanent] [-Temporary] [-FileOrderNoPermanent] [-Pending] [-Running] [-WaitingForResource] [-Suspended] [-Setback] [-BlacklistNoCache] [<CommonParameters>]
DESCRIPTION
Orders are returned if they are selected from the 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
* by the folder of the order location including sub-folders,subfolders
* 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
...
Directory
-OrderId Directory <String>
Optionally specifies the path and name of an order that folder for which orders 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 orderThe 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? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Order
-Directory Order <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
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.
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
...
| 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
This operation is 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
...
NoSubfolders
-NoSubfolders <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for orders
| 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)false |
| Accept wildcard characters? | false |
...
NoPermanent
-Temporary NoPermanent <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)false |
| Accept wildcard characters? | false |
...
Suspended
-FileOrder Suspended <SwitchParameter>
Specifies that file only suspended 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)false |
| Accept wildcard characters? | false |
...
Setback
-Pending Setback <SwitchParameter>
Specifies that only setback 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)false |
| Accept wildcard characters? | false |
...
NoCache
-Running NoCache <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 locationthe 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 | False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
PS > $orders = Get-JobSchedulerOrder
Returns all permanent orders.
-------------------------- EXAMPLE 2 --------------------------
PS > $orders = Get-JobSchedulerOrder -Directory / some_path -RecursiveNoSubfolders
Returns all orders that are configured with the root folder ("some_path" inclluding any sub-folderslive" directory) without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
...
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.