SD-WAN Nokia-Nuage Collector Syntax & Semantics / Variable Mappings Guide
About
This document provides some useful details on the following.
- Syntax & semantics for Device Groups / Devices / Objects
- Variable mappings for the collectors
Syntax and Semantics
for Device Groups / Devices
| 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:<name> from tenant config file of deployment. | Example: device_groupNOKIA::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. | Tenant name:<name> from the tenant configuration file. This must be the same as the enterprise name in VSD. | Example: device_group<enterprise-name> or SevOne → where SevOne is the enterprise name in VSD. |
| Site Name. This is sub-device-group and child of tenant device-group | <deviceName>or<device["locality"]> | If the locality field in the device API call response is present then siteName is locality else it is the device name. | From VSD, location API.The field is location.address where the first comma-delimited word is taken as the site name. If it is blank then device name is used as the site name. | Example: If the API location.address for device NSG1="Cambridge, 123 Main Street…”, then the site-name = Cambridge.If the above info is not populated then the site name = NSG1. |
| Device Name | <device>::<tenant>If vendor.unique_hostname_per_msp is set to true, Tenant name will not be appended to Device name in NMS. | Name of the device in NMS database. | Device name is collected from VSD using nsgateway API. | Example: nsg10::SevOne |
for Objects
There are four types of objects created for SD-WAN.
| Data Structure Object Type | Syntax | Semantics | Collection Method | Description |
|---|---|---|---|---|
| Device Health | type = sdwan::device-healthname = device-healthobject description = "Device health summary" | Object for collecting device health related indicators.Collected from ES index: nuage_sysmon | One object is created per device. | Example: Indicators such CPU, Memory, etc. are collected for this object. |
| Device Interface | type = sdwan::device-interfacename = nsportName.VlanIdobject description = interface-type::<interface name>::ifindex::<ifindex> | WAN portCollected from ES index: nuage_vlan | VSD API using nsport name and vlan Id to create the object.ifIndex is calculated based on the Port Number and Vlan ID, using synthetic formula inside the collector.ifIndex is not obtained from the VSD. | Example:
|
| Device Tunnel | type = sdwan::tunnel/sdwan::<type>sdwan::tunnel/sdwan::intranetorsdwan::tunnel/sdwan::internetname= <srvDevice>::<srcInterfaceName> -> <DstDevice>::<DstInterfaceName>::<NPMGroupName> | There are 2 subtypes of tunnels - internet and intranet. If it is not internet, then it is considered under intranet.Collected from ES index: nuage_dpi_probestats | VSD API using NSGName and nsport name.vlanID. | Example:
|
| device-interface-queue | type = sdwan::device-interface-queuename= [nsport].[vlanId]-<q-name> | Queue names are q1,q2,q3,q4,q10It can be custom as well which can be changed from the main.yaml file during deployment.Data from ES index: nuage_vport_qos | VSD API using nsport name and vlan Id to create the object.Elasticsearch to obtain the queue names. | Example:
|