Page Comparison

Panel

Table of Contents

maxlevel	1

...

Property

UI Field Name

Description

Anchor

	extAccept - LA
	extAccept - LA

extAccept

Accept Extensions

Indication of whether or not the Agent will accept deployment of Universal Extensions.

Anchor

	extAcceptList - LA
	extAcceptList - LA

extAcceptList

Accept List

If extAccept is true; either:

List of specific Universal Extensions that are allowed to be deployed to the Agent.
* for no deployment restrictions.

Anchor

	extApiLevelMin - LA
	extApiLevelMin - LA

extApiLevelMin

API Level Minimum

Minimum extension API level supported.

Anchor

	extApiLevelMax - LA
	extApiLevelMax - LA

extApiLevelMax

API Level Maximum

Maximum extension API level supported.

Anchor

	extensions - LA
	extensions - LA

extensions

Extensions

List of deployed Universal Extensions and their corresponding checksums.

Anchor

	hostName - LA
	hostName - LA

hostName

Host Name

IP address or domain/name of the host machine where the Agent resides.

Anchor

	ipAddress- LA
	ipAddress- LA

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).

Note

title	Note

This also applies to the ipAddress of z/OS secondary Agents.

Anchor

	name - LA
	name - LA

name

Agent Name

Name used within the Controller to identify this Agent.

Anchor

	outputProhibited - LA
	outputProhibited - LA

outputProhibited

Retrieve Output Prohibited

Specification (true or false) for whether or not Retrieve Output requests are disallowed from being performed for this Agent.

Anchor

	queueName - LA
	queueName - LA

queueName

Agent Id

Unique ID for this Agent.

Anchor

	status - LA
	status - LA

status

Status

Status of the Agent.

Anchor

	suspended - LA
	suspended - LA

suspended

Suspended

Indication (true or false) of whether or not the Agent currently is suspended.

Anchor

	sysID- LA
	sysID- LA

sysID

n/a

System ID field in the database for this Agent record.

Anchor

	transient - LA
	transient - LA

transient

Transient

For Linux Unix Agents only; Specification (true or false) for whether or not the Agent is considered a Transient Agent.

Anchor

	type - LA
	type - LA

type

Operating System

Operating system on which the Agent is running.

Anchor

	version - LA
	version - LA

version

Version

Version number of the Agent program.

...

Property

UI Field Name

Description

Specifications

Anchor

	authVersion - READ
	authVersion - READ

authVersion

Authentication Version

Type of encryption in use for this Agent.

Read only.

Anchor

	build - READ
	build - READ

build

Build Id

Build ID of the Agent.

Read only.

Anchor

	buildDate - READ
	buildDate - READ

buildDate

Build Date

Date that the Agent program was last built.

Read only.

Anchor

	cpu - READ
	cpu - READ

cpu

CPU

Information about the CPU on the Agent machine.

Read only.

Anchor

	cpuLoad - READ
	cpuLoad - READ

cpuLoad

CPU Load

Current CPU load on the Agent machine.

Read only; Integer. Expressed as a percentage. For example, 1 means 1% currently utilized.

Anchor

	credentials - READ
	credentials - READ

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.

Anchor

	currentCount - READ
	currentCount - READ

currentCount

Current Task Count

If limitType is Limited; Current number of tasks currently being run by this Agent.

Read only.

Anchor

	decommissioned - READ
	decommissioned - READ

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).

Anchor

	decommissionedDate - READ
	decommissionedDate - READ

decommissionedDate

Decommissioned Date

For Linux Unix Agents only; If decommissioned is true: Date when the Agent was decommissioned.

Read only.

Anchor

	excludeRelated - READ
	excludeRelated - READ

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.

Note

title	Note

In XML, excludeRelated is specified as an attribute in the <agent> element.

Valid values: true/false (default is false).

Anchor

	extAccept - READ
	extAccept - READ

extAccept

Accept Extensions

Indication of whether or not the Agent will accept deployment of Universal Extensions.

Read only.

Anchor

	extAcceptList - READ
	extAcceptList - READ

extAcceptList

Accept List

If extAccept is true; either:

List of specific Universal Extensions that are allowed to be deployed to the Agent.
* for no deployment restrictions.

Read only.

Anchor

	extApiLevelMin - READ
	extApiLevelMin - READ

extApiLevelMin

API Level Minimum

Minimum extension API level supported.

Read only.

Anchor

	extApiLevelMax - RAED
	extApiLevelMax - RAED

extApiLevelMax

API Level Maximum

Maximum extension API level supported.

Read only.

Anchor

	extensions - READ
	extensions - READ

extensions

Extensions

List of deployed Universal Extensions and their corresponding checksums.

Read only.

Anchor

	hbDate - READ
	hbDate - READ

hbDate

Last Heartbeat

Date and time that the most recent heartbeat was received from the Agent.

Read only.

Anchor

	hbGracePeriod - READ
	hbGracePeriod - READ

hbGracePeriod

Heartbeat Grace Period

Grace period, in seconds, that the Controller will allow for a delayed heartbeat message

Integer.

Anchor

	hbIntvl - READ
	hbIntvl - READ

hbIntvl

Heartbeat Interval

Heartbeat interval (in seconds). The heartbeat is a status message sent from the Agent to the Controller.

Integer.

Anchor

	hostName - READ
	hostName - READ

hostName

Host Name

Read only; IP address or domain/name of the host machine where the resource resides.

Read only.

Anchor

	ipAddress - READ
	ipAddress - READ

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).

Note

title	Note

This also applies to the ipAddress of z/OS secondary Agents.

Read only.

Anchor

	jobs - READ
	jobs - READ

jobs

Jobs Run

Read only; Total number of jobs that have been run through the Controller to this Agent.

Read only; Integer.

Anchor

	limitAmount - READ
	limitAmount - READ

limitAmount

Limit Amount

If limitType is Limited; Number of tasks that can be running at the same time by the Agent.

Integer.

Anchor

	limitType - READ
	limitType - READ

limitType

Task Execution Limit

Specification for whether a Limited or Unlimited number of task instances can be run concurrently on the Agent.

Valid values:

As String = Unlimited, As Value = 1
As String = Limited, As Value = 2

Default is Unlimited (1).

Anchor

	outputProhibited - READ
	outputProhibited - READ

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.

Anchor

	logLevel - READ
	logLevel - READ

logLevel

Log Level

Level of logging that the Agent can perform

Valid values:

Sever Error
Errors
Warnings
Informational
Debug
Trace

Default is Informational.

Anchor

	name - READ
	name - READ

name

Name

Name used within the Controller to identify this Agent.

Anchor

	omsServer - READ
	omsServer - READ

omsServer

OMS Server

Host name of the OMS Server.

Read only.

Anchor

	opswiseGroups - READ
	opswiseGroups - READ

opswiseGroups

Member of Business Services

One or more Business Services that this Agent belongs to.

Read only.

Anchor

	os - READ
	os - READ

os

Operating System

Operating system on which the Agent is running.

Read only.

Anchor

	osRelease - READ
	osRelease - READ

osRelease

Operating System Release

Release information for the operating system on which the Agent is running.

Read only.

Anchor

	pid - READ
	pid - READ

pid

PID

Process ID of the Agent.

Read only.

Anchor

	queueName - READ
	queueName - READ

queueName

Agent ID

Unique ID for this Agent, created during installation.

Read only.

Anchor

	secondaryAgentCount - READ
	secondaryAgentCount - READ

secondaryAgentCount

Secondary Agent Licenses

For z/OS Agents only; Number of secondary agent licenses.

Read only; Integer

Anchor

	secondaryAgents - READ
	secondaryAgents - READ

secondaryAgents

Secondary Agent(s)

For z/OS Agents only; List of secondary agent information.

Read only.

Format:

<secondaryAgents>
    <secondaryAgent>
        <build>10</build>
        <buildDate>20200821154510</buildDate>
        <cpu>3900</cpu>
        <hostName>dvos200</hostName>
        <ipAddress>192.168.30.10</ipAddress>
        <mode>Active</mode>
        <os>zos</os>
        <osRelease>020200</osRelease>
        <pid>1000</pid>
        <startDate>09-04-2020 18:14:14 -07:00</startDate>
        <sysName>dvos200</sysName>
        <version>6.9.0.0</version>
    </secondaryAgent>
    <secondaryAgent>
        <build>11</build>
        <buildDate>20200821154511</buildDate>
        <cpu>3901</cpu>
        <hostName>dvos201</hostName>
        <ipAddress>192.168.30.11</ipAddress>
        <mode>Offline</mode>
        <os>zos</os>
        <osRelease>020200</osRelease>
        <pid>1001</pid>
        <startDate>09-05-2020 18:14:14 -07:00</startDate>
        <sysName>dvos201</sysName>
        <version>6.9.0.1</version>
    </secondaryAgent>
</secondaryAgents>

Anchor

	startDate- READ
	startDate- READ

startDate

Started Date

Date/timestamp when the Agent was last started.

Read only.

Anchor

	status - READ
	status - READ

status

Status

Status of the Agent.

Read only. Valid values:

Offline
Active
Passive

Anchor

	suspended - READ
	suspended - READ

suspended

Suspended

Indication that the Agent's ability to run tasks has been suspended.

Read only; Boolean. Valid values: true/false.

Anchor

	sysid - READ
	sysid - READ

sysid

n/a

System ID field in the database for this Agent.

Read only.

Anchor

	systemName - READ
	systemName - READ

systemName

System Name

For z/OS Agents only; System name.

Read only.

Anchor

	transient - READ
	transient - READ

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).

Anchor

	version - READ
	version - READ

version

Version

Version number of the Agent program.

Read only.

...

	Description
URI	http://host_name/uc/resources/agent/ops-set-agent-task-execution-limit
HTTP Method	POST
Description	Sets the task execution limit for for the specified agent.
Example URI	http://localhost:8080/uc/resources/agent/ops-set-agent-task-execution-limit
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Set an Agent Task Execution Limit: XML and JSON Examples.
Request Properties	See Set an Agent Task Execution Limit: Request Properties.
Example Response	See Set an Agent Task Execution Limit: XML and JSON Examples.

...

Versions Compared

Old Version 3

New Version Current

Key