Page History
Name
Get-JS7ControllerInstance
SYNOPSIS
Returns information about a JS7 Controller instance from JOC Cockpit
SYNTAX
Get-JS7ControllerInstance [[-Id] <String>] [-Active] [-Passive] [<CommonParameters>]
DESCRIPTION
Returns any JS7 standalone Controller instance or JS7 Controller Cluster members that are connected to JOC Cockpit.
The following REST Web Service API resources are used:
* /controller
* /controllers/p
PARAMETERS
Id
-Id <String>
Specifies the ID of a JS7 Controller that was specified during installation of the product.
If an ID is not specified then the first JS7 Controller registered with JOC Cockpit will be used.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Active
-Active <SwitchParameter>
This switch specifies that only the active instance of a JS7 Controller cluster should be returned.
Without use of this switch active and passive Controller instances of a cluster are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Passive
-Passive <SwitchParameter>
This switch specifies that only the passive instance of a JS7 Controller cluster should be returned.
Without use of this switch active and passive Controller instances of a cluster are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $controllers = Get-JS7ControllerInstance
Returns the Controller standalone instance or all members of a JS7 cluster.
-------------------------- EXAMPLE 2 --------------------------
PS > $controllers = Get-JS7ControllerInstance -Id some-controller-id
Returns the Controller standalone instance or all members of a JS7 Controller cluster with the specified Controller ID.
-------------------------- EXAMPLE 3 --------------------------
PS > $activeController = Get-JS7ControllerInstance -Id some-controller-id -Active
Returns the Controller standalone instance or the active member of a JS7 cluster with the specified Controller ID.
-------------------------- EXAMPLE 4 --------------------------
PS > $activeController = Get-JS7ControllerInstance -Active
Return the Controller standalone instance or the active member of a JS7 cluster.
-------------------------- EXAMPLE 5 --------------------------
PS > $passiveController = Get-JS7ControllerInstance -Passive
Return the Controller standalone instance or the passive member of a JS7 cluster.
Overview
Content Tools