SD-WAN Nokia-Nuage Collector Syntax & Semantics / Variable Mappings 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
Syntax and Semantics
- for Device Groups / Devices
- for Objects

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_group NOKIA::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-health name = device-health object 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-interface name = nsportName.VlanId object description = interface-type::<interface name>::ifindex::<ifindex>	WAN port Collected 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: Object Name: WAN-1.0 Object Description: interface-type::WAN-1.0::ifindex::10000
Device Tunnel	type = sdwan::tunnel/sdwan::<type> sdwan::tunnel/sdwan::intranet or sdwan::tunnel/sdwan::internet name= <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: Object type = sdwan::tunnel/sdwan::mpls sdwan::tunnel/sdwan::internet Nuage2-Boston::WAN-1.0->Nuage2-NewYork::WAN-1.0::NPM-01
device-interface-queue	type = sdwan::device-interface-queue name= [nsport].[vlanId]-<q-name>	Queue names are q1,q2,q3,q4,q10 It 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: Object Type = sdwan::device-interface-queue WAN-1.0::q4