Versions Compared

Key

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

...

Get-JS7AgentStatus [[-AgentId] <String>] [[-ControllerId] <String>] [-Coupled] [-CouplingFailed] [-Reset] [-Resetting] [-Shutdown] [-Unknown] [-NotHidden] [-Compact] [-Display] [<CommonParameters>]

...

Summary information is returned for JS7 Agents that are assigned the current Controller.

* Summary information includes e.g. the start date and JS7 status of an Agent release.

This cmdlet can be used to check if an Agent is available.

The following REST Web Service API resources are used:

* /agents

...

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

Unknown

-Unknown <SwitchParameter>
Specifies to return information about Agents only for which the status is unknown.
An unknown status indicates that no connection can be established to the respective Agent.

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

NotHidden

-NotHidden <SwitchParameter>
Specifies to return information about visible Agents only.

...

PS > Get-JS7AgentStatus -AgentId 'agent_001' -Display

Returns summary information about the Agent with ID "agent_001". Formatted output is displayed.

...