Name
Get-JobSchedulerMasterCluster
SYNOPSIS
Returns Master Cluster information from the JOC Cockpit.
SYNTAX
Get-JobSchedulerMasterCluster [[-Id] <String>] [-Active] [-Passive] [<CommonParameters>]
DESCRIPTION
Returns any JobScheduler Master Cluster members - including standalone instances - that are connected to JOC Cockpit.
PARAMETERS
Id
-Id <String>
Specifies the ID of a JobScheduler Master that was used during installation of the product.
If no ID is specified then the first JobScheduler Master 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 Master cluster should be returned.
Without use of this switch active and passive Master instances in 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 JobScheduler Master cluster should be returned.
Without use of this switch active and passive Master instances in 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 > $masters = Get-JobSchedulerMasterCluster
Returns all Master Clusters members.
-------------------------- EXAMPLE 2 --------------------------
PS > $masters = Get-JobSchedulerMasterCluster -Id some-jobscheduler-id
Returns the Master Cluster members with the specified JobScheduler ID ("some-jobscheduler-id").
-------------------------- EXAMPLE 3 --------------------------
PS > $activeMaster = Get-JobSchedulerMasterCluster -Id some-jobscheduler-id -Active
Returns the active Master Cluster member of a cluster with the specified JobScheduler ID ("some-jobscheduler-id").