7.3.8 Execution agent status object
This object indicates the status of an execution agent or execution agent group.
- Format
{ "execAgent":"execution-agent-name-or-execution-agent-group-name", "execHost":"execution-host-name", "status":"job-transfer-restriction-status", "comStatus":"execution-agent-status", "conExe":maximum-number-of-concurrently-executable-jobs, "job":number-of-currently-running-jobs, "event":number-of-currently-running-event-jobs, "que":number-of-currently-queued-jobs, "linkAgents":["related-execution-agents-and-their-priority-levels"], "description":"comment" }
- Member
-
The following table lists and describes the members to be returned.
Table 7‒49: List of members of the Execution agent status object Member
Data type
Description
execAgent
string
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the name of the execution agent by using a character string in the range from 1 to 255 bytes.
-
If the value of mode is agentGroup (execution agent group)
This item returns the name of the execution agent group by using a character string in the range from 1 to 255 bytes.
execHost
string
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the name of the job execution host by using a character string in the range from 1 to 255 bytes.
-
If the value of mode is agentGroup (execution agent group)
This item is not returned.
status
string
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the job transfer restriction status of the execution agent by using a character string constant that is supported by the ExecAgentStatus constant.
-
If the value of mode is agentGroup (execution agent group)
This item returns the job transfer restriction status of the execution agent group by using a character string constant that is supported by the ExecAgentStatus constant.
For details about the ExecAgentStatus constant, see 7.4.14(1) ExecAgentStatus.
comStatus
string
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the status of the execution agent by using a character string constant that is supported by the ComStatus constant. Note, however, that if the job distribution delay reduction function is disabled, this item returns the string NONE (not applicable).
-
If the value of mode is agentGroup (execution agent group)
This item is not returned.
For details about the ComStatus constant, see 7.4.14(2) ComStatus.
conExe
long
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the maximum number of concurrently executable jobs by using a numeric value in the range from 0 to 4294967295.
-
If the value of mode is agentGroup (execution agent group)
This item is not returned.
que
long
Returns 0 or a greater value as the number of Unix jobs, PC jobs, action jobs, custom jobs, and passing-information setting jobs that are currently queued.
job
long
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns 0 or a greater value as the number of Unix jobs, PC jobs, action jobs, custom jobs, and passing-information setting jobs that are currently running.
-
If the value of mode is agentGroup (execution agent group)
This item is not returned.
event
long
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns 0 or a greater value as the number of event jobs that are currently running.
-
If the value of mode is agentGroup (execution agent group)
This item is not returned.
linkAgents
string[]
Returns information based on the mode parameter specified in query as follows:
-
If the value of mode is agent (execution agent)
This item returns the string null.
-
If the value of mode is agentGroup (execution agent group)
This item returns an array that contains the related execution agents and their priority levels. The related execution agents and their priority levels are returned in the following format:
execution-agent-name:priority-level
The value of execution-agent-name is a character string in the range from 1 to 255 bytes.
The value of priority-level is a numeric value in the range from 1 to 16.
If there are no related execution agents, this item returns a zero-element array.
description
string
Returns a description by using a character string of no more than 80 bytes.
-