Page History

Name

Stop-JS7ControllerInstance

SYNOPSIS

Stops a JS7 Controller instance

...

Stop-JS7ControllerInstance [[-Url] <Uri>] [[-Action] <String>] [-Restart] [-NoFailover] [-Service] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The stop of Stopping a Controller instance is performed and optionally the instance fails over
to the passive cluster member in a JS7 Controller cluster.

The following REST Web Service API resources are used:

* /controller/abort
* /controller/abort_and_restart
* /controller/restart
* /controller/terminate

...

-Url <Uri>
Optionally the Url of the Controller instance to be stopped can be specified.
Without this parameter the active Controller will be stopped.
Consider Note that stopping a passive Controller in a JS7 cluster cannot perform
a fail-over as the current cluster member instance is passive.

Action

-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.
** Controller terminates normally.

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

Restart

-Restart <SwitchParameter>
When used with the operations -Action 'terminate' and 'abort' then the
Controller instance will shut down and restart.

This switch provides the same capabilities as the Restart-JS7Controller cmdlet.

NoFailover

-NoFailover <SwitchParameter>
This switch prevents a fail-over to happen from happening when stopping the active Controller
in a cluster. Instead, the restarted Controller will remain the active cluster instance.

Service

-Service <SwitchParameter>
Stops the Controller 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

-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 enforce Audit Log comments for any interventions.

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 JS7.

AuditTicketLink

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

This information is visible with shown in the Audit Log view of the JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

...