Name
Restart-JS7ControllerInstance
SYNOPSIS
Restarts a JS7 Controller Instance
SYNTAX
Restart-JS7ControllerInstance [[-Url] <Uri>] [[-Action] <String>] [-NoFailover] [-Service] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
A JS7 Controller instance is restarted. In a JS7 cluster by default a fail-over
to the passive cluster member is performed.
PARAMETERS
Url
-Url <Uri>
Optionally the Url of the Controller to be restarted can be specified.
Without this parameter the active Controller will be restarted.
Consider that restarting 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>
Restarting a Controller 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.
** JS7 Controller terminates normally.
* Action 'abort'
** no new tasks are started.
** any running tasks are killed.
** JS7 Controller terminates normally.
| Required? | false |
| Position? | 2 |
| Default value | terminate |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
NoFailover
-NoFailover <SwitchParameter>
This switch prevents a fail-over to happen when restarting 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>
Retarts the JS7 Windows service.
Without this parameter being specified JS7 will be started in
its respective operating mode, i.e. service mode or dialog mode.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| 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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any 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 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.
| 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 visible with 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Restart-JS7ControllerInstance
Terminates and restarts the JS7 Controller. In a cluster the active cluster member is restarted and a fail-over takes place to the passive cluster member. Use -of the -NoFailover switch prevents the switch-over.
-------------------------- EXAMPLE 2 --------------------------
PS > Restart-JS7ControllerInstance -Url (Get-JS7Status).Active.Url
Retarts the JS7 Controller active cluster member or standalone instance.
-------------------------- EXAMPLE 3 --------------------------
PS > Restart-JS7ControllerInstance -Url (Get-JS7Status).Passive.Url -NoFailover
Retarts the JS7 Controller passive cluster member. Consider use of the -NoFailover switch as a passive cluster member cannot switch-over to an active cluster member.
-------------------------- EXAMPLE 4 --------------------------
PS > Restart-JS7ControllerInstance -Service
Retarts the JS7 Controller Windows service.
Overview
Content Tools