PowerShell CLI 2.0 - Cmdlets - Switch-JS7ControllerInstance

Name

Switch-JS7ControllerInstance

SYNOPSIS

Switches the roles of the active and standby JS7 Controller instances in a cluster

SYNTAX

Switch-JS7ControllerInstance [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

During switch-over the active Controller instance switches to standby mode and vice versa.

The following REST Web Service API resources are used:

* /controller/cluster/switchover

PARAMETERS

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.

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.

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.

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Switch-JS7ControllerInstance

Switches the roles of the active and standby JS7 Controller instances: The active instance switches to standby mode and vice versa.