Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Get-JS7SubagentCluster

SYNOPSIS

Returns a number of Subagent Cluster Clusters from the JOC Cockpit inventory

SYNTAX

Get-JS7SubagentCluster [[-AgentId] <String[]>] [[-SubagentClusterId] <String[]>] [[-ControllerId] <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet returns a number of Subagent Cluster Clusters from the JOC Cockpit inventory.

The following REST Web Service API resources are used:

* /agents/cluster/

...

-AgentId <String[]>
Specifies the unique identifier of the Cluster Agent.

Required?truefalse
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-SubagentClusterId <String[]>
Specifies Optionally specifies a unique identifier for the Subagent Cluster. This identifier cannot be modified during the lifetime of a 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?truefalse
Position?23
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

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

PS > Get-JS7SubagentCluster -AgentId 'agent_001'

Returns the Subagent Clusters configured for the indicated Agent Cluster.

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

...