Name
Suspend-JobSchedulerJobChain
SYNOPSIS
Suspends job chains in the JobScheduler Master.
SYNTAX
Suspend-JobSchedulerJobChain [-JobChain] <String> [[-Directory] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet suspends ("stops") job chians in a JobScheduler Master.
Any orders added to the job chain further on will wait until the job chain is resumed ("unstopped").
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 |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
| Required? | false |
| Position? | 4 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
| Required? | false |
| Position? | 5 |
| 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 /some_path -Recursive | Suspend-JobSchedulerJobChain
Suspends job chains that are configured with the folder "some_path" and any sub-folders recursively.
-------------------------- EXAMPLE 4 --------------------------
PS > Get-JobSchedulerJobChain -JobChain /test/globals/chain1 | Suspend-JobSchedulerJobChain
Suspends the specified job chain.