Name
Suspend-JobSchedulerJobChain
SYNOPSIS
Suspends a number of job chains in the JobScheduler Master.
SYNTAX
Suspend-JobSchedulerJobChain [-JobChain] <String> [[-Directory] <String>] [<CommonParameters>]
DESCRIPTION
This cmdlet is an alias for Update-JobSchedulerJobChain -Action "suspend"
PARAMETERS
JobChain
-JobChain <String>
Specifies the path and name of a job chain that should be suspended.
The parameter -JobChain has to be specified if no pipelined job chain objects are used.
| Required? | true |
| Position? | 1 |
| 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? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Suspend-JobSchedulerJobChain -JobChain /sos/reporting/Reporting
Suspends the job chain "Reporting". from the specified folder.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerJobChain | Suspend-JobSchedulerJobChain
Suspends all job chains.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JobSchedulerJobChain -Directory / -NoSubfolders | Suspend-JobSchedulerJobChain
Suspends job chains that are configured with the root folder ("live" directory) without consideration of subfolders.
-------------------------- EXAMPLE 4 --------------------------
PS > Get-JobSchedulerJobChain -JobChain /test/globals/chain1 | Suspend-JobSchedulerJobChain
Suspends the specified job chain.