SD-WAN Viptela Collector Advanced Use-Cases Guide

SevOne Documentation

All documentation is available from the IBM SevOne Support customer portal.

All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of IBM and its respective licensors. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of IBM.

IN NO EVENT SHALL IBM, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IBM DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

IBM, the IBM logo, and SevOne are trademarks or registered trademarks of International Business Machines Corporation, in the United States and/or other countries. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on ibm.com/trademark.

About
Advanced Configuration Settings
Multi-Tenant Deployment
Optional Configurations
Object Type Indicator Optimization

About

This document contains details on advanced configurations and use-case(s) after the Viptela collector has been deployed. In addition to this, this document describes the optional configurations to be set from your SevOne NMS appliance you are sending SD-WAN collector data to. It also provides details on how to configure custom sites.

Advanced Configuration Settings

Variable Name	Value Type	Default Value	Description
collectorConfig.agent.exclude	Array of strings	["AlarmStatAgent"]	Array of agent names to exclude explicitly. This setting is additive with the include. If empty or unset, no agents are excluded.
collectorConfig.agent.include	Array of strings		Array of agent names to include explicitly. If empty or unset, all agents are included.
collectorConfig.agent.long_run_warning	Duration	5m	Time duration to warn of long running agents.
collectorConfig.log.level	String	info	Defines the log-level for the collector. Value can be info, debug, warning, trace, or error.
collectorConfig.log.color	Boolean	false	Set true to output logs with color.
collectorConfig.load_reports.disabled	Boolean	false	Set true to not import TopN views and OOTB reports.
collectorConfig.nms.api.distribution_peer_list	Array of integers		Array of Peer IDs to distribute data. If the array is empty, data will be distributed to all peers.
collectorConfig.nms.api.insecure_tls_connection	Boolean	false	Set true to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
collectorConfig.nms.api.port	Integer	443	SOA API port. REST API port is internally set to 443 and cannot be changed.
collectorConfig.nms.api.timeout	Duration	30s	Timeout duration for NMS API requests.
collectorConfig.vendor.cache_ttl	Duration	10m	TTL for device cache items.
collectorConfig.vendor.alarm_stat.default_query_interval	Duration	10m	Time interval for initial alarm query.
collectorConfig.vendor.alarm_stat.query_count_per_request	Integer	1000	Page size for querying alarms from Viptela.
collectorConfig.vendor.alarm_stat.schedule	Schedule string	@every 10m	Scheduled cron for alarm stat agent.
collectorConfig.vendor.alarm_stat.filter	Object	empty (No filters)	Filter alerts based on vManage severity or alarm name. If the filter_on flag value is set to alarm_name, you can use any of the supported alarm names listed below. BFD Control Hardware OMP System VPN Example: Alarm filter `collectorConfig:` `vendor:` `alarm_stat:` `filter:` `filter_on:"alarm_name"` `filter_value:` `- "OMP_Site_Down"` If the filter_on flag value is set to vmanage_severity, you can use any of the supported severity levels listed below. Critical Major Medium Minor Example: Severity filter `collectorConfig:` `vendor:` `alarm_stat:` `filter:` `filter_on:"vmanage_severity"` `filter_value:` `-` `"Critical"` `-` `"Major"` To run the AlarmStatAgent successfully, please provide a valid filter.
collectorConfig.vendor.vmanage_api.insecure_tls_connection	Boolean	false	Set true to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
collectorConfig.vendor.vmanage_api.timeout	Duration	30s	API request timeout. Set to a duration in seconds with "s" suffix.
collectorConfig.vendor.vmanage_api.url	String		vManage API URL e.g. "https://server.example.com:8443"
collectorConfig.vendor.vmanage_api.bulk_api_offset	Duration	0 seconds	Need to decide the offset time from the current time when querying bulk API for collecting the stats.
collectorConfig.vendor.approute_event.default_query_interval	Duration	10m	Time interval for initial approute event query.
collectorConfig.vendor.approute_event.query_count_per_request	Integer	1000	Page size for querying device events from Viptela.
collectorConfig.vendor.approute_event.schedule	Schedule string	@every 10m	Scheduled cron for approute event agent.
collectorConfig.vendor.approute_event.send_alerts	Boolean	false	Set true to send alerts to SevOne NMS from ApprouteEventAgent.
collectorConfig.vendor.custom_site_grouping	Boolean	false	Customer sets the device location manually in device metadata.
collectorConfig.vendor.device_description.default_query_interval	Duration	24h	Time interval for initial device configuration query.
collectorConfig.vendor.device_description.query_count_per_request	Integer	1000	Page size for querying devices from Viptela.
collectorConfig.vendor.device_description.schedule	Schedule string	0 0 * * *	Scheduled cron for device description agent.
collectorConfig.vendor.device_description.disable_device_ip_update	Boolean	false	Set true to disable the device IP update in SevOne NMS.
collectorConfig.vendor.device_filter_regexes	Array of strings		Collect indicators for devices which are not in the regex list.
collectorConfig.vendor.device_health.schedule	Schedule string	@every 10m	Scheduled cron for device health agent.
collectorConfig.vendor.disable_bfd_sessions_stat	Boolean	false	Update bfd session in cache if not disabled. ApprouteEventAgent must not be in the list of excluded agents. Otherwise, TunnelStatAgent may push wrong values for availability and transitions indicators.
collectorConfig.vendor.disable_collect_octets	Boolean	false	Set true to not collect octets(bytes) data.
collectorConfig.vendor.disable_collect_packets	Boolean	false	Set true to not collect packets data.
collectorConfig.vendor.filtered_indicators_list	Array of strings		Array of filtered indicator names to collect. Omit collecting data for the optional indicators not in this list. Here is the list of filtered indicators. tx_pps rx_pps up_capacity_percentage down_capacity_percentage total_mbps
collectorConfig.vendor.flow.disable_interface_name_update	Boolean	false	Disable flow interface name update.
collectorConfig.vendor.flow.disable_interface_speed_update	Boolean	false	Disable flow interface speed update.
collectorConfig.vendor.flow.disable_map_interface_objects	Boolean	false	Disable flow object mapping for interface objects.
collectorConfig.vendor.flow.disable_map_tunnel_objects	Boolean	false	Disable flow object mapping for tunnel objects.
collectorConfig.vendor.flow.schedule	Schedule string	0 1 * * *	Scheduled cron for flow agent.
collectorConfig.vendor.flow.tunnel_filter_field	String	Tunnel	Netflow view field for tunnel name.
collectorConfig.vendor.flow.tunnel_filter_view	String	SDWAN:Viptela:AugmentedFlow	Standard Netflow view for augmented flows. Netflow view is created during installation.
collectorConfig.vendor.installer.query_count_per_request	Integer	1000	Page size for querying installer data from Viptela.
collectorConfig.vendor.installer.schedule	Schedule string	0 0 * * *	Scheduled cron for installer agent.
collectorConfig.vendor.interface_queue_stat.disable_lan_interface_queue	Boolean	false	Need to collect LAN interface queue Data or not.
collectorConfig.vendor.interface_queue_stat.disable_wan_interface_queue	Boolean	false	Need to collect WAN interface Data or not.
collectorConfig.vendor.interface_queue_stat.qos_scheduler_policy_refresh_interval	Integer	86400	Interval to refresh qos scheduler profile.
collectorConfig.vendor.interface_queue_stat.schedule	Schedule	string	@every 10m
collectorConfig.vendor.interface_stat.default_query_interval	Duration	30m	Time interval for initial interface stat query.
collectorConfig.vendor.interface_stat.disable_lan_interface_stats	Boolean	false	Need to collect LAN interface Data or not.
collectorConfig.vendor.interface_stat.disable_wan_interface_stats	Boolean	false	Need to collect WAN interface Data or not.
collectorConfig.vendor.interface_stat.query_count_per_request	Integer	1000	Page size for querying interfaces from Viptela.
collectorConfig.vendor.interface_stat.schedule	Schedule string	@every 10m	Scheduled cron for interface stat agent.
collectorConfig.vendor.metadata.disable_sla_constraints	Boolean	false	Set true to disable collection of device metadata for SLA constraints such as, jitter, latency, and loss.
collectorConfig.vendor.metadata.schedule	Schedule string	0 0 * * *	Scheduled cron for metadata agent.
collectorConfig.vendor.next_hop_table.query_count_per_request	Integer	1000	Page size for querying bfd sessions from Viptela.
collectorConfig.vendor.next_hop_table.redis_ttl	Duration	24h	Expiration time for Next Hop data stored in Redis.
collectorConfig.vendor.next_hop_table.schedule	Schedule string	@every 15m	Scheduled cron for next hop table agent.
collectorConfig.vendor.number_of_sla_indicators_to_create	Integer	1	Supports value 0, 1 or 3. When set to 0, no SLA indicator will be created. When set to 1, single SLA indicator will be created for each sla classes. When set to 3, NORMAL, DEGRADED, and NOVIABLE SLA indicators will be created for each sla class.
collectorConfig.vendor.object_description.default_query_interval	Duration	60m	Time interval for initial object description query.
collectorConfig.vendor.object_description.query_count_per_request	Integer	1000	Page size for querying interfaces from Viptela.
collectorConfig.vendor.object_description.schedule	Schedule string	0 * * * *	Scheduled cron for object description agent.
collectorConfig.vendor.policy_parser.local_cache_invalidation_channel	String	redis_reset_channel	Invalidation channel for Flow Augmentor cache.
collectorConfig.vendor.policy_parser.nbar2_csv_path	String	dpi_app_list/nbar2.csv	Path to NBAR2 CSV file.
collectorConfig.vendor.policy_parser.query_count_per_request	Integer	1000	Page size for querying policy data from Viptela.
collectorConfig.vendor.policy_parser.schedule	Schedule string	0 0 * * *	Scheduled cron for policy parser agent.
collectorConfig.vendor.tunnel_stat.default_query_interval	Duration	10m	Time interval for initial alarm query.
collectorConfig.vendor.tunnel_stat.disable_dry_run	Boolean	false	Set true to read/write through cache then Viptela API for transitions and availability indicators. Set false to read only from Viptela API.
collectorConfig.vendor.tunnel_stat.disable_get_octets	Boolean	false	Set true to disable collecting TX and RX octets.
collectorConfig.vendor.tunnel_stat.disable_get_packets	Boolean	false	Set true to disable collecting TX and RX packets.
collectorConfig.vendor.tunnel_stat.optional_indicators	Array of strings		Array of indicator names to collect. Indicators may be any of: source_interface_speed, destination_interface_speed, loss, or total_utilization
collectorConfig.vendor.tunnel_stat.query_count_per_request	Integer	100	Number of alarms to send to NMS per request.
collectorConfig.vendor.tunnel_stat.schedule	Schedule string	@every 10m	Scheduled cron for tunnel stat agent.
collectorConfig.vendor.unique_hostname_per_msp	Boolean	false	Flag to determine whether to keep tenant name in Device name or not.
collectorConfig.vendor.update_vmanage_lat_long_value	Boolean	true	Flag to check if the Latitude and Longitude must be set to from vManage. The default value is true. Must be disabled when a custom site grouping is enabled. If the device latitude and longitude values are not populated in SD-WAN networking device settings, then update_vmanage_lat_long_value must be set to false. By doing so, the SevOne NMS metadata latitude and longitude values will not be updated. However, if the device latitude and longitude values are populated in SD-WAN networking device settings, then you may set update_vmanage_lat_long_value to true. By doing so, the SevOne NMS metadata latitude and longitude values will be populated from vManage.
collectorConfig.vendor.vpn_id_filter	Array of integers		Array of VPN ids to collect. Set empty array to disable filter and collect all VPN ids.
collectorService.nodeAffinity.values	Array of string		Define hostname where you want to deploy the collector.
flowAugmentorConfig.listener.buffer	Integer	100000	Size of the inbound packet buffer in number of packets.
flowAugmentorConfig.listener.port	Integer	9996	The port on which container of flow augmentor listens for inbound flows. Use a different port for each tenant in case of multi-tenant deployment.
flowAugmentorConfig.destinations	Array of objects		An array of mappings of destination IP address to one or more packet source IP addresses. This is an optional mapping of DNC to source IP addresses. e.g. Configure two destinations like: `flowAugmentorConfig:` `destinations:` `- ip:` `10.0.0.1` `port:` `9996` `sources:` `-` `10.20.0.1` `-` `10.20.0.2` `- ip:` `10.0.0.2` `port:` `9997` `sources:` `-` `10.30.0.1` `-` `10.30.0.2`
flowAugmentorConfig.destinations.ip	String		Destination IP address of mapping.
flowAugmentorConfig.destinations.port	Integer	9996	Destination port of mapping.
flowAugmentorConfig.destinations.sources	Array of strings		An array of packet source IP addresses of mapping.
flowAugmentorConfig.log.level	String	info	Defines the log-level for the flow augmentor. Value can be info, debug, warning, or error.
flowAugmentorConfig.metadataCache.ttl	Duration	30m	In-memory cache storage TTL.
flowAugmentorConfig.sender.ip	String		IP address of the NMS/DNC, where the augmented flows are sent.
flowAugmentorConfig.sender.port	Integer	9996	Port of NMS/DNC, where the the augmented flows are sent.
flowAugmentorConfig.sender.buffer	Integer	100000	Sender output buffer size in number of packets.
flowAugmentorConfig.workers.receivers	Integer	1	Number of receiver worker / agent threads. Recommended to start with 40, then customize if needed.
flowAugmentorConfig.workers.senders	Integer	1	Number of sender worker / agent threads. Recommended to start with 5, then customize if needed.
flowAugmentorService.enabled	Boolean	true	Flag to enable Flow Augmentor installation.
flowAugmentorService.nodeAffinity.values	Array of string		Define hostname where you want to deploy augmentor.
flowAugmentorService.receiverPort	Integer	9995	The port on which Flow Augmentor listens for inbound flows. The port number can range from 9000 - 33000.
flowAugmentorService.augmentorReplicaCount	Integer	1	Number of augmentor instances running on the single collector instance. NOTE: Flow devices on each augmentor must be mutually exclusive to each other.

Multi-Tenant Deployment

ISO Installation
If you are a deploying SevOne Solutions from a .iso image, execute the following steps.

# install base packages
$ sudo /opt/SevOne/upgrade/freight/bin/freight deliver \
/opt/SevOne/upgrade/freight/packages/centos-update-*.el7.tgz
  
$ sudo yum upgrade -y --disablerepo=* --enablerepo=freight --skip-broken
  
$ sudo /opt/SevOne/upgrade/freight/bin/freight clean
  
# copy over the default ansible config
$ sudo cp -r /opt/SevOne/upgrade/ansible/playbooks/inventory/* /etc/ansible/

SD-WAN Multi-Tenancy is the feature where multiple tenants are added in SevOne's Data Insight environment from where the:

tenants are able to monitor their own appliances
admin user(s) can view all the details of tenant’s appliances

To deploy multiple tenants on a fresh or existing setup, execute the following steps.

Using ssh, log into SD-WAN collector control plane node as sevone.

$ ssh sevone@<SD-WAN collector 'control plane' node IP address or hostname>

Change directory to /etc/ansible/group_vars/all. By default, solutions.yaml file is available. For multi-tenancy, create a new file, solutions-2.yaml, in this directory.
```
$ cd /etc/ansible/group_vars/all
```
```
$ touch /etc/ansible/group_vars/all/solutions-2.yaml
```
Using a text editor of your choice, edit /etc/ansible/group_vars/all/solutions-2.yaml to add the following in it and save the file.

Example: solutions-2.yaml file for Viptela collector
```
$ vi /etc/ansible/group_vars/all/solutions-2.yaml

app_solutions_2:
  chart: solutions-sdwan-viptela
  enabled: true
  name: solutions-sdwan-viptela-2
  namespace: default
```
SD-WAN collector runs as a helm chart deployed within the Kubernetes cluster. The helm chart is configured with a base set of configuration options that can be overwritten as needed.
Copy /opt/SevOne/upgrade/utilities/example-solutions-sdwan-viptela_config.yaml to /opt/SevOne/chartconfs/solutions-sdwan-viptela-2_config_custom_guii.yaml.
In /opt/SevOne/chartconfs,

Tenant configuration file name extension can be .yaml or .yml. The pre-check and post-check scripts recognize and can consume both file extensions. Although all YAML files are accepted, it should be in the same frame as mentioned in /etc/ansible/group_vars/all/solution-2.yaml > name: <enter name>.

Tenant configuration file name must always be prefixed with solutions-sdwan-viptela- (hypen only). For example,
- solutions-sdwan-viptela-2_config_custom_guii.<yaml / yml>
Example
```
$ cp /opt/SevOne/upgrade/utilities/example-solutions-sdwan-viptela_config.yaml \
/opt/SevOne/chartconfs/solutions-sdwan-viptela-2_config_custom_guii.yaml
```
/opt/SevOne/chartconfs/solutions-sdwan-viptela-2_config_custom_guii.yaml contains the default (basic / minimum) configuration for Viptela. To change the configuration settings, using a text editor of your choice, /opt/SevOne/chartconfs/solutions-sdwan-viptela-2_config_custom_guii.yaml file must be updated and saved. For details on variables used in the .yaml file, please refer to SD-WAN Viptela Collector Deployment / Configuration Guide > section Configuration.
Tenant Name

The collectorConfig.tenant_name setting is required to provide a descriptive name for the additional tenants. Be sure that each tenant has a unique tenant_name.

Example: solutions-sdwan-viptela-2_config_custom_guii.yaml
```
...
... 

collectorConfig:
  ...
  ...

  # Tenant name for multi-tenant deployments.  Short and descriptive internal name.
  #
  # Must be unique per tenant.
  tenant_name: Tenant 2 
...
...
```
When using the flow augmentor service for multi-tenant deployment, the value for the following variables must be unique for each tenant.
- flowAugmentorConfig.listener.port
- flowAugmentorService.receiverPort
Example

In solutions-sdwan-viptela-2_config_custom_guii**.yaml** file, values denoted as base64 must be encoded as shown here.

Generate username 'admin' in base64-encoded format
```
$ echo -n "admin" | base64
YWRtaW4=
```
If username is admin, instead of using username: admin in the example configuration file above, use username: YWRtaW4=.

If the password contains an exclamation mark (!), please use any online string to base64 converter tool (other than CLI) to convert the password into base64 format. For example, https://www.base64encode.org/
Perform the pre-check of your environment, deploy the applications based on your configuration file, and run the post-check to ensure that the configuration file has been applied successfully. Ensure that there are no failures. Also, check the pods, services, and logs. For details, please refer to the steps related to these in SD-WAN Viptela Collector Deployment / Configuration Guide > section Installation > subsection using Command Line Interface.

Optional Configurations

Flow Device Mapping

The Device Mapping page enables you to map a SevOne device to a flow device.

By default, NMS automatically maps the SevOne device to the respective flow device if SevOne device IP and flow device IP match.

Users can also manually add a device mapping. Steps required to manually add a device mapping can be found in SevOne NMS System Administration Guide > section Map Flow Devices. After device mapping is done, users can generate FlowFalcon report for Device Group on the basis of Device mapping if the mapped device falls under a device group.

Object Mapping

The Object Mapping page enables you to map the indicators on the objects that plugins poll to a flow interface. This enables you to display a FlowFalcon report of the flow data that is related to the poll data from an indicator that appears in an Instant Graph.

Users can generate FlowFalcon report for Object Group on the basis of Object mapping. As of SDWAN Viptela 2.8 release, the solution will create Object mappings by default for the SD-WAN Tunnel and SD-WAN Interface Objects. For any other objects, users will have to manually add the Object mappings. Steps required to manually add an object mapping can be found in SevOne NMS System Administration Guide > section Map Flow Objects.

The device interface or tunnel object indicator should be mapped to the appropriate direction Incoming/Outgoing.

Mapping a device interface object

Mapping a tunnel object

After adding the object mapping, the user is now able to quick chain the performance metrics report to the FlowFalcon report for the indicator. Follow the steps below to see the flows report for the mapped object and the indicator.

Navigate to Reports > Create Report. Select Performance Metrics.
Select appropriate Resources the same as the mapped object and the indicator.
Create the Performance Metrics report by clicking on Finish. A Performance Metrics report will be generated.
Click on the Setting icon on the top-right corner of the report. Select Chain > Quick Chain.

Performance Metrics Report
This will automatically create the chained FlowFalcon for the selected object and the indicator as shown in the image below.

Quick Chain Report

Configure Custom Sites

Execute the following steps to configure custom sites for the Viptela collector.

To access the SevOne NMS login page, navigate to the appropriate URL in your browser.
From the navigation bar, click on Devices menu and select Device Manager.
Select the device and click on under the Actions column to display the Edit Metadata pop-up to manage the values for the metadata attributes you want to associate with the device.
Scroll-down to SDWAN_GENERIC.
Place your cursor on the Site Name you want to provide a custom name to and click on icon.
Enter the Site Name in the text field available and click on the Update button. For example, viptelaSN.
Site Name does not support the following characters
- forward-slash - /
- back-slash - \
- double-colon - ::
- double-quotes - "
- less-than - <
- greater-than - >
- pipe - |
- tab
- new-line
Click on Save button to save the custom Site Name.

If there is no site name available for the device from the device metadata, the collector will show None::Tenant Name under the Device Description column for that device. This is applicable only when the custom site grouping feature is enabled for the collector.

Since the cronjobs run every 1 hour, it can take at most 1 hour for the update to take effect.

Tenant Name Location in vManage

Execute the steps below to obtain the tenant name from vManage.

Click > Settings to open the settings page of your vManage.
The name next to field Organization Name is your tenant name. In the example below, the tenant name is SevOne.

Example

Add Location Names to Device Templates

The SevOne collector utilizes the Viptela API to retrieve device information that it uses to populate SevOne NMS, as well as generate Device and Object Groups for each tenant. By default, Viptela starts the assignment of edge devices with the number 100, and increments them for additional sites. Viewing an internal Viptela number as the device name is not very intuitive. To improve upon this, Viptela has a Location (system_location) field in the Device template that the customer must populate with a more user-friendly name. The following screenshots show how to review the template settings for a device within the Cisco vManage interface. Please follow steps to below.

Object Type Indicator Optimization

kbps = kilobits per second
m = minutes
mbps = megabits per second
ms = milliseconds
sec = seconds
# = number
% = percent
default = Indicator is reported by default but can be turned off using the required config flags.
mandatory = Indicator is always reported and cannot be turned off.
optional = Indicator is not reported by default but can be turned on using the required config flags.

Indicators	Units	Description	Indicator Type	Controlled by Flag
SD-WAN Interface Object
bw_down	mbps	Indicates the capacity of down link to transmit maximum amount of data per second.	optional	n/a
bw_up	mbps	Indicates the capacity of up link to transmit maximum amount of data per second.	mandatory	n/a
interface_speed	mbps	Indicates the rate of data flowing through the interface.	mandatory	n/a
oper_status	#	Indicates the operational state of the interface.	mandatory	n/a
rx_drops	#	Indicates total number of dropped packets through the interface.	mandatory	n/a
rx_errors	#	Indicates total number of error packets received through the interface.	mandatory	n/a
rx_kbps	kbps	Indicates total number of kilobits received in a second through the interface.	mandatory	n/a
tx_drops	#	Indicates total number of dropped transmitted packets through the interface.	mandatory	n/a
tx_errors	#	Indicates total number of transmitted error packets through the interface.	mandatory	n/a
tx_kbps	kbps	Indicates total number of transmitted kilobits in a second through the interface.	mandatory	n/a
availability	%	Indicates availability of an interface over a period of time.	mandatory	n/a
down_capacity_percent	%	Indicates percentage amount of utilized down-link capacity.	optional	collectorConfig.vendor.filtered_indicators_list
up_capacity_percentage	%	Indicates percentage amount of utilized up-link capacity.	optional	collectorConfig.vendor.filtered_indicators_list
tx_pps	#	Indicates total number of transmitted packets per second through the interface.	optional	collectorConfig.vendor.filtered_indicators_list
rx_pps	#	Indicates total number of received packets per second through the interface.	optional	collectorConfig.vendor.filtered_indicators_list
total_mbps	mpbs	Indicates total number of megabits transferred per second through the interface.	optional	collectorConfig.vendor.filtered_indicators_list
rx_octets	bytes	Indicates total number of bytes received through the interface.	default	collectorConfig.vendor.disable_collect_octets
tx_octets	bytes	Indicates total number of transmitted bytes through the interface.	default	collectorConfig.vendor.disable_collect_octets
rx_pkts	#	Indicates total number of packets received through the interface.	optional	collectorConfig.vendor.disable_collect_packets
tx_pkts	#	Indicates total number of transmitted packets through the interface.	optional	collectorConfig.vendor.disable_collect_packets
SD-WAN Interface Queue Object
tx_octets	bytes	Indicates total number of transmitted bytes at a given time.	default	collectorConfig.vendor.disable_collect_octets
queued_octets	bytes	Indicates number of queued bytes at a given time.	default	collectorConfig.vendor.disable_collect_octets
drop_octets	bytes	Indicates total number of dropped bytes at a given time from the queue.	default	collectorConfig.vendor.disable_collect_octets
tx_pkts	#	Indicates total number of transmitted packets at a given time.	optional	collectorConfig.vendor.disable_collect_packets
queued_pkts	#	Indicates number of queued packets at a given time.	optional	collectorConfig.vendor.disable_collect_packets
drop_pkts	#	Indicates total number of dropped packets at a given time from the queue.	optional	collectorConfig.vendor.disable_collect_packets
SD-WAN Tunnel Object
jitter	ms	Indicates variation in latency at given time.	mandatory	n/a
latency	ms	Indicates delay in transmitting data from one end to another end of tunnel.	mandatory	n/a
loss_percentage	%	Indicates packet loss in percentage with respect to total amount of packets sent.	mandatory	n/a
rx_utilization	%	Indicates percentage utilization of down link tunnel capacity.	mandatory	n/a
tx_utilization	%	Indicates percentage utilization of up link tunnel capacity. tx_utilization = (((tx_octets * 8 / 1000000) / (queryInterval * source_interface_speed)) * 100 where, queryInterval = collectorConfig.vendor.tunnel_stat.default_query_interval	mandatory	n/a
availability	%	Indicates availability of a BFD session over a period of time.	optional	collectorConfig.vendor.disable_bfd_sessions_stat
transitions	#	Indicates number of transitions of a BFD session over a period of time.	optional	collectorConfig.vendor.disable_bfd_sessions_stat
destination_interface_speed	mbps	Indicates the rate of data flowing through the destination interface.	optional	collectorConfig.vendor.filtered_indicators_list
loss	#	Indicates total number of packets lost at given time.	optional	collectorConfig.vendor.filtered_indicators_list
source_interface_speed	mbps	Indicates the rate of data flowing through the source interface.	optional	collectorConfig.vendor.filtered_indicators_list
total_utilization	%	Indicates total percentage utilization of tunnel capacity.	optional	collectorConfig.vendor.filtered_indicators_list
rx_octets	bytes	Indicates total number of received bytes by destination interface at particular time.	default	collectorConfig.vendor.disable_collect_octets
tx_octets	bytes	Indicates total number of transmitted bytes by source interface at particular time.	default	collectorConfig.vendor.disable_collect_octets
rx_pkts	#	Indicates total number of received packets by destination interface at particular time.	optional	collectorConfig.vendor.disable_collect_packets
tx_pkts	#	Indicates total number of transmitted packets by source interface at particular time.	optional	collectorConfig.vendor.disable_collect_packets
sla_state_<dynamic name>	#	One indicator per SLA class defined in vManage policy. Indicates the state of SLA class in use in the tunnel at the instant (it is sent only if collectorConfig.vendor.number_of_sla_indicators_to_create is set to true-1).	optional	collectorConfig.vendor.number_of_sla_indicators_to_create
sla_state_<dynamic name>Normal sla_state<dynamic name>Degraded sla_state<dynamic name>_No Viable	#	Three indicators (Normal, Degraded, and No Viable) per SLA class defined in vManage policy. Indicates the state of SLA class in use in the tunnel at the instant (it is sent only if collectorConfig.vendor.number_of_sla_indicators_to_create is set to true-3).	optional	collectorConfig.vendor.number_of_sla_indicators_to_create
SD-WAN Device Health Object
cpu_utilization	%	Indicates the percentage usage of device cpu.	mandatory	n/a
disk_utilization	%	Indicates the percentage usage of device disk.	mandatory	n/a
memory_utilization	%	Indicates the percentage usage of device memory.	mandatory	n/a
availability	%	Indicates availability of a device over a period of time.	mandatory	n/a
reachability	%	Indicates reachability of a device over a period of time.	mandatory	n/a
Self-monitoring Indicators
CPU usage user	sec	Indicates the usage by collector of device cpu.	optional	collectorConfig.vendor.filtered_indicators_list
CPU usage system	sec	Indicates the system usage by collector of device cpu.	optional	collectorConfig.vendor.filtered_indicators_list
Memory usage	bytes	Indicates the memory usage by the collector.	optional	collectorConfig.vendor.filtered_indicators_list
REST API Transport
Data Messages sent	#	Indicates the data messages sent by the collector using the REST API transport.	optional	collectorConfig.vendor.filtered_indicators_list
Messages sent	#	Indicates the messages sent by the collector using the REST API transport.	optional	collectorConfig.vendor.filtered_indicators_list