Overview

Universal Controller supports the following RESTful-based web services for OMS Server operations, which are listed alphabetically on this page.

Create an OMS Server
Delete an OMS Server
List OMS Servers
Modify an OMS Server
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	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.

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	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.

Delete an OMS Server: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`serverid`	ID used within the Controller to identify this OMS Server.	String; URI parameter.	Y (unless `serveraddress` is specified)	`serveraddress`
`serveraddress`	IP address or host name of this OMS Server.	String; URI parameter.	Y (unless `serverid` is specified)	`serverid`

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

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 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.

Read an OMS Server

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

Read an OMS Server: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`serverid`	ID used within the Controller to identify this OMS Server.	String; URI parameter.	Y (unless `serveraddress` is specified)	`serveraddress`
`serveraddress`	IP address or host name of this OMS Server.	String; URI parameter.	Y (unless `serverid` is specified)	`serverid`

OMS Server: XML and JSON Examples

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

XML

JSON

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>

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

OMS Server: Properties

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. Note In XML, `excludeRelated` is specified as an attribute in the <omsServer> element.	Valid values: true/false (default is false).	N
`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. Format: XML <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> JSON "opswiseGroups": ["test"]		N
`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 In XML web services, `retainSysIds` is specified as an attribute in the <omsServer> element.	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: None Impaired Operational	n/a
`status`	Status	Current status of the OMS server.	Read-only. Valid values: Disconnected Connected	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

OMS Server: Email Notification Properties

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 `emailTemplate` contains text in the body, this text is appended.	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 `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.	Y (unless `emailTemplate` is specified)
`emailTemplate`	Email Template	Name of an Email Template.	If you specify both an `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.	Y (unless `emailConnection` is specified)
`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: As String = Disconnected, As Value = 0 As String = Connected, As Value = 1	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

OMS Server: SNMP Notification Properties

Property	UI Field Name	Description	Specifications	Required
`severity`	Notification Severity	Severity level of this notification.	Valid values: As String = Normal, As Value = 1 As String = Warning, As Value = 2 As String = Minor, As Value = 3 As String = Major, As Value = 4 As String = Critical, As Value = 5 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: As String = Disconnected, As Value = 0 As String = Connected, As Value = 1	N
`sysId`	n/a	sys_id used within the Controller to identify this SNMP Notification.		N

Browser not supported