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.


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.

Network Timeout (Seconds)

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

Description

Member of Business Services

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

Suspend

Temporarily disconnects the OMS Server.

Resume

Resumes the connection of a Suspended OMS Server.

Delete

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

OMS 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
  • 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

Email Connection

Reply-To

To

CC

BCC

Subject

Body

Buttons

This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.

Save

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Update

Delete

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

Notification Severity

Buttons

This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.

Save

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Update

Delete

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this notification.