Notification Service

Notifications are alerts, alarms, tasks, and events that XCO sends to subscribers by HTTPS webhook or syslog over RELP (Reliable Event Logging Protocol).

Overview

Notification service notifies the external entities about the events and alerts that occur on XCO and XCO managed devices.

Device events are derived from the syslog events that are received from the devices that are managed by XCO.

Alerts are notifications that XCO services send for unexpected conditions, such as the following:
  • Loss of switch connectivity
  • Failure to configure the fabric, tenant, or endpoint group (EPG) on the device
  • Failure to perform operations such as port up or port down, set speeds, and breakout mode
  • Firmware download failure
  • Devices exiting maintenance mode
  • Certificate expiry, expired alerts
  • Storage threshold alerts
Task notifications are based on user-driven or timer-based operations, such as the following:
  • Registering or updating a device
  • Device timer collection completed
  • Adding devices to a fabric
  • Creating, updating, or deleting a fabric
  • Creating, updating, or deleting a tenant
  • Creating, updating, or deleting an endpoint group

Alarm notifications are sent out when alarms are raised or cleared, and when severities are updated.

Notification Methods

XCO supports two methods of notification: HTTPS webhook and syslog (using Reliable Event Logging Protocol [RELP] over Transport Layer Security [TLS]). The format of the notifications is the same for both methods. You can configure one or both methods.

Webhook
This REST API-based method is a POST operation. The notification payload is in the body of the HTTPS call. Use the efa notification subscribers add-https command to register a subscriber for this method of notification.
Syslog over RELP
In this client-server method, the client initiates the connection and the server listens. In this scenario, the client is the Notification service and the server is the remote system where syslog is configured to work with RELP. Any external server that is configured with RELP can be registered as a subscriber to XCO notifications.
When RELP is configured with TLS, XCO must be installed in secure mode. For more information, see the "XCO Installation Modes" topic in the ExtremeCloud Orchestrator Deployment Guide, 3.2.0 .
Communication from SLX devices occurs over TLS. The certificates required for SLX devices to work with secure syslog are generated when the devices are registered.
Use the efa notification subscribers add-syslog-relp command to register a subscriber for this method of notification.
Note

Note

Notification service will be disabled and will not send any alerts or events to those subscribers that fail to send messages due to connectivity issues. There will be a five minute periodic timer to verify the connectivity status of the failed subscribers.

EFA-008000 is a special event which will be received by the subscribers during the verification of connectivity between XCO notification service and subscribers. Subscribers receiving this message are indicated that there was a prior connectivity issue and it is now resolved.

9037725-00 RevAA