SD-WAN Viptela Collector Syntax & Semantics / Variable Mappings Guide

Edit online

About

Edit online

This document provides some useful details on the following.

Syntax & semantics for Device Groups / Devices / Objects
Variable mappings for the collectors

Syntax & Semantics

Edit online

for Device Groups / Devices

Edit online


Data Structure	Syntax	Semantics	Collection Method	Description
MSP as a device group	<MSP Name>::SDWAN	Name of the entity deploying SevOne SD-WAN solution. This can be an operator offering SD-WAN managed service or an Enterprise deploying SD-WAN.	MSP NAME: <msp_name> from tenant config file.	Example: device_groupAcmeMSP::SDWAN
Tenant or enterprise. This is sub-device-group and child of MSP device group	<tenant-name>	Name of enterprise who is the customer of MSP. For stand-alone enterprise, this can be a division or group name within the organization.	The collector gets it from the vManage organization field.	Example: device_group<organization-name> or SevOne ->where, SevOne is the organization name in vManage.
Site Name. This sub-device-group and child of tenant device-group	<site-name>(<site-id>)	This is a user-friendly name of the site.	This is the location field configured in vManage. If the location name is not configured then siteID configured in vManage is used as site. If vendor.custom_site_grouping is set to true, metadata needs to be updated manually for the device in namespace.attribute. For example, “SDWAN_GENERIC.Site Name	Example: If the API location.address = Cambridge, 123 Main Street…”, and site id is 403 Site Name = Cambridge(403) It is mandatory to have the site name in the Viptela system to create site in NMS.
Device Name	<device>::<tenant> If vendor.unique_hostname_per_msp is set to true, Tenant name is not appended to Device name in NMS.	Name of the device in NMS database.	Device name is the vEdge name configured in vManage.	Example: nsg10::SevOne

for Objects

Edit online

There are four types of objects created for SD-WAN.


Data Structure Object Type	Syntax	Semantics**	Collection Method	Description
device-health	type = sdwan::device-health name = device-health object description = "Device health summary"	Object for collecting device health related indicators.	One object is created per device.	Example: Indicators such CPU, Memory, etc. are collected for this object.
device-interface	type = sdwan::device-interface name = <ifname> object description = <interface-type>interface-type::<interface name>::ifindex::<ifIndex >	LAN & WAN port	API	Example: Object name = eth0 Indicators such as rx, tx are under this object.
tunnel/tunnel_type	type = sdwan::tunnel/sdwan::<type> name= <src-hostname>::<src-ifname> -> <dst-hostname>::<dst-ifname>	Tunnel	API	Example: Object type = sdwan::tunnel/sdwan::mplssdwan::tunnel/sdwan::internet Object name = vbranch1::ge0/1 -> vbranch2::ge0/1
device-interface-queue	type = sdwan::device-interface-queue name = <ifname>::<q-num>	QoS transmits Queue Objects per Interface. There are a maximum of 4 queues per interface.	API	Example: Object Type = sdwan::device-interface-queue Object name =ge0/1::q1eth0::q2

Variable Mappings

Edit online

Variable mappings (between SD-WAN 2.8 & SD-WAN >= 2.9)

Edit online

The variables in SD-WAN 2.8 column are listed in alphabetical order.


SD-WAN 2.8	>= SD-WAN 2.9
alarm_runner_interval	collectorConfig.vendor.alarm_stat.schedule
collect_provider_tenant_stats	collectorConfig.vendor.enable_provider_tenant_stats
device_summary_runner_interval	collectorConfig.vendor.device_health.schedule
distribution_peers_list	collectorConfig.nms.api.distribution_peer_list
dnc_flows_port	flowAugmentorConfig.sender.port
dnc_ip_address	flowAugmentorConfig.sender.ip
dry_run	collectorConfig.vendor.tunnel_stat.disable_dry_run
enable_bfd_sessions_stat	collectorConfig.vendor.disable_bfd_sessions_stat
enable_custom_site_grouping	collectorConfig.vendor.custom_site_grouping
enable_lan_interface_queue	collectorConfig.vendor.interface_queue_stat.disable_lan_interface_queue
enable_lan_interface_stat	collectorConfig.vendor.interface_stat.disable_lan_interface_stats
enable_octet_indicators	collectorConfig.vendor.disable_collect_octets
enable_packet_indicators	collectorConfig.vendor.disable_collect_packets
enable_sla_class_information	collectorConfig.vendor.number_of_sla_indicators_to_create
enable_sla_metadata_runner	collectorConfig.vendor.metadata.disable_sla_constraints
enable_wan_interface_queue	collectorConfig.vendor.interface_queue_stat.disable_wan_interface_queue
enable_wan_interface_stat	collectorConfig.vendor.interface_stat.disable_wan_interface_stats
event_runner_interval	collectorConfig.vendor.approute_event.schedule
filtered_indicator_list	collectorConfig.vendor.filtered_indicators_list
flow_enabled	flowAugmentorService.enabled (by default, false)
flow_object_mapper_interval	collectorConfig.vendor.flow.schedule
flowaugmenter_listener_buffer	flowAugmentorConfig.listener.listener ( default 1000 )
flowaugmenter_log_level	flowAugmentorConfig.log.level
flowaugmenter_receivers	flowAugmentorConfig.workers.receivers ( default 40 )
flowaugmenter_receiving_port	flowAugmentorService.receiverPort: <enter number> ( default: 9992 )
flowaugmenter_sender_buffer	flowAugmentorConfig
flowaugmenter_senders	flowAugmentorConfig.workers.senders ( default 5 )
installer_interval	collectorConfig.vendor.installer.schedule
interface_queue_runner_interval	collectorConfig.vendor.interface_queue_stat.schedule
interface_stat_runner_interval	collectorConfig.vendor.interface_stat.schedule
log_severity	collectorConfig.log.level
metadata_runner_interval	collectorConfig.vendor.metadata.schedule
msp_name	collectorConfig.msp_name
qos_scheduler_policy_refresh_interval	collectorConfig.vendor.interface_queue_stat.qos_scheduler_policy_refresh_interval
sender_map ip port sources	flowAugmentorConfig.destinations flowAugmentorConfig.destinations.ip flowAugmentorConfig.destinations.port flowAugmentorConfig.destinations.sources
sevone_api_config_port	collectorConfig.nms.api.port
sevone_api_host	collectorConfig.nms.api.host
sevone_api_ssl_verify	collectorConfig.nms.api.insecure_tls_connection
sevone_api_password	collectorService.secrets.nms.api.password (base64-encoded)
sevone_api_read_timeout	collectorConfig.nms.api.timeout
sevone_api_user	collectorService.secrets.nms.api.username (base64-encoded)
tenant_name	collectorConfig.tenant_name
tunnel_description_runner_interval	collectorConfig.vendor.object_description.schedule
tunnel_stat_runner_interval	collectorConfig.vendor.tunnel_stat.schedule
unique_hostname_per_msp	collectorConfig.vendor.unique_hostname_per_msp
update_vmanage_lat_long_value	collectorConfig.vendor.update_vmanage_lat_long_value
vmanage_host	collectorConfig.vendor.vamanage_api.url
vmanage_password	collectorConfig.vendor.vmanage_api.password (base64-encoded)
vmanage_timeout	collectorConfig.vendor.vmanage_api.timeout
vmanage_user	collectorConfig.vendor.vmanage_api.username (base64-encoded)
vpn_id_filter	collectorConfig.vendor.vpn_id_filter

Variables in SD-WAN 2.9 or higher (do not apply in SD-WAN 2.8)

Edit online

The variables in >= SD-WAN 2.9 column are listed in alphabetical order.


SD-WAN 2.8	>= SD-WAN 2.9
n/a	collectorConfig.agent.exclude
n/a	collectorConfig.agent.include
n/a	collectorConfig.agent.long_run_warning
n/a	collectorConfig.cache.redis_cluster
n/a	collectorConfig.cache.redis_db
n/a	collectorConfig.cache.redis_host
n/a	collectorConfig.nms.api.v2_api_key
n/a	collectorConfig.nms.api.v3_api_key
n/a	collectorConfig.rabbitmq.host
n/a	collectorConfig.rabbitmq.password
n/a	collectorConfig.rabbitmq.port
n/a	collectorConfig.rabbitmq.username
n/a	collectorConfig.vendor.alarm_stat.default_query_interval
n/a	collectorConfig.vendor.alarm_stat.query_count_per_request
n/a	collectorConfig.vendor.analytics_api.bind_address
n/a	collectorConfig.vendor.analytics_api.listen_port
n/a	collectorConfig.vendor.approute_event.default_query_interval
n/a	collectorConfig.vendor.approute_event.query_count_per_request
n/a	collectorConfig.vendor.collect_octets
n/a	collectorConfig.vendor.collect_packets
n/a	collectorConfig.vendor.custom_site_grouping
n/a	collectorConfig.vendor.device_description.default_query_interval
n/a	collectorConfig.vendor.device_description.query_count_per_request
n/a	collectorConfig.vendor.device_filter_regexes
n/a	collectorConfig.vendor.director_api.timeout
n/a	collectorConfig.vendor.flow.disable_interface_flow_objects_mapping
n/a	collectorConfig.vendor.flow.disable_interface_name_update
n/a	collectorConfig.vendor.flow.disable_interface_speed_update
n/a	collectorConfig.vendor.flow.disable_map_interface_objects
n/a	collectorConfig.vendor.flow.disable_map_tunnel_objects
n/a	collectorConfig.vendor.flow.disable_tunnel_flow_objects_mapping
n/a	collectorConfig.vendor.flow.tunnel_filter_field
n/a	collectorConfig.vendor.flow.tunnel_filter_view
n/a	collectorConfig.vendor.installer.query_count_per_request
n/a	collectorConfig.vendor.interface_stat.default_query_interval
n/a	collectorConfig.vendor.interface_stat.query_count_per_request
n/a	collectorConfig.vendor.next_hop_table.query_count_per_request
n/a	collectorConfig.vendor.next_hop_table.redis_ttl
n/a	collectorConfig.vendor.next_hop_table.schedule
n/a	collectorConfig.vendor.object_description.default_query_interval
n/a	collectorConfig.vendor.object_description.query_count_per_request
n/a	collectorConfig.vendor.policy_parser.local_cache_invalidation_channel
n/a	collectorConfig.vendor.policy_parser.nbar2_csv_path
n/a	collectorConfig.vendor.policy_parser.query_count_per_request
n/a	collectorConfig.vendor.policy_parser.schedule
n/a	collectorConfig.vendor.tunnel_stat.default_query_interval
n/a	collectorConfig.vendor.tunnel_stat.query_count_per_request
n/a	collectorConfig.vendor.vmanage_api.insecure_tls_connection
n/a	collectorConfig.vendor.vmanage_api.mimic_record
n/a	collectorService.secrets.nms.ssh.username
n/a	collectorService.secrets.nms.ssh.password

Variables in SD-WAN 2.8 (do not apply in SD-WAN >= 2.9)

Edit online

The variables in SD-WAN 2.8 column are listed in alphabetical order. For SD-WAN >= 2.9, the variables in SD-WAN 2.8 column are defunct.


SD-WAN 2.8	>= SD-WAN 2.9
alternative_device_health_api	n/a
bandwidth_calculation_runner_interval	n/a
cache_server_password	n/a
cache_server_port_for_collector	n/a
collector_install_mode	n/a
collector_release_tag	n/a
collector_vm_password	n/a
collector_vm_username	n/a
custom_site_group_runner_interval	n/a
flow_instance_count	n/a
data_count_per_request	n/a This is available for each agent. For example, collectorConfig.vendor.alarm_stat.query_count_per_request
distribute_on_all_peers	n/a
dry_run	n/a
dry_run_interval	n/a
enable_alarm_runner	n/a
enable_bandwidth_calculation_runner	n/a
enable_custom_site_group_runner	n/a
enable_device_description_update_runner	n/a
enable_device_summary_runner	n/a
enable_event_runner	n/a
enable_flow_interface_rename_runner	n/a
enable_flow_interface_speed_runner	n/a
enable_flow_object_mapper	n/a
enable_flow_rate_logging	n/a
enable_flow_view_creation	n/a
enable_interface_queue_runner	n/a
enable_interface_runner	n/a
enable_interface_stat_runner	n/a
enable_metadata_runner	n/a
enable_reboot_runner	n/a
enable_sla_metadata_runner	n/a
enable_transport_type_field	n/a
enable_tunnel_description_runner	n/a
enable_tunnel_metadata_runner	n/a
enable_tunnel_runner	n/a
enable_tunnel_stat_runner	n/a
flominer_receiver_read_buffer	n/a
flominer_release_tag	n/a
flow_instance_count	n/a
flow_interface_rename_runner_interval	n/a
flow_interface_speed_runner_interval	n/a
flowaugmenter_install_mode	n/a
flowaugmenter_upgrade	n/a
flowaugmenter_vm_ip	n/a
flowaugmenter_vm_password	n/a
flowaugmenter_vm_username	n/a
nginx_version	n/a
poller_threads	n/a
redis_version	n/a
self_monitoring	n/a
sevone_api_collection_port	n/a
sevone_api_collection_version	n/a
sevone_api_config_version	n/a
sevone_api_security	n/a
sevone_soap_password	n/a
sevone_soap_username	n/a
spoof_packets	n/a
template_send_frequency	n/a
time_to_retain_data	n/a This is available for each agent. For example, vendor.alarm_stat.default_query_interval
tunnel_description_runner_interval	n/a
tunnel_metadata_runner_interval	n/a
tunnel_runner_interval	n/a
vmanage_port	n/a
vmanage_protocol	n/a