system.eam.queryAgentStatus

Description

Returns the current state of the matching agents.

Syntax

system.eam.queryAgentStatus(groupIds, agentIds, isConnected)

Parameters

List groupIds - A list of groups to restrict the results to. If not specified, all groups will be included.

List agentIds - A list of agent ids to restrict the results to. If not specified, all agents will be allowed.

Boolean isConnected - If T rue, only returns agents that are currently connected. If False, only agents that are considered down will be returned, and if not specified, all agents will be returned.

Returns

Dataset - A list of AgentStatus objects.

Scope

All

Examples

Code Snippet

results=system.eam.queryAgentStatus()
for row in range(results.rowCount):
	agentName=results.getValueAt(row, "AgentName")
	nodeRole=results.getValueAt(row, "NodeRole")
	agentGroup=results.getValueAt(row, "AgentGroup")
	lastComm=results.getValueAt(row, "LastCommunication")
	isConnected=results.getValueAt(row, "IsConnected")
	isRunning=results.getValueAt(row, "IsRunning")
	runningState=results.getValueAt(row, "RunningState")
	runningStateInt=results.getValueAt(row, "RunningStateInt")
	licenseKey=results.getValueAt(row, "LicenseKey")
	platformVersion=results.getValueAt(row, "Version")