...

	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	See OMS Server: XML and JSON Examples.
Request OMS Server Properties	See OMS Server: Properties.
Request Email Notification Properties	See OMS Server: Email Notification Properties.
Request SNMP Notification Properties	See OMS Server: SNMP Notification Properties.
Example Response	Status 200 /OK Successfully created the OMS Server with sysId {sysId}. Status 400 /Bad Request Create OMS Server failed. A duplicate value has been detected. OMS Server Address must be unique.

	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	Status 200 /OK OMS Server deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `serveraddress` and `serverid` at the same time. Status 404 /Not Found OMS Server with {server address/id} "localhost:7878" does not exist.

...

	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	See OMS Server: XML and JSON Examples.
Response Properties	See OMS Server: Properties.

Anchor
Modify an OMS Server
Modify an OMS Server
Modify an OMS Server

	Description
URI	http://host_name/uc/resources/omsserver
HTTP Method	PUT
Description	Modifies the OMS Server specified by the `sysId`. To modify OMS Server properties without modifying related records, see the 17629194 excludeRelated property.
Example URI	http://localhost:8080/uc/resources/omsserver
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See OMS Server: XML and JSON Examples.
Request Properties	See OMS Server: Properties.
Example Response	Status 200 /OK Successfully updated the OMS Server with sysId {sysId}. Status 400 /Bad Request Update OMS Server failed. A duplicate value has been detected. OMS Server Address must be unique.

...

URI

http://host_name/uc/resources/omsserver

HTTP Method

GET

Description

Retrieves information on a specific OMS Server.

URI Parameters

See Read an 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

Anchor

	Example Response
	Example Response

Example Response

See OMS Server: XML and JSON Examples.

Response Properties

See OMS Server: Properties.

Anchor
Read an OMS Server URI Parameters
Read an OMS Server URI Parameters
Read an OMS Server: URI Parameters

...

Anchor
OMS Server XML and JSON Examples
OMS Server XML and JSON Examples
OMS Server: XML and JSON Examples

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

...

XML

JSON

Expand

title	XML

<omsServer exportReleaseLevel="7.2.0.0" exportTable="ops_oms_server" version="1">
    <authenticate>false</authenticate>
    <description>Server A</description>
    <lastConnected>localhost/127.0.0.1:7878</lastConnected>
	<lastConnectedTime>localhost/127.0.0.1:7878</lastConnectedTime>
	<notifications>
		<emailNotification>
			<status>Disconnected</status>
			<sysId>735cc6806d1347e5a073036ee5397097</sysId>
			<bcc />
			<body>test</body>
			<cc />
			<emailConnection>uc - Test Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<status>Disconnected</status>
			<sysId>c17b45b2bdd84b3aa9437c60baf60647</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
	</notifications>
    <opswiseGroups> 
        <opswiseGroup>group A</opswiseGroup> 
        <opswiseGroup>group B</opswiseGroup> 
        <opswiseGroup>group C</opswiseGroup>
    </opswiseGroups>
	<serverAddress>localhost:7878</serverAddress>
	<sessionStatus>None</sessionStatus>
	<status>Disconnected</status>
        <suspended>true</suspended>
	<sysId>1307d3159099415c9bd36158b812ed54</sysId>
	<timeout>30</timeout>
</omsServer>

Expand

title	JSON

{
  "authenticate": false,
  "description": "Server A",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_oms_server",
  "lastConnected": "localhost/127.0.0.1:7878",
  "lastConnectedTime": "2020-06-03 11:00:11 -0400",
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "test",
      "cc": null,
      "emailConnection": "uc - Test Account ",
      "emailTemplate": "uc - Template",
      "replyTo": null,
      "status": "Disconnected",
      "subject": null,
      "sysId": "3104c0f2e5fd4e8c9e54ab5f653cfe2e",
      "to": null
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "SNMP Manager",
      "status": "Disconnected",
      "sysId": "bc2898e0c1b94594ac7912a34df33216"
    } ]
  },
  "opswiseGroups": [
    "A",
    "B",
    "C"
  ],  
  "retainSysIds": true,
  "serverAddress": "localhost:7878",
  "sessionStatus": "Operational",
  "status": "Connected",
  "suspended": false,
  "sysId": "0f28a0cadaa64e2a8710c417bb895055",
  "timeout": 60
}

Properties

Anchor
OMS Server Properties
OMS Server Properties
OMS Server: Properties

Property

UI Field Name

Description

Specifications

Required

Anchor

	authenticate - oms
	authenticate - oms

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

Anchor

	description - oms
	description - oms

description

Description

User-defined; description of this record.

N

Anchor

	excludeRelated - oms
	excludeRelated - oms

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.

Note

title	Note

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

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

No

Anchor

	exportReleaseLevel - oms
	exportReleaseLevel - oms

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - oms
	exportTable - oms

exportTable

n/a

Record table information.

read only

N

Anchor

	lastConnected - oms
	lastConnected - oms

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

Anchor

	lastConnectedTime - oms
	lastConnectedTime - oms

lastConnectedTime

Last Connected Time

Time when the Universal Controller last connected to the server.

Read-only.

n/a

Anchor

	opswiseGroups - oms
	opswiseGroups - oms

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

Format:

XML

Panel
<opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups>

JSON

Panel
"opswiseGroups": ["test"]

N

Anchor

	retainSysIds - oma
	retainSysIds - oma

retainSysIds

n/a

Specification for whether or not the Create an OMS Server web service will persist the sysId property.

If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <omsServer> element.

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

N

Anchor

	serverAddress - oms
	serverAddress - oms

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

Anchor

	sessionStatus - oms
	sessionStatus - oms

sessionStatus

Session Status

Current status of the OMS server messaging sessions: heartbeat, input, and output sessions.

Read-only. Valid values:

None
Impaired
Operational

n/a

Anchor

	status - oms
	status - oms

status

Status

Current status of the OMS server.

Read-only. Valid values:

Disconnected
Connected

n/a

Anchor

	suspended - oms
	suspended - oms

suspended

Suspended

Indication of whether or not the OMS Server has been suspended.

Read -only. Valid values: true/false.

n/a

Anchor

	sysId - oms
	sysId - oms

sysId

n/a

System ID field in the database for this OMS Server record.

Persisted only if retainSysIds is set to true.

N

Anchor

	timeout - oms
	timeout - oms

timeout

Network Timeout (Seconds)

Network socket time-out value used for TCP/IP receive and connect operations.

Integer.

N

...

Versions Compared

Old Version 4

New Version Current

Key

Anchor
Modify an OMS Server
Modify an OMS Server
Modify an OMS Server

Anchor
Read an OMS Server URI Parameters
Read an OMS Server URI Parameters
Read an OMS Server: URI Parameters

Anchor
OMS Server XML and JSON Examples
OMS Server XML and JSON Examples
OMS Server: XML and JSON Examples

Properties

Anchor
OMS Server Properties
OMS Server Properties
OMS Server: Properties

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

AnchorModify an OMS ServerModify an OMS ServerModify an OMS Server

AnchorRead an OMS Server URI ParametersRead an OMS Server URI ParametersRead an OMS Server: URI Parameters

AnchorOMS Server XML and JSON ExamplesOMS Server XML and JSON ExamplesOMS Server: XML and JSON Examples

Properties

AnchorOMS Server PropertiesOMS Server Properties OMS Server: Properties

Anchor
Modify an OMS Server
Modify an OMS Server
Modify an OMS Server

Anchor
Read an OMS Server URI Parameters
Read an OMS Server URI Parameters
Read an OMS Server: URI Parameters

Anchor
OMS Server XML and JSON Examples
OMS Server XML and JSON Examples
OMS Server: XML and JSON Examples

Anchor
OMS Server Properties
OMS Server Properties
OMS Server: Properties