JS7 JobScheduler

Space shortcuts

Page tree

Name

Switch-JS7JOCInstance

SYNOPSIS

Switches the role of the active JS7 JOC Cockpit instance in a cluster

SYNTAX

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

DESCRIPTION

During switch-over the active JOC Cockpit instance switches to the standby and vice versa.

The following REST Web Service API resources are used:

* /joc/cluster/switch_member

PARAMETERS

MemberId

-MemberId <String>
Specifies the identification of the standby JOC Cockpit cluster member that should become active.
This information is provided with the Get-JS7JOCInstance cmdlet that returns an array of standby cluster members.

Required?false
Position?1
Default value
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?2
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?3
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?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > Switch-JS7JOCInstance

Switches the roles of the active and standby JS7 JOC Cockpit instances: The active instance switches to standby mode and one of the standby instances becomes active.

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

PS > Switch-JS7JOCInstance -MemberId ( (Get-JS7JOCInstance).Passive | Where-Object -Property 'host' -eq -Value 'joc-2-0-secondary' ).memberId

Switches the role of the active JOC Cockpit instance to the indicated cluster member that is currently in standby mode. As any number of JOC Cockpit standby cluster members can be used, one of them is selected by its hostname.

  • No labels