Overview
Universal Controller supports the following RESTful-based web services for OMS Server operations, which are listed alphabetically on this page.
- OMS Server Web Services#OMS Server Web Services#Create an OMS Server
- OMS Server Web Services#OMS Server Web Services#Delete an OMS Server
- OMS Server Web Services#OMS Server Web Services#List OMS Servers
- OMS Server Web Services#OMS Server Web Services#Modify an OMS Server
- OMS Server Web Services#OMS Server Web Services#Read an OMS Server
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create an OMS Server
Description | |
---|---|
URI | http://host_name/uc/resources/omsserver |
HTTP Method | POST |
Description | Creates an OMS Server. |
Example URI | http://localhost:8080/uc/resources/omsserver |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Request OMS Server Properties | |
Request Email Notification Properties | |
Request SNMP Notification Properties | |
Example Response |
|
Delete an OMS Server
Description | |
---|---|
URI | http://host_name/uc/resources/omsserver |
HTTP Method | DELETE |
Description | Deletes an OMS Server. |
URI Parameters | See Delete an OMS Server: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/omsserver?serveraddress=localhost:7878 |
Example Response |
|
Delete an OMS Server: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this OMS Server. | String; URI parameter. | Y |
|
| IP address or host name of this OMS Server. | String; URI parameter. | Y |
|
List OMS Servers
Description | |
---|---|
URI | http://host_name/uc/resources/omsserver |
HTTP Method | GET |
Description | Retrieves the Server address or partial server address of all OMS servers. |
Example URI | http://localhost:8080/uc/resources/omsserver/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Response Properties |
Modify an OMS Server
Description | |
---|---|
URI | http://host_name/uc/resources/omsserver |
HTTP Method | PUT |
Description | Modifies the OMS Server specified by the |
Example URI | http://localhost:8080/uc/resources/omsserver |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | |
Request Properties | |
Example Response |
|
Read an OMS Server
URI | http://host_name/uc/resources/omsserver |
HTTP Method | GET |
Description | Retrieves information on a specific OMS Server. |
URI Parameters | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI | http://localhost:8080/uc/resources/omsserver?serveraddress=localhost:7878 |
Example Response | |
Response Properties |
Read an OMS Server: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this OMS Server. | String; URI parameter. | Y |
|
| IP address or host name of this OMS Server. | String; URI parameter. | Y |
|
OMS Server: XML and JSON Examples
The
exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML | JSON |
---|---|
Properties
OMS Server: Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Authenticate OMS Server | Specification for whether or not the Controller authenticates the OMS server digital certificate. | Boolean; Valid values: true/false. Default is false. | N |
| Description | User-defined; description of this record. | N | |
| n/a | For the Modify OMS Server web service; specification for whether or not to exclude related records from the update, even if they are provided in the request. Note In XML, | Valid values: true/false (default is false). | No |
| n/a | Universal Controller release that the record was exported from. | read only | N |
| n/a | Record table information. | read only | N |
| Last Connected Server Address | OMS Server, in a High Availability environment of multiple cluster nodes, that is connected to the Controller or was last connected to the Controller. | Read-only. | n/a |
| Last Connected Time | Time when the Universal Controller last connected to the server. | Read-only. | n/a |
| Member of Business Services | Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> "opswiseGroups": ["test"] | N | |
| n/a | Specification for whether or not the Create an OMS Server web service will persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | N |
| OMS Server Address | IP address or host name of an OMS Server, or a comma-separated list of OMS Servers configured as an OMS Server cluster. | Y | |
| Session Status | Current status of the OMS server messaging sessions: heartbeat, input, and output sessions. | Read-only. Valid values:
| n/a |
| Status | Current status of the OMS server. | Read-only. Valid values:
| n/a |
| Suspended | Indication of whether or not the OMS Server has been suspended. | Read -only. Valid values: true/false. | n/a |
| n/a | System ID field in the database for this OMS Server record. | Persisted only if retainSysIds is set to true. | N |
| Network Timeout (Seconds) | Network socket time-out value used for TCP/IP receive and connect operations. | Integer. | N |
OMS Server: Email Notification Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Bcc | Email address of the party being sent a blind (hidden) copy of the email, if any. | Use commas to separate multiple recipients. Variables and Functions are supported. | N |
| Body | Text of the email message. | Variables and Functions are supported. If the | N |
| Cc | Email address of the party being sent a copy of the email, if any. | Use commas to separate multiple recipients. Variables and Functions are supported. | N |
| Email Connection | Name of an Email Connection. | If you specify both an | Y |
| Email Template | Name of an Email Template. | If you specify both an | Y |
| Reply-To | Email address of the sender of the email. | Use commas to separate multiple recipients. Variables and Functions are supported. | N |
| Status Options | Comma-separated list of statuses | Valid values:
| N |
| Subject | Subject line of the email. | Variables and Functions are supported. | N |
| n/a | sys_id used within the Controller to identify this Email Notification. | N | |
| To | Email address of the recipient. | Use commas to separate multiple recipients Variables and Functions are supported. | N |
OMS Server: SNMP Notification Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Notification Severity | Severity level of this notification. | Valid values:
Default is Normal (1). | N |
| SNMP Manager | SNMP Manager that will receive this notification. | N | |
| Status Options | Comma-separated list of statuses | Valid values:
| N |
| n/a | sys_id used within the Controller to identify this SNMP Notification. | N |