NAME
Restart-JobSchedulerMaster
SYNOPSIS
Restarts the JobScheduler Master
SYNTAX
Restart-JobSchedulerMaster [-Action <String>] -Cluster [-Timeout <Int32>] -Service <CommonParameters>
DESCRIPTION
JobScheduler is restarted. Depending on its current operating mode JobScheduler
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
Accept pipeline input? false
Accept wildcard characters?
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
Accept pipeline input? false
Accept wildcard characters?
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.
- in a Unix environment the task is sent a SIGTERM signal and - in case of the timeout parameter being used -
- 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? 2
Default value
Accept pipeline input? false
Accept wildcard characters?
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
Accept pipeline input? false
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Restart-Master
Restarts the JobScheduler Master.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Restart-Master -Service
Retarts the JobScheduler Master Windows service.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Restart-Master -Cluster -Timeout 20
Retarts the JobScheduler Master Cluster and allows running tasks 20s for completion.