Name
Update-JobSchedulerJobChain
SYNOPSIS
Updates a number of job chains in the JobScheduler Master.
SYNTAX
Update-JobSchedulerJobChain [-JobChain] <String> [[-Directory] <String>] [-Action] <String> [<CommonParameters>]
DESCRIPTION
Updating job chains includes operations to suspend and resume job chains.
Job chains are selected for update
* by a pipelined object, e.g. the output of the Get-JobSchedulerJobChain cmdlet
* by specifying an individual JobChain with the -JobChain parameter.
PARAMETERS
JobChain
-JobChain <String>
Specifies the path and name of a job chain that should be updated.
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 |
Action
-Action <String>
Specifies the action to be applied to a job chain:
* Action "suspend"
** Suspends a job chain, i.e. the job chain is stopped and will not continue without being resumed.
* Action "resume"
** Resumes a suspended job chain.
Required? | true |
Position? | 3 |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Update-JobSchedulerJobChain -JobChain /sos/reporting/Reporting -Action suspend
Suspends the job chain "Reporting"
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerJobChain | Update-JobSchedulerJobChain -Action suspend
Suspends all job chains
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JobSchedulerJobChain -Directory / -NoSubfolders | Update-JobSchedulerJobChain -Action resume
Updates all job chains that are configured with the root folder ("live" directory) without consideration of subfolders to be resumed.