Agent Web Services
Overview
Universal Controller supports the following RESTful-based web services for Agent operations, which are listed alphabetically on this page.
- Delete an Agent
- List Agents
- List Agents - Advanced
- Modify an Agent
- Read an Agent
- Resume an Agent
- Set an Agent Task Execution Limit
- Suspend an Agent
Formatting specifications for each web service, including details about property requirements, are provided.
Delete an Agent
Description | |
---|---|
URI | http://host_name/uc/resources/agent |
HTTP Method | DELETE |
Description | Deletes an Agent. |
URI Parameters | See Delete an Agent: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Example Response |
|
Delete an Agent: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Agent, created during installation. | Y |
| |
| Name used within the Controller to identify this agent. | Maximum 40 alphanumerics. | Y |
|
List Agents
Description | |
---|---|
URI | http://host_name/uc/resources/agent/list |
HTTP Method | GET |
Description | Retrieves information on all agents. |
Example URI | http://localhost:8080/uc/resources/agent/list |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | |
Properties |
List Agents: XML and JSON Examples
The following XML and JSON examples are for the List Agents web service.
XML | JSON |
---|---|
List Agents: Properties
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. |
| Host Name | IP address or domain/name of the host machine where the Agent resides. |
| 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 This also applies to the ipAddress of z/OS secondary Agents. |
| Agent Name | Name used within the Controller to identify this Agent. |
| Retrieve Output Prohibited | Specification (true or false) for whether or not Retrieve Output requests are disallowed from being performed for this Agent. |
| Agent Id | Unique ID for this Agent. |
| Status | Status of the Agent. |
| Suspended | Indication (true or false) of whether or not the Agent currently is suspended. |
| n/a | System ID field in the database for this Agent record. |
| Transient | For Linux Unix Agents only; Specification (true or false) for whether or not the Agent is considered a Transient Agent. |
| Operating System | Operating system on which the Agent is running. |
| Version | Version number of the Agent program. |
List Agents - Advanced
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves Agent details using specific query parameters. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
URI Parameters | |
Example Response |
List Agents - Advanced: URI Parameters
Name | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Type of Agent | Valid values (case insensitive):
| N |
| n/a | Name used within the Controller to identify this Agent. | Wildcards are supported. | N |
businessServices | n/a | Business Services that this Agent belongs to. | String value of comma-separated business services. | N |
List Agents - Advanced: XML and JSON Examples
The following XML and JSON examples are for the List Agents - Advanced web service.
XML | JSON |
---|---|
Modify an Agent
Description | |
---|---|
URI | http://host_name/uc/resources/agent |
HTTP Method | PUT |
Description | Modifies the Agent specified by the |
Example URI | http://localhost:8080/uc/resources/agent |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Agent Properties | See Agent: Properties. |
Email Notification Properties | |
SNMP Notification Properties | |
Example Response |
|
Read an Agent
Description | |
---|---|
URI | http://host_name/uc/resources/agent |
HTTP Method | GET |
Description | Retrieves information on a specific Agent. |
URI Parameters | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI | http://localhost:8080/uc/resources/agent?agentid=SS0001 |
Example Response | |
Agent Properties | See Agent: Properties. |
Email Notification Properties | |
SNMP Notification Properties |
Read an Agent: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Agent. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Agent. | String; URI parameter. | Y (unless |
|
Agent: XML and JSON Examples
XML | JSON |
---|---|