Name
Get-JS7SubagentCluster
SYNOPSIS
Returns a number of Subagent Clusters from the JOC Cockpit inventory
SYNTAX
Get-JS7SubagentCluster [[-AgentId] <String[]>] [[-SubagentClusterId] <String[]>] [[-ControllerId] <String>] [<CommonParameters>]
DESCRIPTION
This cmdlet returns a number of Subagent Clusters from the JOC Cockpit inventory.
The following REST Web Service API resources are used:
* /agents/cluster/
PARAMETERS
AgentId
-AgentId <String[]>
Specifies the unique identifier of the Cluster Agent.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SubagentClusterId
-SubagentClusterId <String[]>
Optionally specifies a unique identifier for the Subagent Cluster.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally specifies the identification of the Controller to which the order is added.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7SubagentCluster -AgentId 'agent_001'
Returns the Subagent Clusters configured for the indicated Agent Cluster.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001'
Returns a Subagent Cluster.
Overview
Content Tools