You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Name

Get-JS7ControllerInstance

SYNOPSIS

Returns Controller information from the JOC Cockpit.

SYNTAX

Get-JS7ControllerInstance [[-Id] <String>] [-Active] [-Passive] [<CommonParameters>]

DESCRIPTION

Returns any JobScheduler Controller Cluster members - including standalone instances - that are connected to JOC Cockpit.

PARAMETERS

Id

-Id <String>
Specifies the ID of a JobScheduler Controller that was used during installation of the product.
If no ID is specified then the first JobScheduler 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 JobScheduler Controller cluster should be returned.

Without use of this switch active and passive Controller instances in a cluster are returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Passive

-Passive <SwitchParameter>
This switch specifies that only the passive instance of a JobScheduler Controller cluster should be returned.

Without use of this switch active and passive Controller instances in a cluster are returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $controllers = Get-JS7ControllerInstance

Returns the Controller standalone instance or all members in a JS7 cluster.

-------------------------- EXAMPLE 2 --------------------------

PS > $controllers = Get-JS7ControllerInstance -Id some-controllerId

Returns the Controller standalone instance or all members of a JS7 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.

  • No labels