SD-WAN Viptela Collector Agents Guide

Edit online

About

Edit online

This documents provides details for the Viptela collector agents.

Dependencies

Edit online

The following table provides information about the dependencies of the Viptela collector agents.

Agent Dependencies
AlarmStatAgent InstallerAgent, DeviceDescriptionAgent
ApprouteEventAgent InstallerAgent, DeviceDescriptionAgent
DeviceDescriptionAgent InstallerAgent
DeviceHealthAgent InstallerAgent
FlowAgent InstallerAgent, DeviceDescriptionAgent
InterfaceQueueAgent InstallerAgent
InterfaceStatAgent InstallerAgent
MetadataAgent InstallerAgent
NextHopTableAgent InstallerAgent, DeviceDescriptionAgent
ObjectDescriptionAgent InstallerAgent, DeviceDescriptionAgent
PolicyParserAgent InstallerAgent, DeviceDescriptionAgent
TunnelStatAgent InstallerAgent

Viptela Collector Agents

Edit online

AlarmStatAgent

Edit online

Creates alerts for SevOne NMS devices and objects or clears them based on the alarm statistics received from the Viptela collector (vManage).

Data Flow

Edit online
  1. Get alarm statistics from the Viptela collector (vManage).
  2. Get all NMS devices.
  3. Filter received alarms based on their component. The supported components are,
    • Bidirectional Forwarding Detection (BFD)
    • Control
    • Hardware
    • Overlay Multicast Protocol (OMP)
    • System
    • Virtual Private Network (VPN)
  4. For each of the filtered alarms, check if the associated device exists in NMS.
  5. If alarm's events are not cleared, add an alert for the device. Otherwise, clear it.
  6. If alarm has consumed events then for each event, add an alert to the object.
  7. Send alerts to NMS or clear them from NMS.

ApprouteEventAgent

Edit online

Creates alerts for NMS devices on SLA state change event and updates cache with BFD sessions on BFD state change event.

Data Flow

Edit online
  1. Get all the alerts with filter criteria as plugin name = VIP-EVENT:: and closed = 0.
  2. Clear all matching alerts.
  3. Get device events statistics from the Viptela collector (vManage).
  4. Get all NMS devices.
  5. For each Viptela device with a corresponding NMS device,
    • If device's event is sla-change, create alert for the device.
    • If device's event is bfd-state-change, update cache with new BFD session details. i.e., availability and transitions. The same will be used by TunnelStatAgent to populate the data for availability and transitions indicators.
  6. Send alerts to NMS or clear them from NMS.

DeviceDescriptionAgent

Edit online

Update the device description with location details. Create device groups based on location.

Data Flow

Edit online
  1. Get all NMS devices present under the tenant device group.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes.
  3. Get device location from Viptela transport if the custom site grouping is off.
  4. If custom site grouping is on, get the location from device metadata SDWAN_GENERIC.Site Name.
  5. Compare the Viptela device names against NMS devices. If the name matches, then update the device's description with device location.
  6. Create device groups under tenant device group, if not present.
  7. Update the device group rules for all 3 device groups up the hierarchy (Site Device Group, Tenant Device Group, MSP Device Group).

DeviceHealthAgent

Edit online

Populate NMS devices with time series data for sdwan::device-health object type.

Data Flow

Edit online
  1. Get all NMS devices.
  2. Get all Viptela devices and filter the devices based on regex provided in vendor.device_filter_regexes.
  3. For each Viptela device, query the device health.
  4. Send device health time series data to corresponding NMS devices.
    • Populate indicators for object type sdwan::device-health.
  5. Remember the time of the last data point. The next run will request device health as of that time.

FlowAgent

Edit online

Maps flow objects to NMS objects for object-types sdwan::device-interface and sdwan::tunnel and updates the names and speed of flow interfaces.

Data Flow

Edit online
  1. Get NMS devices for the tenant.
  2. Fetch the flow device mappings for these devices.
  3. Fetch the flow devices and interfaces for these mappings.
  4. For flow interface updates,
    1. Fetch the interface object type.
    2. Fetch the indicators with indicator type interface_speed.
    3. Fetch last value for these indicators.
    4. For each flow interface, fetch NMS interface from flow device mappings and ifIndex.
      • Set the interface name and speed.
  5. For flow object mapping,
    1. Fetch the NetFlow view id and NetFlow field id specified in tunnel_filter_view and tunnel_filter_field configuration.
    2. Fetch all NetFlow filters.
    3. Fetch interface and tunnel object types.
    4. Fetch tunnel and interface indicator types for rx_octets and tx_octets.
    5. Fetch all indicators of these indicator types.
    6. Fetch existing interface and tunnel flow object mappings.
    7. For each indicator, create flow object mapping. Recreate mapping if already exists.
      • Device mapping - map NMS devices to flow devices using flow device mapping.
      • Object mapping - map interface objects to flow interfaces using ifIndex.
      • Map indicators using directions - incoming to rx* and outgoing to tx*.
    8. Add NetFlow filter to tunnel object mappings.

InstallerAgent

Edit online

Create the missing Device Object Indicator (DOI) types in NMS such as, device types, device groups, and subgroups based on the location. Also, create object types, tunnel object groups and rules, interface object groups and rules, metadata schema in NMS.

Data Flow

Edit online
  1. Create SDWAN and tenant device group, if not existing.
  2. Get all devices with device site details and filter these devices based on regex provided in vendor.device_filter_regexes.
  3. Get previous collector info from NMS like previous collector version, host name etc.
  4. Create SD-WAN and tenant object group, if not existing.
  5. Get all device groups under the tenant device group.
  6. Create and update metadata schema in NMS for all namespaces such as, SDWAN_DEVICES, SDWAN_INFO, and SDWAN_SLA_CLASSES.
  7. Create device groups and subgroups under the tenant device group and also update device group metadata for the device groups and subgroups in NMS.
  8. Create common device types in NMS.
  9. Create tunnel and interface object groups and rules under the tunnel object group.
  10. Create common object types in NMS.

InterfaceQueueAgent

Edit online

Populate NMS devices with time series data for sdwan::device-interface-queue object type.

Data Flow

Edit online
  1. Get all LAN and WAN interfaces.
    • Filter LAN interfaces that have an IPv4 address.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes.
  3. Get interface Queue stats for each Viptela device.
  4. For each interface Queue stat,
    • If setting vendor.interface_queue_stat.disable_wan_interface_stats==true, do not collect WAN interfaces.
    • If setting vendor.interface_queue_stat.disable_lan_interface_stats==true, do not collect LAN interfaces.
    • If setting vendor.vpn_id_filter is set, filter interfaces matching these VPN ids.
    • Calculate indicator data from the stat.
    • Create/update NMS object matching the interface queue name for all configured queues.
  5. Load interface queue time series data to corresponding NMS devices for object type sdwan::device-interface-queue.
  6. Remember the time of the last data point. The next run will request device interface queue as of that time.

InterfaceStatAgent

Edit online

Populate NMS devices with time series data for sdwan::device-interface object type. Update cache with bandwidth data to be used by the tunnel agent.

Data Flow

Edit online
  1. Get all LAN and WAN interfaces.
    • Filter LAN interfaces that have an IPv4 address.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes.
  3. Get interface stats for each Viptela device.
  4. For each interface stat,
    • If setting vendor.filtered_indicators_list is set, filter interface stat matching these indicator names.
    • If setting vendor.interface_stat.disable_wan_interface_stats==true, do not collect WAN interfaces.
    • If setting vendor.interface_stat.disable_lan_interface_stats==true, do not collect LAN interfaces.
    • If setting vendor.vpn_id_filter is set, filter interfaces matching these VPN ids.
    • Calculate indicator data from the stat.
    • Create/update NMS object matching the interface name.
  5. Load interface time series data to corresponding NMS devices for object type sdwan::device-interface.
  6. Remember the time of the last data point. The next run will request device interface as of that time.
  7. Update redis with bandwidth data for TunnelStatAgent.

MetadataAgent

Edit online

Populate NMS device metadata with Viptela device details.

Data Flow

Edit online
  1. Get all NMS devices.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes and get reboot history, SLA details, and organization details.
  3. Ensure NMS metadata scheme is defined for all affected namespaces and attributes.
  4. Populate NMS device metadata in namespaces such as, SDWAN_DEVICES, SDWAN_INFO, and SDWAN_SLA_CLASSES.

PolicyParserAgent

Edit online

Populate redis with policy details and application details to be used by Flow Augmentor. Add flow device IP in its device metadata.

Data Flow

Edit online
  1. Get all NMS devices, NetFlow devices, and flow device mappings.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes and get policy details, all interfaces, and Deep Packet Inspection (DPI) app details. DPI provides application information that flow receives.
  3. Get NBAR2 application details from CSV file.
  4. Parse CLI type, feature type policies, and populate in redis.
  5. Populate and NBAR2 application details in redis.DPI
  6. Update device metadata with its flow device IP.
  7. Publish invalidation message to redis to inform the Flow Augmentor to update local data.

NextHopTableAgent

Edit online

Populate redis with Next Hop table and tunnel details.

Data Flow

Edit online
  1. Get all NMS devices in the tenant.
  2. Get all NetFlow devices, flow device mappings, and interface objects.
  3. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes and get all the interfaces.
  4. Populate Next Hop table and tunnel information in redis.
    • redis values set to expire in 24 hours, by default.
    • Agent to rerun every 15 minutes.

ObjectDescriptionAgent

Edit online
  • Updates description of 3 types of objects - interfaces, tunnels, and interfaceQueue objects.
  • If vendor.custom_site_grouping is enabled, create object group and rules based on device metadata SDWAN_GENERIC.Site Name.

Data Flow

Edit online
  1. Get all NMS devices present under the tenant device group.
  2. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes.
  3. Get device location from Viptela transport if the custom site grouping is off.
  4. If vendor.custom_site_grouping is enabled, get the location from device metadata SDWAN_GENERIC.Site Name.
  5. From the device location, create a Device Data map which contains the Device IP, id, location, and alternate name details.
  6. Get all object types (mainly for an interface, interface queues, and tunnels).
  7. Get tunnel, interface, and interface queue objects.
  8. If vendor.custom_site_grouping is enabled, get the tunnel tenant objectGroup and site deviceGroups from NMS.
  9. If vendor.custom_site_grouping is enabled, from site deviceGroups and device metadata, create a map createObjectGroups which contain objectGroupName, objectGroupRule, and deviceGroupId.
  10. For interface object, update the object description with interfaceType::interfaceName::ifindex::interfaceIfindex.
  11. For tunnel object, update the object description with src_device_location->dst_device_location and object's alternate name if the user sets it.
  12. For interface queue object, update the object description with QosMapName and QosSchedulerName.
  13. If vendor.custom_site_grouping is enabled, create object group and rules based on createObjectGroups map.

TunnelStatAgent

Edit online

Populate NMS devices with time series data for sdwan::LOCALCOLOR object type, where LOCALCOLOR is a value of a field local_color from app route statistic.

Data Flow

Edit online
  1. Get all Viptela devices and filter these devices based on regex provided in vendor.device_filter_regexes.
  2. Create a map of IP and devices from Viptela.
  3. Get app route statistic.
  4. Proceed only if device in app route stat is present in the map created above.
  5. Using app route stats for source device and destination device, which creates a tunnel, gather data indicators for,
    1. latency
    2. jitter
    3. loss_percentage
    4. tx_utilization
    5. rx_utilization
    6. Collect data for the following optional indicators, if present in vendor.tunnel_stat.optional_indicators.
      • loss
      • total_utilization
      • source_interface_speed
      • destination_interface_speed
    7. Collect data for the following indicators if vendor.tunnel_stat.disable_get_octets is set to false.
      • tx_octets
      • rx_octets

    8. Collect data for the following indicators if vendor.tunnel_stat.disable_get_packets is set to false.

      • tx_pkts
      • rx_pkts
    9. BFD data which includes Transitions and Availability if vendor.disable_bfd_sessions_stat is set to false. (BFD data is maintained by the ApprouteEventAgent)
  6. Collect SLA indicators based on setting vendor.tunnel_stat.total_sla_indictor_value.
    1. The setting supports three values - 0, 1, and 3.
      • When set to 0, no SLA indicator will be created.
      • When set to 1, SLA indicator shows value either for NORMAL, DEGRADED, or NOVIABLE SLA class.
      • when set to 3, it shows values for all 3 SLA classes.
  7. Update cache with BFD data. i.e., Transitions and Availability.
  8. Update cache with bandwidth data. i.e., ifSpeed, ifName, B/W UP, and B/W Down.
  9. Load data indicators to NMS for a corresponding source device with object type as sdwan::LOCALCOLOR, where LOCALCOLOR is a value of a field local_color from app route statistics.