Skip to main content

Forwarding events to WebSocket services

You can configure Lenovo XClarity Administrator to push event notifications to WebSocket services.

About this task

The WebSocket subscriptions are not stored persistently in Lenovo XClarity Administrator. When Lenovo XClarity Administrator is rebooted, the WebSocket subscribers must subscribe again.

Procedure

To push event notification to a WebSocket service, complete the following steps.

  1. From the Lenovo XClarity Administrator menu bar, click Monitoring > Event Forwarding. The Event Forwarding page is displayed.
  2. Click the Push Services tab.
  3. Click the link for the WebSocket Service in the Name column. The Change Push Notification dialog is displayed.
  4. Click the Subscriptions tab.
  5. Click the Create icon (Create icon).
  6. Enter the IP address of the destination host.
  7. Click Create.
  8. Select the new subscription, click Generate Test Event, and then verify that the events are forwarded correctly to the WebSocket service.

Results

From the Subscriptions tab on the Change Push Notification dialog, you can perform the following actions on a selected WebSocket subscription:

  • Refresh the list of WebSocket services by clicking the Refresh icon (Refresh icon).

  • Delete subscriptions by selecting the subscriptions and clicking the Delete icon (Delete icon).

  • Determine the status of the last attempted push for a specific subscription by viewing the content of the Status column. If the attempt failed, this column contains a message that describes the error.

From the Properties tab on the Change Push Notification dialog, you can perform the following actions:

  • Change the WebSocket service properties, including the connection idle time, maximum buffer size, maximum number of subscribers, and the register time-out period.

  • You can reset the WebSocket service to the default settings by clicking Restore Defaults.

  • Suspend pushing event notifications to all subscriptions for the WebSocket service by setting the State to Off.

From the Push Service tab on the Event Forwarding page, you can generate a test event for all WebSocket subscriptions by selecting the WebSocket service and clicking Generate Test Event.