JS7 JobScheduler

Space shortcuts

Page tree

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

Compare with Current View Page History

« Previous Version 14 Next »

Name

Get-JS7Agent

SYNOPSIS

Returns a Standalone Agent or Cluster Agent

SYNTAX

Get-JS7Agent [[-AgentId] <String[]>] [[-ControllerId] <String>] [[-State] <String[]>] [-NotHidden] [-Persistent] [<CommonParameters>]

DESCRIPTION

This cmdlet returns a Standalone Agent or Cluster Agent.

The following REST Web Service API resources are used:

* /agents
* /agents/inventory

PARAMETERS

AgentId

-AgentId <String[]>
Optionally specifies the unique identifier of the Standalone Agent or Cluster Agent.

More than one Agent can be specified by separating Agent IDs by a comma.

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

ControllerId

-ControllerId <String>
Optionally specifies the identification of the Controller to which the Standalone Agent or Cluster Agent is dedicated.

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

State

-State <String[]>

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

NotHidden

-NotHidden <SwitchParameter>
Optionally specifies that only visible Standalone Agents or Cluster Agents should be returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Persistent

-Persistent <SwitchParameter>
Optionally specifies that persistent inventory information only is returned.
Without this switch inventory information is returned directly from the Controller.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > $agents = Get-JS7Agent

Returns all Standalone Agents and Cluster Agents.

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

PS > $agent = Get-JS7Agent -AgentId 'agent_001'

Returns the indicated Standalone Agent or Cluster Agent.

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

PS > $agent = Get-JS7Agent -AgentId 'agent_001' -State 'COUPLED'

Returns the indicated Standalone Agent or Cluster Agent with the given state.

  • No labels