Introduction

OMS (Universal Message Service) Servers are the network communication providers between Universal Controller and Universal Agent.

Creating OMS Server Records

You must create a record for each OMS Server and OMS HA cluster (two or more OMS Servers in an HA / High Availability environment) that will be used as the network communications provider between the Controller and Agents.

Do not create individual records for each member (OMS Server) of an OMS HA cluster. You must define an OMS HA cluster as a single record, with the OMS Server Address containing a comma-separated list of each OMS Server in the cluster.

Step 1	From the Agents & Connections navigation pane, select System > OMS Servers. The OMS Servers list displays. To the right of the list, OMS Server Details for a new OMS Server record displays.
Step 2	Enter / select Details for a new OMS Server, using the field descriptions below as a guide. Required fields display an asterisk ( * ) after the field name. Default values for fields, if available, display automatically. Use the scroll bar. Temporarily hide the list above the Details. Click the button above the list to display a pop-up version of the Details.
Step 3	Click a button. The OMS Server record is added to the database, and all buttons and tabs in the OMS Server Details are enabled.

Note

To open an existing record on the list, either:

Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

OMS Server Details

The following OMS Server Details is for an existing OMS Server. See the field descriptions, below, for a description of all fields that display in the OMS Server Details.

For information on how to access additional details - such as Metadata and complete database Details - for OMS Servers (or any type of record), see Records.

OMS Server Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the OMS Server Details.

Field Name	Description
Details	This section contains detailed information about the OMS Server.
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. Note The OMS Server Address supports SNI, using the structure `<host>:<port>:<sni>`, where both `port` and `sni` are optional. See OMS_SERVERS - UAG configuration option for more details.
Network Timeout (Seconds)	Network socket time-out value used for TCP/IP receive and connect operations.
Description	Description of this record. Maximum length is 255 characters.
Member of Business Services	User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.
Authenticate OMS Server	If enabled, the Controller authenticates the OMS server digital certificate.
Status	This section contains detailed information about the status of the OMS Server. (This section does not display if you are creating a new OMS Server record.)
Status	Current status of the OMS server: Connected or Disconnected.
Session Status	Current status of the OMS server messaging sessions: heartbeat, input, and output sessions. Options: Operational - All OMS Server messaging sessions are operational. Impaired - Ability of OMS clients to produce and/or consume messages is impaired. None - OMS Server is disconnected.
Suspended	If enabled, indication that the OMS Server has been Suspended (temporarily disconnected).
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.
Last Connected Time	Time when the Universal Controller last connected to the server at the Last Connected Server Address.
Metadata	This section contains Metadata information about this record.
UUID	Universally Unique Identifier of this record.
Updated By	Name of the user that last updated this record.
Updated	Date and time that this record was last updated.
Created By	Name of the user that created this record.
Created	Date and time that this record was created.
Buttons	This section identifies the buttons displayed above and below the OMS Server Details that let you perform various actions.
Save	Saves a new record in the Controller database.
Save & New	Saves a new OMS Server record in the Controller database and redisplays empty Details so that you can create another new record.
Save & View	Saves a new OMS Server record in the Controller database and continues to display that record.
New	Displays empty (except for default values) Details for creating a new record.
Update	Saves updates to the record.
Suspend	Temporarily disconnects the OMS Server.
Resume	Resumes the connection of a Suspended OMS Server.
Delete	Deletes the current record.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this record.
Tabs	This section identifies the tabs across the top of the OMS Server Details that provide access to additional information about the OMS Server.
Agents	Lists all Agents for which this OMS Server is the network communication provider between the Controller.
Notifications	Lists all notifications that have been defined for this OMS Server.

Starting and Stopping OMS

For instructions on starting and stopping OMS Servers, see Starting and Stopping Agent Components.

Sending Notifications on Status of an OMS Server

You can configure OMS Servers to send a notification via email or SNMP if that OMS Server status changes from Connected to Disconnected or Disconnected to Connected.

Step 1	From the Agents and Connections navigation pane, select System > OMS Servers. The OMS Servers list displays.
Step 2	Open the record of an OMS Server on the list.
Step 3	Click the Notifications tab to display a list of any Email and SNMP notifications configured for the OMS Server.
Step 4	Select the type of notification you want the OMS Server to send, and then click New. Notification Details for a new Notification displays (See Email Notification Details and SNMP Notification Details, below.
Step 5	Complete the fields as needed (see Email Notification Details Field Descriptions and SNMP Notification Details Field Descriptions, below). Note OMS Server built-in variables are available to pass data about the OMS Server into the notification. (User-defined variables, including Global variables, are not available for use in OMS Server email notifications.)
Step 6	Click the Save button to save the record.

Email Notification Details

Email Notification Details Field Descriptions

The following table describes the fields and buttons on Email Notification Details.

Field Name	Description
Criteria	This section contains criteria for sending the notification.
Status Options	Disconnected = Trigger the notification when the OMS Server is connected. Connected = Trigger the notification when the OMS Server is connected Note If you select Disconnected, and the OMS Server status is Connected but the session status becomes Impaired, the notification will qualify and be sent. If you select Connected, and the OMS Server recovers from an Impaired session status, the notification will qualify and be sent.
Details	This section contains assorted detailed information about the notification.
Email Template	Name of an Email template defined in an Email Template Details. An Email template allows you to specify standard recipients and text for outgoing emails. Enter the name of an existing Email template, select an Email template from the drop-down list, or click the Details icon to create a new Email template. Every Email template specifies an Email connection. If you do not specify an Email template in this field, you must specify an Email connection in the Email Connection field. If you specify both an Email template (in this field) and an Email Connection, the Email server specified in the Email Connection field overrides the Email server specified in this field. (Any information specified in an Email task overrides what is specified in an Email template.)
Email Connection	Required if an Email Template is not specified in the Email Template field; Name of an outgoing Email Connection (Type = Outgoing). An Email Connection specifies information about an outgoing or incoming email server. Enter the name of an existing outgoing Email Connection, select an existing outgoing Email Connection from the drop-down list, or clear the Email Connection field and click the Details icon to create a new Email Connection (Outgoing will be pre-selected in the Type field). If you specify both an Email Template and an Email Connection (in this field), the Email Connection specified in this field overrides the Email Connection specified in the Email Template field.
Reply-To	Email address of the sender. Use commas to separate multiple recipients. Variables and functions supported.
To	Email address of the recipient. Use commas to separate multiple recipients. Variables and functions supported.
CC	Email address of the party being sent a copy of the email, if any. Use commas to separate multiple recipients. Variables and functions supported.
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 supported.
Subject	Subject line of the email. Variables and functions supported.
Body	Text of the email message. Variables and functions supported. Note If both the Email Template and the Email Task (or Email Notification) contain text in the Body, the text in the Email Template is appended to the text in the Email Task (or Email Notification).
Buttons	This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
Save	Submits the new record to the database.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Update	Saves updates to the record.
Delete	Deletes the current record.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this notification.

SNMP Notification Details

SNMP Notification Details Field Descriptions

The following table describes the fields and buttons on SNMP Notification Details.

Field Name	Description
Criteria	This section contains criteria for sending the notification.
Status Options	Disconnected = Trigger the notification when the OMS Server is connected. Connected = Trigger the notification when the OMS Server is connected. Note If you select Disconnected, and the OMS Server status is Connected but the session status becomes Impaired, the notification will qualify and be sent. If you select Connected, and the OMS Server recovers from an Impaired session status, the notification will qualify and be sent.
Details	This section contains assorted detailed information about the notification.
SNMP Manager	The SNMP Manager that will receive the SNMP notification. Enter the name of an existing SNMP Manager, select an existing SNMP Manager from the drop-down list, or clear the SNMP Manager field and click the Details icon to create a new SNMP Manager.
Notification Severity	Severity of this notification. Options: Normal (1) Warning (2) Minor (3) Major (4) Critical (5)
Buttons	This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
Save	Submits the new record to the database.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Update	Saves updates to the record.
Delete	Deletes the current record.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this notification.

Browser not supported