Name
Suspend-JobSchedulerJob
SYNOPSIS
Suspends ("stops") jobs in the JobScheduler Master.
SYNTAX
Suspend-JobSchedulerJob [-Job] <String> [[-Directory] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet is used to suspend ("stop") jobs in the JobScheduler Master.
Suspended jobs will not restart automatically but will require either a
forced task start, e.g. with the Start-JobschedulerJob cmdlet, or a resume
operation, e.g. with the Resume-JoSchedulerJob cmdlet.
PARAMETERS
Job
-Job <String>
Specifies the full path and name of a job.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the directory of a job should the -Job parameter
not be provided with the full path but only the name of the job.
| Required? | false |
| Position? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByValue, 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-JobSchedulerJob -Job /sos/dailyschedule/CheckDaysSchedule
Suspends an individual job.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerJob -Directory /some_dir -Recursive | Suspend-JobSchedulerJob
Suspends all jobs from the specified directory and any sub-folders.