Name
Test-JS7ControllerInstance
SYNOPSIS
Tests the connection to a JS7 Controller instance
SYNTAX
Test-JS7ControllerInstance [[-Url] <Uri>] [-StandBy] [<CommonParameters>]
DESCRIPTION
The cmdlets tests the connection between JOC Cockpit and a Controller instance.
A standalone Controller instance or the active or standby member of a Controller cluster can be
tested to be accessible.
The following REST Web Service API resources are used:
* /controller/test
PARAMETERS
Url
-Url <Uri>
Specifies the Url of the Controller instance to be tested.
Without use of this parameter and the -StandBy parameter
a standalone Controller instance or the active member of a Controller cluster is checked.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
StandBy
-StandBy <SwitchParameter>
Specifies that the standby member of Controller cluster should be be tested.
The alias parameter name -Passive can be used.
Without use of this parameter and the -Url parameter
a standalone Controller instance or the active member of a Controller cluster is checked.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $result = Test-JS7ControllerInstance
Checks if a standalone Controller instance or the active member of a Controller cluster is accessible.
-------------------------- EXAMPLE 2 --------------------------
PS > $result = Test-JS7ControllerInstance -StandBy
Checks if the standby member of a Controller cluster is accessible.
-------------------------- EXAMPLE 3 --------------------------
PS > $result = Test-JS7ControllerInstance -Url (Get-JS7ControllerInstance -Active).active.url
Checks if the Controller instance from the given URL is accessible.
Overview
Content Tools