Versions Compared

Key

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

...

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

...

OAuth Client Details

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


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

...

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

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

Authorization server provider. 

Options: 

  • Azure AD
  • Google
  • Other


Note

Selecting Azure AD or Google will automatically populate the Authorization Endpoint and Token Endpoint fields.

The URL that the user will be redirected to after authorizing the Universal Controller application. Redirect URLs are specified as
'{Universal Controller Base URL}/oauth2/callback'.

For example, 'https://example.stone.branch/uc/oauth2/callback'. The Universal Controller will extract the authorization code from the request and exchange it for an access token.

The redirect URLs need to match the ones used when registering the Universal Controller application with the authorization server.
Specify a redirect URL for every cluster node that you need to authorize the Universal Controller application from.

Authorization EndpointAuthorization endpoint for the authorization server. This is used by Universal Controller to obtain a temporary authorization code.

Token Endpoint

Token endpoint for the authorization server. This is used by Universal Controller to exchange the temporary authorization code for an access token. It is also used by Universal Controller to refresh the access token once it expires.

Client IDClient identifier. This is issued by the authorization server when registering the Universal Controller application.
Client SecretClient secret. This is issued by the authorization server when registering the Universal Controller application.

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 OAuth Client Details that let you perform various actions.

Save

Saves a new record in the Controller database.

Save & New

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

Save & View

Saves a new OMS Server OAuth Client 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 ServerOAuth Client.

Resume

Resumes the connection of a Suspended OMS ServerOAuth Client.

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 OAuth Client Details that provide access to additional information about the OMS ServerOAuth Client.

Agents

Lists all Agents for which this OMS Server OAuth Client is the network communication provider between the Controller.

Notifications

Lists all notifications that have been defined for this OMS Server.

...

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

...

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.

...

Image Removed

...

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

...

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.

...

Image Removed

...

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.0UC69:SNMP Manager field - 6.4.2.0

Notification Severity

Include Page
UC69:Notification severityUC69: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 buttonUC69: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 buttonUC69:Update button

Delete

Include Page
UC69:Delete buttonUC69:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

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