◄
►

Configure Alerts and Notifications

Orchestrator allows you to configure alerts that notify the Operators, Enterprise Administrators or other support users, whenever an event occurs.

Note: If you are logged in as a user with Customer support privileges, you can view the Alerts and other objects, but cannot configure them.
In the SD-WAN service of the Enterprise portal, select Service Settings > Alerts & Notifications . The Alert Configuration screen appears.
Figure 1. Alert Configuration

For information on how to configure Alerts, see Configure Alerts.

For information on how to configure SNMP Traps, see Configure SNMP Traps.

For information on how to configure Webhooks, see Configure Webhooks.

Configure Alerts

The Alerts page in the Alert Configuration window allows you to select the events for which the alerts need to be sent. You can also add and edit the contact details of existing admin users.

The alerts can be sent to both, the Operators managing the Orchestrator and the Customers. Alerts sent to the Operators are called Operator Alerts (formerly known as Pre-Notifications), and are sent as soon as the event occurs. Alerts sent to the Customers are called Enterprise Alerts and are activated only when a Customer turns on the Enable Enterprise Alerts option under Alert Configuration. Enterprise Alerts can be subject to delays as configured by the Enterprise Admin(s).

For example, consider that a Customer has configured the Link Down alert delay for 2 minutes. If a WAN link loses communication with the Edge, Operator Alerts are sent immediately. Enterprise Alerts are sent after a delay of 2 minutes.

  1. In the Alert Configuration window, the Alerts tab is displayed by default.
    Figure 2. Alerts
  2. Configure the Notification Settings as required.
  3. Under the Incident section, select the check boxes as required, and enter the corresponding Notification Delay time in minutes.
    Note:
    • The On/Off toggle button is automatically set to On if all the events are selected.
    • Hover over the information icon next to each event for additional information.
    • You can use the event ALERT_CONFIGURATION_UPDATED to filter the events triggered by changes to the Enterprise Alert configurations.
  4. Expand Email/SMS in the Notifications section to display the contact details of existing admin users.
    Figure 3. Notifications
  5. The following contact details are displayed:
    Table 1. Notifications- Options and Descriptions
    Option Description
    Name This field is auto-populated based on the configured administrators.
    Role Displays the role of the corresponding admin user.
    Email Address Displays the email address of the corresponding admin user.
    Phone No Displays the phone number of the corresponding admin user.
    Email Activate the toggle switch to send email notification to the admin user's email address.
    SMS Activate the toggle switch to send SMS notification to the admin user's mobile number.
    Note: This option is available only if the admin user has a valid phone number.
    Verify Select to validate the email address and/or phone number of the user.
  6. The following additional options are available:
    Table 2. Additional Options and Descriptions
    Option Description
    Add Receiver Selecting this option creates a new row for the admin user. Enter the name and phone number.
    Add Multiple Emails Select this option to add multiple email addresses for the admin user. The email addresses must be added in a comma separated list.
    Delete Select this option to delete all the contact details of the selected admin user.
  7. Expand Configured Hosts under Select Configured SNMP Trap Destination(s) to display the configured SNMP Traps. You can select one or multiple traps using the drop-down menu.
    Figure 4. Configured Hosts
    Note: If no SNMP Trap is configured, this section displays a link to the SNMP Traps page.
  8. Expand Configured URL under Select Configured Webhooks to display the configured webhooks. You can select one or multiple webhooks using the drop-down menu.
    Figure 5. Configured URL
    Note: If no webhook is configured, this section displays a link to the Webhooks page.
  9. Select Save Changes.

Configure SNMP Traps

Simple Network Management Protocol (SNMP) Traps are notifications sent to an SNMP Agent to indicate that an event has occurred. Orchestrator sends SNMP Traps corresponding to the existing alerts like Edge Down and Edge Up.

  1. The SNMP Traps page in the Alert Configuration window, allows you to configure v2c and v3 SNMP Trap Destinations.
    Note: Currently, only SHA-1 and AES-128 algorithms are supported for SNMP v3 Trap.
    Figure 6. Configure SNMP Trap Destination
  2. Configure the following fields under v2c SNMP Trap Destinations:
    Table 3. v2c SNMP Trap Destinations- Options and Descriptions
    Option Description
    Hostname/IP Address Enter the IP address.
    Port Enter the port number.
    Community Enter the community. Community can be private or public.
    Verify Select this option to validate the IP address.
    Add Destination Select this option to add a new v2c SNMP Trap Destination.
    Delete Select this option to remove the selected entry from the table.
  3. Configure the following fields under v3 SNMP Trap Destinations:
    Table 4. v3 SNMP Trap Destinations- Options and Descriptions
    Option Description
    Hostname/IP Address Enter the IP address.
    Port Enter the port number.
    Username Enter the username.
    Authentication Select one of the following:
    • MD5
    • SHA
    Displays Disabled by default.
    Encryption Select one of the following:
    • DES
    • AES
    Displays Disabled by default.
    Verify Select this option to validate the IP address.
  4. Select Save Changes to save the configured SNMP Trap Destinations.

Configure Webhooks

Webhooks deliver data to other applications, triggered by certain alerts using HTTP POST. Whenever an alert occurs, the source sends an HTTP request to the target application configured for the webhook. Orchestrator supports Webhooks that automatically send messages through HTTP POST to target apps when an event occurs. You can set the target URL in the Enterprise portal and automate actions in response to the alerts triggered by Orchestrator. The webhook recipients must support HTTPS and must have valid certificates, to ensure the privacy of potentially sensitive alert payloads. This also prevents the tampering of payloads. Any application that supports incoming webhooks with HTTPS can integrate with VeloCloud SD-WAN.

  1. The Webhooks page in the Alert Configuration window, allows you to configure the following details:
    Figure 7. Configure Webhooks

     

    Table 5. Configure Webhooks- Options and Descriptions
    Option Description
    URL Enter a valid HTTPS URL. This serves as the target application for the webhooks.
    Code Enter an expected HTTP response status code for each webhook recipient. By default, the Orchestrator expects webhook recipients to respond to HTTP POST requests with a status code as HTTP 200.

    When Orchestrator receives an unexpected status code from a recipient server or a proxy server, it considers that the alert delivery has failed, and generates an ALERT_DELIVERY_FAILED customer event. This event helps to identify when a webhook recipient server may fail to function as expected.
    Secret This field is optional. Specify a secret token for each configured webhook recipient, which is used to compute an HMAC for each webhook request sent to the corresponding recipient. The HMAC is embedded in a X-Webhook-Signature HTTP header, along with a version parameter, which identifies the signature algorithm and a timestamp. 
    X-Webhook-Signature: v=<signature-version>&t=<timestamp>&s=<hmac>
    The recipient interprets the components as follows:
    • v: Version of the algorithm used to produce the signature. The only supported value is 1.
    • t: Millisecond-precision epoch timestamp corresponding to the time at which the request is issued.
    • s: HMAC computed by Orchestrator. The HMAC is computed as follows: HMAC-SHA256(request-body + '.' + timestamp, secret).

    The message used to compute the HMAC is formed by concatenating the request body, a single period, and the value of the timestamp parameter that appears in the signature header. The specific HMAC algorithm used to produce the code is HMAC-SHA256.

    After receiving a Webhook request, the listening server can verify the authenticity of the request by computing its own HMAC-SHA256 signature according to the same algorithm and compare the newly-computed signature with the one generated by the Orchestrator.
    JSON Payload Template This is a required field. Orchestrator delivers alert notifications to each webhook recipient, through a JSON payload contained within the body of an outgoing HTTP POST request. Orchestrator generates payload content dynamically, as notifications are sent by performing variable interpolation. The supported placeholder variables in the user-configured payload template are replaced with alert-specific values.
    Verify Select this option to validate the entered details.
  2. Select Configure Payload Template link under the JSON Payload Template option to configure the following:
    Figure 8. Configure Payload Template

     

    Table 6. Configure Payload Template- Options and Descriptions
    Option Description
    Alert Time Enter the date and time at which the alert must be triggered.
    Alert Type Select the type of alert from the dropdown menu. By default, it is displayed as N/A.
    Customer Logical ID Enter the logical ID of the customer to whom the notification must be sent.
    Customer Enter the name of the customer to whom the notification must be sent.
    Device Logical ID Enter the logical ID of the Edge to which the alert must be applied.
    Device Description Enter a brief message describing the Edge to which the alert must be applied.
    Device Serial Number Enter the serial number of the Edge to which the alert must be applied.
    Device Name Enter the name of the Edge to which the alert must be applied.
    Last Contact Enter the date and time at which the affected Edge most recently communicated with the Orchestrator. This is applicable only for the Edge alerts.
    VCO Enter the Hostname or public IP of the Orchestrator from which the notification must be sent.
    Message Enter a brief message describing the event that must trigger the alert.
    Entity Affected Enter the name of the entity: Edge or link or VNF, to which the alert must be applied.
  3. Select Save, and then select Save Changes on the Webhooks page to save the webhook configurations.
    Note: Whenever an alert is triggered, an alert message along with relevant information is sent to the target URL.

The following example shows a sample JSON payload template:

{ "alertTime": "alertTime", "alertType": "alertType", "customer": "customer", "customerLogicalId": "customerLogicalId", "entityAffected": "entityAffected", "deviceLogicalId": "deviceLogicalId", "lastContact": "lastContact", "message": "message", "vco": "vco", "deviceName": "deviceName", "deviceDescription": "deviceDescription", "deviceSerialNumber": "deviceSerialNumber" }