...
Universal Controller supports the following RESTful-based web services for OMS Server operations, which are listed alphabetically on this page.
- OMS Server Web Services#Create Create an OMS ServerOMS Server Web Services#Delete
- Delete an OMS Server
- OMS Server Web Services#List List OMS ServersOMS
- Server Web Services#Modify Modify an OMS ServerOMS Server Web Services#Read
- Read an OMS Server
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
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 |
|
...
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. html-bobswift<ul> <li> If <b>retainSysIds</b>
| 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: Html bobswift |
| n/a | |||||||||||||
status | Status | Current status of the OMS server. | Read-only. Valid values: Html bobswift |
| 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 |
...
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
bcc | 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 | Body | Text of the email message. | Variables and Functions are supported. If the | N | ||||||
cc | 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 | ||||||
emailConnection | Email Connection | Name of an Email Connection. | If you specify both an | Y | ||||||
emailTemplate | Email Template | Name of an Email Template. | If you specify both an | Y | ||||||
replyTo | Reply-To | Email address of the sender of the email. | Use commas to separate multiple recipients. Variables and Functions are supported. | N | ||||||
status | Status Options | Comma-separated list of statuses | Valid values: html-bobswift<ul> <li>
| N | ||||||
subject | Subject | Subject line of the email. | Variables and Functions are supported. | N | ||||||
sysId | n/a | sys_id used within the Controller to identify this Email Notification. | N | |||||||
to | To | Email address of the recipient. | Use commas to separate multiple recipients Variables and Functions are supported. | N |
...
Property | UI Field Name | Description | Specifications | Required | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
severity | Notification Severity | Severity level of this notification. | Valid values: Html bobswift |
Default is Normal (1). | N | ||||||
snmpManager | SNMP Manager | SNMP Manager that will receive this notification. | N | ||||||||
status | Status Options | Comma-separated list of statuses | Valid values: html-bobswift<ul> <li>
| N | |||||||
sysId | n/a | sys_id used within the Controller to identify this SNMP Notification. | N |
...