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 switchover the active JOC Cockpit instance becomes passive and vice versa.
PARAMETERS
MemberId
-MemberId <String>
Specifies the identification of the passive JOC Cockpit cluster member that should become active.
This information is provided with the Get-JS7JOCCluster cmdlet that returns an array of passive 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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any 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 visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
Required? | false |
Position? | 3 |
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 JobScheduler.
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 JobScheduler.
Required? | false |
Position? | 4 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Switch-JS7JOCInstance
Switches the roles of the active and passive JS7 JOC Cockpit instances: The active instance becomes passive and one of the passive 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 passive. As any number of JOC Cockpit passive cluster members can be used, one of them is selected by its hostname.