Panel | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Accept Extensions | Indication of whether or not the Agent will accept deployment of Universal Extensions. | |||||||||||
| Accept List | If
| |||||||||||
| API Level Minimum | Minimum extension API level supported. | |||||||||||
| API Level Maximum | Maximum extension API level supported. | |||||||||||
| Extensions | List of deployed Universal Extensions and their corresponding checksums. | |||||||||||
hostName | Host Name | IP address or domain/name of the host machine where the Agent resides. | |||||||||||
ipAddress | IP Address | TCP/IP address of the machine where the Agent is running. If the currently logged in user is a non-Administrator (ops_admin) user, and theĀ Agent Address Information Restricted Universal Controller system property is set to true, ipAddress will be set to <ipAddress /> (XML) and "ipAddress": null (JSON).
| |||||||||||
name | Agent Name | Name used within the Controller to identify this Agent. | |||||||||||
outputProhibited | Retrieve Output Prohibited | Specification (true or false) for whether or not Retrieve Output requests are disallowed from being performed for this Agent. | |||||||||||
queueName | Agent Id | Unique ID for this Agent. | |||||||||||
status | Status | Status of the Agent. | |||||||||||
suspended | Suspended | Indication (true or false) of whether or not the Agent currently is suspended. | |||||||||||
sysID | n/a | System ID field in the database for this Agent record. | |||||||||||
transient | Transient | For Linux Unix Agents only; Specification (true or false) for whether or not the Agent is considered a Transient Agent. | |||||||||||
type | Operating System | Operating system on which the Agent is running. | |||||||||||
version | Version | Version number of the Agent program. |
...
Property | UI Field Name | Description | Specifications | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
authVersion | Authentication Version | Type of encryption in use for this Agent. | Read only. | |||||||||||
build | Build Id | Build ID of the Agent. | Read only. | |||||||||||
buildDate | Build Date | Date that the Agent program was last built. | Read only. | |||||||||||
cpu | CPU | Information about the CPU on the Agent machine. | Read only. | |||||||||||
cpuLoad | CPU Load | Current CPU load on the Agent machine. | Read only; Integer. Expressed as a percentage. For example, 1 means 1% currently utilized. | |||||||||||
credentials | Credentials | Credentials under which this Agent runs tasks. These credentials are overridden by any credentials provided in the task definition for any tasks being run by this Agent. | ||||||||||||
| Credentials Required | Specifies if credentials are required to execute any task on the agent. | Valid Values: true/false (default is false). | |||||||||||
currentCount | Current Task Count | If | Read only. | |||||||||||
decommissioned | Decommissioned | For Linux Unix Agents only; Specification (true or false) for whether or not the Agent is decommissioned. | Valid values: true/false (default is false). | |||||||||||
decommissionedDate | Decommissioned Date | For Linux Unix Agents only; If decommissioned is true: Date when the Agent was decommissioned. | Read only. | |||||||||||
excludeRelated | n/a | For the Modify Agent web service; specification for whether or not to exclude related records from the update, even if they are provided in the request.
| Valid values: true/false (default is false). | |||||||||||
| Accept Extensions | Indication of whether or not the Agent will accept deployment of Universal Extensions. | Read only. | |||||||||||
| Accept List | If
| Read only. | |||||||||||
| API Level Minimum | Minimum extension API level supported. | Read only. | |||||||||||
| API Level Maximum | Maximum extension API level supported. | Read only. | |||||||||||
| Extensions | List of deployed Universal Extensions and their corresponding checksums. | Read only. | |||||||||||
hbDate | Last Heartbeat | Date and time that the most recent heartbeat was received from the Agent. | Read only. | |||||||||||
hbGracePeriod | Heartbeat Grace Period | Grace period, in seconds, that the Controller will allow for a delayed heartbeat message | Integer. | |||||||||||
hbIntvl | Heartbeat Interval | Heartbeat interval (in seconds). The heartbeat is a status message sent from the Agent to the Controller. | Integer. | |||||||||||
hostName | Host Name | Read only; IP address or domain/name of the host machine where the resource resides. | Read only. | |||||||||||
ipAddress | IP Address | Read only; TCP/IP address of the machine where the Agent is running. If the currently logged in user is a non-Administrator (ops_admin) user, and theĀ Agent Address Information Restricted Universal Controller system property is set to true, ipAddress will be set to <ipAddress /> (XML) and "ipAddress": null (JSON).
| Read only. | |||||||||||
jobs | Jobs Run | Read only; Total number of jobs that have been run through the Controller to this Agent. | Read only; Integer. | |||||||||||
limitAmount | Limit Amount | If | Integer. | |||||||||||
limitType | Task Execution Limit | Specification for whether a Limited or Unlimited number of task instances can be run concurrently on the Agent. | Valid values:
Default is Unlimited (1). | |||||||||||
outputProhibited | Retrieve Output Prohibited | Specification for whether or not Retrieve Output requests are disallowed from being performed for this Agent. | Read only; Boolean. Valid values: true/false. | |||||||||||
logLevel | Log Level | Level of logging that the Agent can perform | Valid values:
Default is Informational. | |||||||||||
name | Name | Name used within the Controller to identify this Agent. | ||||||||||||
omsServer | OMS Server | Host name of the OMS Server. | Read only. | |||||||||||
opswiseGroups | Member of Business Services | One or more Business Services that this Agent belongs to. | Read only. | |||||||||||
os | Operating System | Operating system on which the Agent is running. | Read only. | |||||||||||
osRelease | Operating System Release | Release information for the operating system on which the Agent is running. | Read only. | |||||||||||
pid | PID | Process ID of the Agent. | Read only. | |||||||||||
queueName | Agent ID | Unique ID for this Agent, created during installation. | Read only. | |||||||||||
secondaryAgentCount | Secondary Agent Licenses | For z/OS Agents only; Number of secondary agent licenses. | Read only; Integer | |||||||||||
secondaryAgents | Secondary Agent(s) | For z/OS Agents only; List of secondary agent information. | Read only. Format:
| |||||||||||
startDate | Started Date | Date/timestamp when the Agent was last started. | Read only. | |||||||||||
status | Status | Status of the Agent. | Read only. Valid values:
| |||||||||||
suspended | Suspended | Indication that the Agent's ability to run tasks has been suspended. | Read only; Boolean. Valid values: true/false. | |||||||||||
sysid | n/a | System ID field in the database for this Agent. | Read only. | |||||||||||
systemName | System Name | For z/OS Agents only; System name. | Read only. | |||||||||||
transient | Transient | For Linux Unix Agents only; Specification (true or false) for whether or not the Agent is considered a Transient Agent. | Valid values: true/false (default is false). | |||||||||||
version | Version | Version number of the Agent program. | Read only. |
...