Name
Suspend-JobSchedulerOrder
SYNOPSIS
Suspends a number of orders in the JobScheduler Master.
SYNTAX
Suspend-JobSchedulerOrder [-Order] <String> [-JobChain] <String> [[-Directory] <String>] [<CommonParameters>]
DESCRIPTION
This cmdlet is an alias for Update-JobSchedulerOrder -Action "suspend"
PARAMETERS
Order
-Order <String>
Specifies the identifier of an order.
Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
JobChain
-JobChain <String>
Specifies the path and name of a job chain for which orders should be suspended.
Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder where the job chain is located. The directory is determined
from the root folder, i.e. the "live" directory.
If the -JobChain parameter specifies the name of job chain then the location specified from the
-Directory parameter is added to the job chain location.
| Required? | false |
| Position? | 3 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Suspend-JobSchedulerOrder -Order Reporting -JobChain /sos/reporting/Reporting
Suspends the order "Reporting" from the specified job chain.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerOrder | Suspend-JobSchedulerOrder
Suspends all orders for all job chains.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JobSchedulerOrder -Directory / -NoSubfolders | Suspend-JobSchedulerOrder
Suspends orders that are configured with the root folder ("live" directory) without consideration of subfolders.
-------------------------- EXAMPLE 4 --------------------------
PS > Get-JobSchedulerOrder -JobChain /test/globals/chain1 | Suspend-JobSchedulerOrder
Suspends all orders for the specified job chain.