Page History
...
Get-JS7ControllerInstance
SYNOPSIS
Returns information about a JS7 Controller information instance from the JOC Cockpit.
SYNTAX
Get-JS7ControllerInstance [[-Id] <String>] [-Active] [-Passive] [<CommonParameters>]
DESCRIPTION
Returns any JobScheduler JS7 standalone Controller instance or JS7 Controller Cluster members - including standalone instances - 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 JobScheduler JS7 Controller that was used specified during installation of the product.
If no an ID is not specified then the first JobScheduler JS7 Controller registered with JOC Cockpit will be used.
...
-Active <SwitchParameter>
This switch specifies that only the active instance of a JobScheduler JS7 Controller cluster should be returned.
Without use of this switch active and passive Controller instances in of a cluster are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Passive <SwitchParameter>
This switch specifies that only the passive instance of a JobScheduler JS7 Controller cluster should be returned.
Without use of this switch active and passive Controller instances in of a cluster are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-------------------------- EXAMPLE 1 --------------------------
PS > $Controllers $controllers = Get-JS7ControllerInstance
Returns the Controller standalone instance or all members in of a JS7 cluster.
-------------------------- EXAMPLE 2 --------------------------
PS > $Controllers $controllers = Get-JS7ControllerInstance -Id some-controller-controllerIdid
Returns the Controller standalone instance or all members of a JS7 Controller cluster with the specified Controller ID.
...
PS > $activeController = Get-JobSchedulerControllerInstance JS7ControllerInstance -Id some-controller-id -Active
Returns the Controller standalone instance or all members the active member of a JS7 cluster with the specified Controller ID.
-------------------------- EXAMPLE 4 --------------------------
PS > $Controllers $activeController = Get-JS7ControllerInstance -Active
...
-------------------------- EXAMPLE 5 --------------------------
PS > $Controllers $passiveController = Get-JS7ControllerInstance -Passive
...
Overview
Content Tools