functions/Switch-JS7JOCInstance.ps1
|
function Switch-JS7JOCInstance { <# .SYNOPSIS Switches the role of the active JS7 JOC Cockpit instance in a cluster .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 .PARAMETER MemberId 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. .PARAMETER AuditComment 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. .PARAMETER AuditTimeSpent 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. .PARAMETER AuditTicketLink 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. .EXAMPLE 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 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. .LINK about_JS7 #> param ( [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $MemberId, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $AuditComment, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [int] $AuditTimeSpent, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [Uri] $AuditTicketLink ) Begin { Approve-JS7Command $MyInvocation.MyCommand $stopWatch = Start-JS7StopWatch if ( !$AuditComment -and ( $AuditTimeSpent -or $AuditTicketLink ) ) { throw "$($MyInvocation.MyCommand.Name): Audit Log comment required, use parameter -AuditComment if one of the parameters -AuditTimeSpent or -AuditTicketLink is used" } } Process { if ( !$MemberId ) { $jocCluster = Get-JS7JOCInstance if ( $jocCluster.passive.count -gt 0 ) { $MemberId = $jocCluster.passive[0].memberId } } $body = New-Object PSObject Add-Member -Membertype NoteProperty -Name 'memberId' -value $MemberId -InputObject $body if ( $AuditComment -or $AuditTimeSpent -or $AuditTicketLink ) { $objAuditLog = New-Object PSObject Add-Member -Membertype NoteProperty -Name 'comment' -value $AuditComment -InputObject $objAuditLog if ( $AuditTimeSpent ) { Add-Member -Membertype NoteProperty -Name 'timeSpent' -value $AuditTimeSpent -InputObject $objAuditLog } if ( $AuditTicketLink ) { Add-Member -Membertype NoteProperty -Name 'ticketLink' -value $AuditTicketLink -InputObject $objAuditLog } Add-Member -Membertype NoteProperty -Name 'auditLog' -value $objAuditLog -InputObject $body } [string] $requestBody = $body | ConvertTo-Json -Depth 100 $response = Invoke-JS7WebRequest -Path '/joc/cluster/switch_member' -Body $requestBody if ( $response.StatusCode -eq 200 ) { $requestResult = ( $response.Content | ConvertFrom-JSON ) if ( !$requestResult.ok ) { throw ( $response | Format-List -Force | Out-String ) } } else { throw ( $response | Format-List -Force | Out-String ) } } End { Trace-JS7StopWatch -CommandName $MyInvocation.MyCommand.Name -StopWatch $stopWatch Update-JS7Session } } |