Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Test-JS7ControllerInstance

SYNOPSIS

Tests the connection to a JS7 Controller instance

SYNTAX

Test-JS7ControllerInstance [[-Url] <Uri>] [-Passive] [<CommonParameters>]

DESCRIPTION

The cmdlets tests the connection between JOC Cockpit and a Controller instance.
A standalone Controller instance or the active or passive member of a Controller cluster can be
tested to be accessible.

PARAMETERS

Url

-Url <Uri>
Specifies the Url of the Controller instance to be tested.

Without use of this parameter and the -Passive 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

Passive

-Passive <SwitchParameter>
Specifies that the passive member of Controller cluster should be be tested.

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 valueFalse
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

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 -Passive

Checks if the passive 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.