Page History
...
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 stop 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.
Consider Note that stopping a passive Controller in a JS7 cluster cannot perform
a fail-over as the current cluster member instance is passive.
...
-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.
...
-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, however, the JOC Cockpit can be configured to enforece require Audit Log comments for any all interventions.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 4 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobSchedulerJS7.
This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.
| 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 JobScheduler 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.
...
PS > Stop-JS7ControllerInstance -Action 'abort'
Aborts a standalone JobScheduler JS7 Controller instance or active Cluster instance. In a JS7 cluster a fail-over takes place unless the -NoFailover switch is used.
...
PS > Stop-JS7ControllerInstance -Url (Get-JS7StatusJS7ControllerStatus.Passive.Url)
Stops a passive JS7 Controller instance with normal termination.
...
PS > Stop-JS7ControllerInstance -Url (Get-JS7StatusJS7ControllerStatus).Passive.Url) -Restart
Restarts a JS7 Controller instance that is the passive member in a cluster.
...
Aborts a standalone JS7 Controller instance or the active member of a cluster. A fail-over to the passive cluser cluster instance takes place. After shutdown the JS7 Controller instance is restarted.
Overview
Content Tools