Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents
maxlevel2

...

Creating OAuth Client Records


Step 1

From the Agents & Connections navigation pane, select System > OAuth Clients. The OAuth Client list displays.
 
Below the list, OAuth Client Details for a new OAuth Client record displays.
 
Image Modified

Step 2

Enter / select Details for a new OAuth Client, 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.
To display more of the Details fields on the screen, you can either:
  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the New button above the list to display a pop-up version of the Details.

Step 3

Click a Save button. The OAuth Client record is added to the database, and all buttons and tabs in the OAuth Client Details are enabled.

Note
titleNote

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

...

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

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

Field Name

Description

General 

This section contains detailed information about the OAuth Client.

Name

Name used within the Controller to identify this resource. Up to 40 alphanumerics. It is the responsibility of the user to develop a workable naming scheme for resources.

Description

Include Page
UC71x:Summary
UC71x:Summary

Member of Business Services

Include Page
UC70:Member of Business Services
UC70:Member of Business Services

OAuth Client Details 


Provider

Session Status

Authorization server provider. 

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.
AnchorSuspendedSuspended SuspendedIf enabled, indication that the OMS Server has been Suspended (temporarily disconnected).

 

  • Azure AD
  • Google
  • Other





Anchor
Last Connected Server Address
Last Connected Server Address
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

Include Page
UC69:Update button
UC69:Update button

Suspend

Temporarily disconnects the OMS Server.

Resume

Resumes the connection of a Suspended OMS Server.

Delete

Include Page
UC69:Delete button
UC69:Delete button

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.

Anchor
Starting and Stopping OMS
Starting and Stopping OMS
Starting and Stopping OMS

...

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
titleNote

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.

Anchor
Email Notification Details
Email Notification Details
Email Notification Details

...

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

Note
titleNote
  • 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

Include Page
UC69:Email Template field - 6.4.2
UC69:Email Template field - 6.4.2

Email Connection

Include Page
UC69:Email Connection field - Outgoing - 6.4.2
UC69:Email Connection field - Outgoing - 6.4.2

Reply-To

Include Page
UC69:Reply-to
UC69:Reply-to

To

Include Page
UC69:To-Email Task
UC69:To-Email Task

CC

Include Page
UC69:CC-Email Task
UC69:CC-Email Task

BCC

Include Page
UC69:BCC-Email Task
UC69:BCC-Email Task

Subject

Include Page
UC69:Subject-Email
UC69:Subject-Email

Body

Include Page
UC69:Body-Email
UC69:Body-Email

Buttons

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

Save

Include Page
UC69:Submit button
UC69:Submit button

Save & New

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

Update

Include Page
UC69:Update button
UC69:Update button

Delete

Include Page
UC69:Delete button
UC69:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

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

Anchor
SNMP Notification Details
SNMP Notification Details
SNMP Notification Details

...

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

Note
titleNote
  • 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

Include Page
UC69:SNMP Manager field - 6.4.2.0
UC69:SNMP Manager field - 6.4.2.0

Notification Severity

Include Page
UC69:Notification severity
UC69:Notification severity

Buttons

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

Save

Include Page
UC69:Submit button
UC69:Submit button

Save & New

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

Update

Include Page
UC69:Update button
UC69:Update button

Delete

Include Page
UC69:Delete button
UC69:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

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