Name
Get-JobSchedulerOrder
SYNOPSIS
Returns a number of active orders from the JobScheduler Master.
SYNTAX
Get-JobSchedulerOrder [[-Directory] <String>] [[-JobChain] <String>] [[-Order] <String>] [-WithLog] [-NoSubfolders] [-NoPermanent] [-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
* by the folder of the order location including 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
-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? | 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 |
Order
-Order <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.
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 |
WithLog
-WithLog <SwitchParameter>
Specifies the order log to be returned.
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 |
NoSubfolders
-NoSubfolders <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for orders.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
NoPermanent
-NoPermanent <SwitchParameter>
Specifies that no permanent orders should be looked up but instead ad hoc orders only.
By default only permanent orders will be looked up.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Suspended
-Suspended <SwitchParameter>
Specifies that only suspended orders should be returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Setback
-Setback <SwitchParameter>
Specifies that only setback orders should be returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
NoCache
-NoCache <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 | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $orders = Get-JobSchedulerOrder
Returns all orders.
-------------------------- EXAMPLE 2 --------------------------
PS > $orders = Get-JobSchedulerOrder -Directory / -NoSubfolders
Returns all orders that are configured with the root folder ("live" directory) without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
PS > $orders = Get-JobSchedulerOrder -JobChain /test/globals/chain1
Returns the orders for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 4 --------------------------
PS > $orders = Get-JobSchedulerOrder -Order /test/globals/order1
Returns the order "order1" from the folder "/test/globals".