SD-WAN Variables & Report Linking Usage 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
Variables
Prerequisites
Applicable Variables
Scenarios

About

This document provides guidelines on how different reports can be linked and variables that can be applied.

Variables

Report A -> Report B

Variables	Description / Usage
Device Groups	As per SD-WAN model, Tenants and Sites are saved as Device Groups. If you want to link Report A to Report B, by Tenant name or Site name, Report B must have the Device Groups variable.
Devices	As per SD-WAN model, devices are saved as Devices. If devices are selected in the Report A and would like to link the report on Device Name then Report B must have the Devices variable.
Object Groups	Report must have this variable as it takes the value from the variable change and applies it to the report.
Objects	As per SD-WAN model, Tunnel and Interfaces are saved as Objects. If you want to link Report A to Report B, by Tunnel name or Interface name, Report B must have the Objects variable.
Flow View	Report must have this variable as it takes the value from the variable change and applies it to the report.
Flow Direction	Report must have this variable as it takes the value from the variable change and applies it to the report.
Indicators	As per SD-WAN model, indicators are saved as Indicators. If Objects are selected in Report A and you want to link the report on Object Name to see the indicators for the respective Objects then Report B must have the Indicators variable.

Example: Report Linking Requirement

Purpose: To propagate data variable query from Report A to Report B, link the reports. For example, Report A > Link To > Report B.

Solution: If a report is the child (linked) report, for example, Report B, then variables mentioned under Variables column, in tables below, are mandatory.

Prerequisites

Prior to executing the scenarios defined below, the following reports must first be created.

Tenants
Geo Topology
Key Performance Indicators (KPI)
SD-WAN Alarm
SD-WAN Flow
Performance Metrics
Alerts Summary (must have Device Groups variable)
Alerts Summary (must have Objects variable)
Network Topology
Alert Details (must have Device Groups variable)
Alert Details (must have Objects variable)
Interface Queue Widget
Device Summary

Applicable Variables

Widgets / Variables	Device Group	Device	Object Group	Object	Time zone	Time span	Flow View	Flow Direction	Indicators
SD-WAN Alarm (Deprecated)	Yes	Yes		Yes	Yes	Yes
KPI (Deprecated)	Yes		Yes		Yes	Yes			Yes
Network Topology	Yes				Yes	Yes
Geo Topology	Yes				Yes	Yes
Tenants (Deprecated)					Yes	Yes
SD-WAN Flow (Deprecated)	Yes		Yes	Yes	Yes	Yes	Yes	Yes
Device Summary (Deprecated)	Yes	Yes			Yes	Yes
Interface Queue Widget (Deprecated)	Yes				Yes	Yes
Site-to-Site Traffic	Yes				Yes	Yes

Scenarios

Tenants Report

The Tenants widget shows the high-level of SD-WAN Tenant with Alerts - must be admin.

Variables	Column Name	Reports to Link
	Tenant Name	Geo Topology, Network topology, Interface Queue Widget, Site-to-Site Traffic SD-WAN Alarm, KPI, Device Summary, SD-WAN Flow (must have Device Groups variable)
	Total no of sites
	Critical Events
	Error Events
	Warning Events
	Info Events

Geo Topology Report

The Geo Topology widget displays user-provided geo-coordinates. The dashboard automatically creates an interactive topology map with performance-based visual analysis and overlay link information, including source and destination data.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Groups > Single selection > Choose tenants	Site	SD-WAN Alarm, Alerts Summary, Alert Details, KPI, Device Summary, SD-WAN Flow (must have Device Groups variable) Interface Queue Widget
	Tunnel NOTE: Available in Geo visualization only.	Performance Metrics (must have Indicators variable) Alerts Summary, Alert Details, SD-WAN Alarm (must have Objects variable) SD-WAN Flow (must have Objects variable) KPI, Performance Metrics (must have Indicators variable)
	Device	Alerts Summary, Alert Details, SD-WAN Alarm (must have Devices variable) Device Summary (must have Devices variable)

KPI Report

The Key Performance Indicators (KPI) widget obtains an aggregated score, chart, and the trend line for the selected Tenant(s), Devices, Link, Tunnels, and Indicators in a selected time frame. The score range is 1-10.

Variables	Column Name	Reports to Link (Report Linking is only supported from Table visualization)
Edit Report > Add Variables > Device Groups > Single selection > Choose SD-WAN Device Groups Edit Report > Add Variables > Indicators > Multiple selection > Choose SD-WAN Device Groups Edit Report > Add Variables > Object Groups > Single selection > Choose SD-WAN Object Groups	Tunnel Name	SD-WAN Alarm, Alerts Summary, Alert Details (must have Objects variable) Performance Metrics (must have Indicators variable) SD-WAN Flow (must have Objects variable)

SD-WAN Alarm Report

The SD-WAN Alarm widget displays the event and alarm details based on the Alert Type chosen.

Variables	Column Name	Reports to Link
Edit Report > Add Variables> Device Groups > Single selection > Choose SD-WAN Device Groups Edit Report > Add Variables > Devices > Multiple selection > Choose SD-WAN Devices Edit Report > Add Variables > Objects > Multiple selection > Choose SD-WAN Objects	Tenant Name	Geo, Interface Queue, Network, Site-to-Site Traffic KPI, Device Summary, Alert Details, Alert Summary, SD-WAN Flow (must have Device Groups variable)
	Site Name	Device Summary, KPI, Alert Details, Alert Summary, SD-WAN Flow (must have Device Groups variable) Interface Queue, Site-to-Site Traffic
	Device Name	Alerts Summary, Alert Details (must have Devices variable) Device Summary (must have Devices variable)
	Tunnel	Alerts Summary, Alert Details (must have Objects variable) Performance Metrics (must have Indicators variable) SD-WAN Flow (must have Objects variable) KPI, Performance Metrics (must have Indicators variable)

Performance Metrics Report

The Performance Metrics widget displays the aggregated and non-aggregated data for Device Groups/Object Groups/Objects. This is a native widget in SevOne Data Insight.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Indicators > Multiple selection > Choose SD-WAN Device Groups

Alerts Summary Report

The Alerts Summary widget enables you to view an alert summary for the resources that you specify. This is a native widget in SevOne Data Insight.

Must have Device Groups variable

Variables	Column Name	Reports to Link
Edit Report >Add Variables > Device Groups > Single selection > Choose SD-WAN Device Groups

Must have Devices variable

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Devices > Multiple selection > Choose SD-WAN Devices

Must have Objects variable

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Objects > Multiple selection > Choose SD-WAN Objects

Network Topology Report

The Network Topology widget is useful for network operations and engineering to provide a network view of the SD-WAN. It also helps in troubleshooting.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Group > Single selection > Choose SD-WAN Device Groups	Site	Device Summary, KPI, Alert Details, Alert Summary, SD-WAN Flow (must have Device Groups variable) Interface Queue
	Device	Device Summary, SD-WAN Alarm, Alerts Summary, Alert Details (must have Devices variable)
	Interface	Alerts Summary, Alert Details (must have Objects variable)
	Tunnel	Performance Metrics, KPI (must have Indicators variable) SD-WAN Alarm, Alerts Summary, Alert Details (must have Objects variable) SD-WAN Flow (must have Objects variable)

Alert Details Report

The Alert Details widget enables you to view detailed alert information for the resources that you specify. This is a native widget in SevOne Data Insight.

Must have Device Groups variable

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Groups > Single selection > Choose SD-WAN Device Groups

Must have Devices variable

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Devices > Multiple selection > Choose SD-WAN Devices

Must have Objects variable

Variables	Column Name	Reports to Link
Edit Report > Add Variables> Objects > Single selection > Choose SD-WAN Objects

Interface Queue Report

The Interface Queue widget displays the interface CoS queue statistics.

Create a Performance Metrics report with Indicators variable. This will allow you to link queues, indicators, or interface to this report to view the historical data.
Besides the standard Title settings, this visualization also has one threshold settings tab which can be used to set thresholds for various queue statistics indicators. The value which is greater than the set threshold would be shown in Red.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Group > Single selection > Choose SD-WAN Device Groups	queues	Performance Metrics (must have Indicators variable)
	indicators
	interface

Device Summary Report

The Device Summary widget provides details on the device (edge routers) such as CPU, memory, temperature, fan status, software version, last reboot, etc.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Group > Single selection > Choose SD-WAN Device Groups Edit Report > Add Variables > Device > Single selection > Choose SD-WAN Devices	Device	Alerts Summary, Alert Details, SD-WAN Alarm (must have Devices variable)
	Tunnel	Alerts Summary, Alert Details, SD-WAN Alarm (must have Objects variable) Performance Metrics, KPI (must have Indicators variable) SD-WAN Flow (must have Objects variable)

SD-WAN Flow Report

SD-WAN Flow widget displays the flows based on tunnels.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Group > Single selection > Choose SD-WAN Device Groups Edit Report > Add Variables > Object Group > Single selection > Choose SD-WAN Object Groups Edit Report > Add Variables > Objects > Multiple selection > Choose SD-WAN Objects(Tunnel Object)	Tunnel	Alerts Summary, Alert Details, SD-WAN Alarm (must have Objects variable) Performance Metrics, KPI (must have Indicators variable)

Site-to-Site Traffic Report

The Site-to-Site Traffic widget is helpful to view the traffic (Utilization / Jitter / Latency / Loss percentage) going between two sites based on transport types. It also shows the Alerts, Availability and Reachability of the selected sites. This widget provides the drill down view of tunnel stats when clicked on the link type container.

Variables	Column Name	Reports to Link
Edit Report > Add Variables > Device Groups > Single selection > Choose Device Groups	Tunnel	Alert Summary, Alert Details, SD-WAN Alarm (must have Objects variable) Performance Metrics, KPI (must have Indicators variable) SD-WAN Flow (must have Objects variable)