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-and-number-of-currently-running-custom-event-jobs,
  "que":number-of-currently-queued-jobs,
  "linkAgents":["related-execution-agents-and-their-priority-levels"],
  "description":"comment"
  "jobExecutionStatuses":[{
   "jobClass":"type-of-job-managed-by-execution-agents",
   "serviceName":"scheduler-service-name",
   "unitName":"unit-full-path-name",
   "execID":"execution-ID",
   "errorMessage":"cause-of-inability-to-acquire-the-execution-agent-execution-status"
  },...]
}

Member

The following table lists and describes the members to be returned.

Table 7‒51: 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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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). Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents.
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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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 and the number of custom event jobs that are currently running. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents. 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 is not returned. 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. Note that this item is not returned in the case of acquiring a list of the execution statuses of execution agents.
jobExecutionStatuses	object[]	The returned information varies according to the API operation as follows: In the case of acquiring a list of the execution statuses of execution agents The execution statuses of execution agents are returned as an object array. If no data is acquired, an array having no elements is returned. In cases other than the above This item is not returned.
jobClass	string	One of the character string constants defined for the ExecAgentJobClass constant is returned as the type of jobs managed by execution agents. If information cannot be acquired, NONE (not applicable) is returned. For details about the ExecAgentJobClass constant, see 7.4.14(3) ExecAgentJobClass.
serviceName	string	A character string that is 1 to 30 bytes long is returned as the scheduler service name. If information cannot be acquired, a character string of 0 bytes is returned.
unitName	string	Returns the full name of the unit, by using a character string in the range from 1 to 930 bytes. If information cannot be acquired, a character string of 0 bytes is returned.
execID	string	The execution ID is returned in the @[`mmmm`]{A to Z}`nnnn` format (example: @10A200). If information cannot be acquired, a character string of 0 bytes is returned.
errorMessage	string	If the execution statuses of execution agents cannot be acquired, the cause of inability to acquire them is returned. If information cannot be acquired, a character string of 0 bytes is returned.

To Page Top