Name
Get-JS7SubagentCluster
SYNOPSIS
Returns a Subagent Cluster from the JOC Cockpit inventory
SYNTAX
Get-JS7SubagentCluster [-AgentId] <String[]> [-SubagentClusterId] <String[]> [<CommonParameters>]
DESCRIPTION
This cmdlet returns a Subagent Cluster 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? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
SubagentClusterId
-SubagentClusterId <String[]>
Specifies a unique identifier for the Subagent Cluster. This identifier cannot be modified during the lifetime of a Subagent Cluster.
Required? | true |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001'
Returns a Subagent Cluster.