Name
Restart-JobSchedulerMaster
SYNOPSIS
Restarts the JobScheduler Master
SYNTAX
Restart-JobSchedulerMaster [[-Action] <String>] [-Cluster] [[-MasterHost] <String>] [[-MasterPort] <Int32>] [[-Timeout] <Int32>] [-Service] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
JobScheduler Master is restarted. Depending on its current operating mode the Master
is restarted in service mode or in dialog mode:
* Service Mode: the Windows service of the JobScheduler Master is restarted.
* Dialog Mode: the JobScheduler Master is restarted in its current user context.
PARAMETERS
Action
-Action <String>
Restarting includes the following actions:
* Action "terminate" (Default)
** 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.
** JobScheduler Master terminates normally.
* Action "abort"
** no new tasks are started.
** any running tasks are killed.
** JobScheduler Master terminates normally.
| Required? | false |
| Position? | 1 |
| Default value | terminate |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Cluster
-Cluster <SwitchParameter>
Carries out the operation -Action "terminate" for a JobScheduler Cluster:
* All instances are terminated and restarted.
* Optional -Timeout settings apply to this operation.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
MasterHost
-MasterHost <String>
When the operations to terminate or to restart a Master should not be applied to all cluster members
but to a specific Master instance only then the respective Master's hostname has to be specified.
Use of this parameter requires to use the -MasterPort parameter as well.
This information is returned by the Get-JobSchedulerStatus cmdlet with the "Cluster" node information.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
MasterPort
-MasterPort <Int32>
When the operations to terminate or to restart a Master should not be applied to all cluster members
but to a specific Master instance only then the respective Master's post has to be specified.
Use of this parameter requires to use the -MasterHost parameter as well.
This information is returned by the Get-JobSchedulerStatus cmdlet with the "Cluster" node information.
| Required? | false |
| Position? | 3 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Timeout
-Timeout <Int32>
A timeout is applied for the operation -Action "terminate" that affects running tasks:
* For shell jobs
** in a Unix environment the task is sent a SIGTERM signal and - in case of the timeout parameter being used -
after expiration of the timeout a SIGKILL signal is sent.
** in a Windows environment the task is killed immediately.
* For API jobs
** the method spooler_process() of the respective job will not be called by JobScheduler any more.
** the task is expected to terminate normally after completion of its spooler_process() method.
| Required? | false |
| Position? | 4 |
| Default value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Service
-Service <SwitchParameter>
Retarts the JobScheduler Windows service.
Without this parameter being specified JobScheduler will be started in
its respective operating mode, i.e. service mode or dialog mode.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| 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? | 5 |
| 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? | 6 |
| 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? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Restart-JobSchedulerMaster
Terminates and restarts the JobScheduler Master. Any running tasks can complete before the Master will restart.
-------------------------- EXAMPLE 2 --------------------------
PS > Restart-JobSchedulerMaster -Service
Retarts the JobScheduler Master Windows service.
-------------------------- EXAMPLE 3 --------------------------
PS > Restart-JobSchedulerMaster -Cluster -Timeout 20
Retarts the JobScheduler Master Cluster and allows running tasks 20s for completion.