Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Restart-JS7ControllerInstance

SYNOPSIS

Restarts a JS7 Controller Instance and optionally performs cluster fail-over

SYNTAX

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

DESCRIPTION

A JS7 Controller instance is restarted. In a JS7 cluster a fail-over
to the standby cluster member is performed by default.

The following REST Web Service API resources are used:

* /inventory/releasable

PARAMETERS

Url

-Url <Uri>
Optionally the Url of the Controller to be restarted can be specified.
Without this parameter the active Controller instance will be restarted.
Note that restarting a standby Controller instance in a JS7 cluster does not perform
a fail-over operation.

Required?false
Position?1
Default value
Accept pipeline input?false
Accept wildcard characters?false

Action

-Action <String>
Restarting a Controller instance 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 process step.
** 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 valueterminate
Accept pipeline input?false
Accept wildcard characters?false

NoFailover

-NoFailover <SwitchParameter>
This switch prevents a fail-over from happenning when restarting the active Controller instance
in a cluster. Instead, the restarted Controller instance will remain the active cluster member.

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

Service

-Service <SwitchParameter>
Retarts the JS7 Windows service.

When this parameter is not specified JS7 will be started in
the appropriate operating mode, i.e. service mode or dialog mode.

Required?false
Position?named
Default valueFalse
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 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 value0
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 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

about_JS7

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 standby cluster member. Use -of the -NoFailover switch prevents the switch-over.

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

PS > Restart-JS7ControllerInstance -Url (Get-JS7ControllerStatus).Active.Url

Restarts the JS7 Controller active cluster member or standalone instance.

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

PS > Restart-JS7ControllerInstance -Url (Get-JS7ControllerStatus).Passive.Url -NoFailover

Restarts the JS7 Controller standby cluster member. Consider use of the -NoFailover switch as a standby cluster member cannot switch-over to an active cluster member.

-------------------------- EXAMPLE 4 --------------------------

PS > Restart-JS7ControllerInstance -Service

Restarts the JS7 Controller Windows service.