Name
Stop-JS7ControllerInstance
SYNOPSIS
Stops a JS7 Controller instance
SYNTAX
Stop-JS7ControllerInstance [[-Url] <Uri>] [[-Action] <String>] [-Restart] [-NoFailover] [-Service] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The stopping of 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
PARAMETERS
Url
-Url <Uri>
Optionally the Url of the Controller instance to be stopped can be specified.
Without this parameter the active Controller will be stopped.
Note that stopping a passive Controller in a JS7 cluster cannot perform
a fail-over as the current cluster member instance is passive.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | 2 |
| Default value | terminate |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NoFailover
-NoFailover <SwitchParameter>
This switch prevents a fail-over from happening when stopping the active Controller
in a cluster. Instead, the restarted Controller will remain the active cluster instance.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | named |
| Default value | False |
| 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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all 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 shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.
| 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 JS7.
This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.
| Required? | false |
| Position? | 5 |
| 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 > Stop-JS7ControllerInstance
Stops a standalone JS7 Controller instance or active Cluster instance with normal termination. In a JS7 cluster a fail-over takes place unless the -NoFailover switch is used.
-------------------------- EXAMPLE 2 --------------------------
PS > Stop-JS7ControllerInstance -Action 'abort'
Aborts a standalone JS7 Controller instance or active Cluster instance. In a JS7 cluster a fail-over takes place unless the -NoFailover switch is used.
-------------------------- EXAMPLE 3 --------------------------
PS > Stop-JS7ControllerInstance -Url (Get-JS7ControllerStatus.Passive.Url)
Stops a passive JS7 Controller instance with normal termination.
-------------------------- EXAMPLE 4 --------------------------
PS > Stop-JS7ControllerInstance -Url (Get-JS7ControllerStatus).Passive.Url) -Restart
Restarts a JS7 Controller instance that is the passive member in a cluster.
-------------------------- EXAMPLE 5 --------------------------
PS > Stop-JS7ControllerInstance -Service
Stops the JS7 Controller Windows Service with normal termination, i.e. with -Action 'terminate'.
-------------------------- EXAMPLE 6 --------------------------
PS > Stop-JS7ControllerInstance -Action 'abort' -Restart
Aborts a standalone JS7 Controller instance or the active member of a cluster. A fail-over to the passive cluster instance takes place. After shutdown the JS7 Controller instance is restarted.
Overview
Content Tools