...
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 |
|
...
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 |
|
...
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 |
Anchor | ||||
---|---|---|---|---|
|
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 |
|
...
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 | ||||||
| |||||||
Response Properties |
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
...
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Properties
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
authenticate | 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 | Description | User-defined; description of this record. | N | ||||||||||||
excludeRelated | 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.
| Valid values: true/false (default is false). | No | |||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
lastConnected | 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 | |||||||||||
lastConnectedTime | Last Connected Time | Time when the Universal Controller last connected to the server. | Read-only. | n/a | |||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to.
| N | ||||||||||||
retainSysIds | n/a | Specification for whether or not the Create an OMS Server web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||
serverAddress | 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 | ||||||||||||
sessionStatus | Session Status | Current status of the OMS server messaging sessions: heartbeat, input, and output sessions. | Read-only. Valid values:
| n/a | |||||||||||
status | Status | Current status of the OMS server. | Read-only. Valid values:
| n/a | |||||||||||
suspended | Suspended | Indication of whether or not the OMS Server has been suspended. | Read -only. Valid values: true/false. | n/a | |||||||||||
sysId | n/a | System ID field in the database for this OMS Server record. | Persisted only if retainSysIds is set to true. | N | |||||||||||
timeout | Network Timeout (Seconds) | Network socket time-out value used for TCP/IP receive and connect operations. | Integer. | N |
...