You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

Name

Get-JS7AgentStatus

SYNOPSIS

Return summary information for JS7 Agents assigned the current Controller.

SYNTAX

Get-JS7AgentStatus [[-AgentId] <String>] [-Coupled] [-Decoupled] [-CouplingFailed] [-Enabled] [-Compact] [-Display] [<CommonParameters>]

DESCRIPTION

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.

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.

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

Coupled

-Coupled <SwitchParameter>
Specifies to return information about Agents only that are coupled with a Controller.

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

Decoupled

-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 status.

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

CouplingFailed

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

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

Enabled

-Enabled <SwitchParameter>
Specifies to return information about enabled Agents only.

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

Compact

-Compact <SwitchParameter>
Specifies to return a smaller set of information items about Agents.

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

Display

-Display <SwitchParameter>
Optionally specifies formatted output to be displayed.

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

about_JS7

EXAMPLES

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

PS > Get-JS7AgentStatus -Display

Displays summary information about all JS7 Agents configured for the current Controller.

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

PS > Get-JS7AgentStatus -Agent agent_001 -Display

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

-------------------------- EXAMPLE 3 --------------------------

PS > $status = Get-JS7AgentStatus -Decoupled -CouplingFailed

Returns summary information about Agents that currently are not coupled with a Controller.

  • No labels