Manage Global Notification Filters

Few SDN/SDWAN solutions generate 100-200K alarms/events on a daily basis. Due to this, network operators spend 3-4 hours daily to clear/acknowledge alarms that are not relevant to their business. You can build filtering capabilities across the
DX NetOps Virtual Network Assurance
(VNA) plug-ins using global notification filters of alarms and events.
To manage notifications, go to the user interface (UI) for the
DX NetOps Virtual Network Assurance
API at the following address:
http://
gateway_host
:8080/vna/
In this article:
Get Filter Configuration
Gets the filter configuration for the given engine.
Follow these steps:
  1. From the UI for the
    DX NetOps Virtual Network Assurance
    API, show the
    Notification
    .
  2. Select the following GET endpoint:
    /v1/notification/filter/{engineid}
    Use the engine id for which you want to get the filter
  3. Click
    Try it out!
    .
    View the response body.
Create Filter Configuration
Create filter allows you to create a blacklist or whitelist filter for alarms/events.
Follow these steps:
  1. From the UI for the
    DX NetOps Virtual Network Assurance
    API, show the
    Notification
    .
  2. Select the following POST endpoint:
    /v1/notification/createFilter
    Use JSON payload with filtering criteria (refer to the sample payload to create filter)
  3. Click
    Try it out!
    .
    View the response body.
Sample Payload to create a Global Notification filter is given below:
{ "ENGINE_ID": "ACI_f703b65c-0858-4a02-aa69-3921a507f93e", "FILTER_TYPE": "blacklist", "NOTIFICATION_TYPE": "alarm", "CLEAR_HISTORICAL_ALARMS": true, "SEVERITY": ["minor", "warning"], "STATE": ["MODIFIED"], "NAME": ["F0103", "F0118"], "CAUSE": ["port-down"], "NOTIFICATION_ID": ["topology/pod-1/node-1/cphys-[eth1/2]/fault-F0104"], "RULE": ["cnw-phys-if-down"], "TYPE_FROM_SOURCE": ["operational"], "ACKNOWLEDGED": true }
  • ENGINE_ID
    Specifies the engine Id and the filter configurations that will be applied to the specified engine.
  • FILTER_TYPE
    Specifies whether to apply Blacklisting filter or whitelisting filter.
    Values:
    Blacklist, Whitelist.
    You can configure either a whitelist or blacklist filter, but not both at the same time.
  • NOTIFICATION_TYPE
    Specifies whether to apply the filter for alarms or events
    Values:
    Values: Alarm, Event>
  • CLEAR_HISTORICAL_ALARMS
    Specifies whether to clear the historical alarms.
    Values:
    true or false
  • SEVERITY
    Specifies the list of severities that needs to blacklisted or whitelisted using comma as a separator.
    Values:
    INFO, MAJOR, MINOR, WARNING, CRITICAL, MEDIUM, UNKNOWN
  • STATE
    Specifies a list of States that needs to blacklisted or whitelisted.
    Values:
    CREATED, MODIFIED, CLEARED, UNKNOWN
  • NAME
    Specifies the list of names to be filtered (any string values separated by a comma).
  • CAUSE
    Specifies the list of causes to be filtered (any string values separated by a comma).
  • NOTIFICATION_ID
    Specifies the list of notification IDs to be filtered (any string values separated by a comma).
  • RULE
    Specifies the list of rules to be filtered (any string values separated by a comma).
  • TYPE_FROM_SOURCE
    Specifies the list of type from sources to be filtered (any string values separated by a comma).
  • ACKNOWLEDGED
    Specifies whether to filter the acknowledged alarms.
    Values:
    true/false.
Update Filter Configuration
Update filter allows you to update the existing filter that is configured for the given engine id.
Follow these steps:
  1. From the UI for the
    DX NetOps Virtual Network Assurance
    API, show the
    Notification
    .
  2. Select the following PUT endpoint:
    /v1/notification/createFilter
    Use JSON payload with filtering criteria (refer the sample payload from creating filter section)
  3. Click
    Try it out!
    .
    View the response body.
  • To update the configured filter associated with an engine recommended use get to filter and update to the required filter settings.
  • The filter template for updating filter configurations is the same as create the filter and you can add/remove/update any filter settings associated to an engine.
The following example updates the existing filter configuration to whitelist critical alarms with the name f0104 and the remaining alarms are filtered:
{ "ENGINE_ID": "ACI_f703b65c-0858-4a02-aa69-3921a507f93e", "FILTER_TYPE": "whitelist", "NOTIFICATION_TYPE": "alarm", "CLEAR_HISTORICAL_ALARMS": true, "SEVERITY": ["critical"], "NAME": ["f0104"] }
Delete Filter Configuration
You can delete the filter configuration for the given engine.
Follow these steps:
  1. From the UI for the
    DX NetOps Virtual Network Assurance
    API, show the
    Notification
    .
  2. Select the following DELETE endpoint:
    /v1/notification/deleteFilter/{engineid}
    Use the engine id for which you want to delete the filter
  3. Click
    Try it out!
    .
    View the response body.
After deleting a filter associated with the engine, notifications are not filtered and VNA processes all alarms/events and shows them in connected clients (Spectrum).