Page History

...

Get-JS7AgentStatus

SYNOPSIS

Return Returns summary information for JS7 Agents assigned the current Controller.

SYNTAX

Get-JS7AgentStatus [[-AgentId] <String>] [-Coupled] [-Decoupled] [-CouplingFailed] [-Enabled] [-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 Agent release.

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

The following REST Web Service API resources are used:

* /agents

PARAMETERS

AgentId

-AgentId <String>
Optionally specifies the unique identifier of an Agent for which informaiton is retrieved.

Without this parameter any Agents assigned the current Controller are returned.

...

-Decoupled <SwitchParameter>
Specifies to return information about Agents only that are decoupled from a Controller.
Typically this indicates either an early stage before coupling occurs or an error statusstate.

...

-CouplingFailed <SwitchParameter>
Specifies to return information about Agents only that could not be successfully coupled with a Controller.
This indicates an error statusstate.

...

PS > Get-JS7AgentStatus -Agent AgentId agent_001 -Display

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

...