Name
Suspend-JobSchedulerMaster
SYNOPSIS
Pause JobScheduler Master, i.e. prevent any tasks from starting. Respectively the Resume-JobSchedulerMaster cmdlet will resume operations.
SYNTAX
Suspend-JobSchedulerMaster [[-MasterHost] <String>] [[-MasterPort] <Int32>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
When JobScheduler Master is paused then
* no new tasks are started
* running tasks are continued to complete:
** shell jobs will continue until their normal termination.
** API jobs complete a current spooler_process() call.
* any task starts that would normally occur during the pause period are postponed until JobScheduler Master is continued.
PARAMETERS
MasterHost
-MasterHost <String>
Should the operation to terminate or to restart a Master not be applied to a standalone Master instance
or to the active Master instance in a cluster, but to a specific Master instance in a cluster
then the respective Master's hostname has to be specified.
Use of this parameter requires to specify the corresponding -MasterPort parameter.
This information is returned by the Get-JobSchedulerStatus cmdlet with the "Cluster" node information.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
MasterPort
-MasterPort <Int32>
Should the operation to terminate or to restart a Master not be applied to a standalone Master instance
or to the active Master instance in a cluster, but to a specific Master instance in a cluster
then the respective Master's port has to be specified.
Use of this parameter requires to specify the corresponding -MasterHost parameter.
This information is returned by the Get-JobSchedulerStatus cmdlet with the "Cluster" node information.
| Required? | false |
| Position? | 2 |
| Default value | 0 |
| 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-JobSchedulerMaster
Suspends a standalone JobScheduler Master instance or the active Master instance in a cluster.
-------------------------- EXAMPLE 2 --------------------------
PS > Suspend-JobSchedulerMaster -MasterHost localhost -MasterPort 40444
Suspends a specific JobScheduler Master instance that could be a member in a cluster, e.g. the Backup Master instance in a cluster.