7.3.7 Execution agent definition information object
This object indicates the definition information 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", "conExe":["maximum-number-of-concurrently-executable-jobs-by-time-period",...], "linkAgents":["related-execution-agents-and-their-priorities"], "description":"comment" }- Member
-
The following table lists and describes the members to be returned.
Table 7‒48: List of members of the Execution agent definition information 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.
conExe
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 an array that contains the maximum number of concurrently executable jobs for each time period. The maximum number of concurrently executable jobs for each time period is returned in the following format:
time-period=maximum-number-of-concurrently-executable-jobs
The value of time-period is in hh:mm-hh:mm format.
The value of hh is a numeric value in the range from 0 to 23 (unit: hour). The value of mm is 0 or 30 (unit: minute).
The value of maximum-number-of-concurrently-executable-jobs is a numeric value in the range from 0 to 4294967295.
-
If the value of mode is agentGroup (execution agent group), this item returns the string null.
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.
-