Page History

...

Stops a JobScheduler Master or a Master Cluster

SYNTAX

Stop-JobSchedulerMaster [[-Action] <String>] [-Restart] [-Cluster] [[-MasterHost] <String>] [[-MasterPort] <Int32>] [[-Timeout] <Int32>] [[-Pid] <Int32>] [-Service] [[-AuditComment] <String>] [ [-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

The stop stopping of a Master or Master Cluster can be performed in a graceful manner leaving some time to
running tasks for completion. In addition more immediate operations for aborting
or killing a Master are available and Master instances can be restarted.

...

-Action <String>
Stopping 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 "terminate-fail-safe"
** terminates an instance in the same way as -Action "terminate".
** in addition in a Passive Cluster the backup instance will be activated after termination of the primary instance.

* Action "abort"
** no new tasks are started.
** any running tasks are killed.
** JobScheduler Master terminates normally.

* Action "kill"
** the process of the JobScheduler Master is killed including any tasks running.
** no cleanup is performed, e.g. database connections are not closed.
** this action might require elevated privileges of an administrator.
** this operation works on a single Master that is available from a local Master installation and requires prior use of the -UseJobSchedulerMaster cmdlet.
* Action "reactivate"
** performs a fail-back operation in a Master Cluster.
** the currently passive Master becomes active
** the currently active Master is restarted to become a passive cluster member.

...

-Restart <SwitchParameter>
When used with the operations -Action "terminate" and "abort" then the
JobScheduler Maser instance (s) will shut down and restart.

This switch can be used with the -Cluster switch swith to restart a JobScheduler Master Cluster.

...

-Cluster <SwitchParameter>
Carries out the operation -Action "terminate" for a JobScheduler Master Cluster:

* All instances are terminated and optionally are restarted.
* Optional -Timeout settings apply to this operation.

MasterHost

...

...

MasterPort

...

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.

The timeout is applied when shutting down or restarting (-Restart switch) invidual instances or clustered instances (-Cluster switch).

...

-Pid <Int32>
When carrying out the operation -Action "kill" then

* with the PID being specified the given process will be killed
* with no PID being specified the PID is used from the PID file that is created on JobScheduler Master start.

...

-Service <SwitchParameter>
Stops the JobScheduler Master Windows Service

Use of this parameter ignores any other parameters.
The Windows service is stopped as specified with -Action "terminate".
No timeout and no cluster operations are applied.

AuditComment

...

...

AuditTimeSpent

...

AuditTicketLink

...

RELATED LINKS

about_jobscheduler

...

PS > Stop-JobSchedulerMaster

Stops a standalone the JobScheduler Master instance with normal termination. This is the same as the operation: Stop-JobSchedulerMaster Instance -Action "terminate"

-------------------------- EXAMPLE 2 --------------------------

PS > Stop-JobSchedulerMaster -MasterHost localhost -MasterPort 40444Stops a JobScheduler Master instance that is a member in a cluster with normal termination. This is the same as the operation: Stop-JobSchedulerMaster -Action "terminate"

-------------------------- EXAMPLE 3 --------------------------

PS > Stop-JobSchedulerMaster -Service

Stops the JobScheduler Master Windows Service service with normal termination, i.e. with -Action "terminate" without any timeouts and cluster options being applied.

-------------------------- EXAMPLE 4 3 --------------------------

PS > Stop-JobSchedulerMaster -Action abort -Restart

Stops a standalone the JobScheduler Master instance or the active member of a cluster by immediately killing any tasks and aborting the JobScheduler Master. After shutdown the JobScheduler Master instance is restarted.

-------------------------- EXAMPLE 5 4 --------------------------

PS > Stop-JobSchedulerMaster -Action kill -MasterHost localhost -MasterPort 40444

Kills the specific JobScheduler Master instance that is a member in a cluster and kills JobScheduler process and any tasks without proper cleanup.

-------------------------- EXAMPLE 6 5 --------------------------

...

Carries out the -Action "terminate" operation for all members of a JobScheduler Master Cluster. All running tasks are sent a SIGTERM signal and after expiration of the timeout any running tasks will be sent a SIGKILL signal.

-------------------------- EXAMPLE 7 6 --------------------------

...

Carries out the -Action "terminate" operation for all members of a JobScheduler Master Cluster. All running tasks are sent a SIGTERM signal and after expiration of the timeout any running tasks will be sent a SIGKILL signal. After termination all cluster members will willl be restarted.