VCF SD-WAN Insight: Metrics Reference
Version: 2026.1.1.0
This page is the complete attribute reference for the Management Pack: every identifier, property and metric the adapter defines, per object kind, with its key, label, unit, meaning and the vendor field it is read from. Nothing else in the documentation repeats this list; the other pages describe behaviour and refer here for the keys.
All keys are shared by both vendors. A vendor that has no source for a key emits no data point at all rather than a zero, so a missing value never looks like a healthy measurement. The columns Cisco source and Fortinet source name the field each vendor writes into the key; — means the vendor does not collect it.
VMware Aria Operations displays a grouped attribute as group|key. Attributes listed without a group prefix are defined directly on the object. Identifiers form the unique key of an object and are what lets an object survive a rename in the management platform.
No instanced groups are used anywhere - every repeating entity is a first class object kind.
Contents
| Object kind | Key | Page section |
|---|---|---|
| SD-WAN Location | SDWANLocation | SD-WAN Location |
| SD-WAN Device | SDWANDevice | SD-WAN Device |
| SD-WAN Node | SDWANNode | SD-WAN Node |
| SD-WAN Link | SDWANLink | SD-WAN Link |
Adapter instance parameters are described in Deployment.
SD-WAN Location (SDWANLocation)
One object per site. Cisco only: SD-WAN Manager publishes no site inventory, so the object is derived from the site-id / site-name pair carried by every record of /dataservice/device. The Fortinet path has no site identifier in /dvmdb/device, so a Fortinet instance never creates an object of this kind, and its nodes hang directly under the controller.
A Location is a parent of every SD-WAN Node of the site and a sibling parent next to the SD-WAN Device, so an operator can drill down either Site -> Node or Device -> Node.
| Data Name | Type | Key | Unit | Description | Cisco source | Fortinet source |
|---|---|---|---|---|---|---|
UUID | Identifier | uuid | — | Object key of the site, derived from the site identifier | derived from site-id | — |
Identity > Name | Property (key) | identity|name | — | Name of the site: the site-name, falling back to Site <site-id>. The identical string is written to location on every WAN Link of the site | site-name of /dataservice/device | — |
Identity > Site ID | Property (key) | identity|site_id | — | Identifier of the site | site-id of /dataservice/device | — |
Identity > EndPoint | Property | identity|endpoint | — | Full product name identifying the monitored source: Cisco Catalyst SD-WAN or Fortinet SD-WAN | constant | — |
Availability > Availability | Metric (KPI) | availability|availability | — | 1 while at least one reporting edge device of the site is available, 0 only when all reporting edge devices are down. A site is a set of HA pairs, so one dead router does not make the site unavailable. Emitted only when at least one device reported a reachability | derived from the node reachability | — |
Availability > Availability | Metric (KPI) | availability|availability_pct | percent | The same state scaled to 0 / 100, the column the Location reports render. The declared label is Availability and Aria Operations appends (%) from the unit | derived from availability | — |
Inventory > Node Count | Metric | inventory|node_count | connections | Number of edge devices the site contains. A controller that belongs to the same site is not counted | counted from /dataservice/device | — |
Inventory > Node Availability | Metric (KPI) | inventory|node_availability_pct | percent | True average availability of the reporting edge devices: 100 * nodes_up / nodes_total_reporting, rounded to two decimals. A site with two routers where one is down reports 50 while its binary availability stays 1. Emitted only when at least one device reported a reachability | derived from the node reachability | — |
Inventory > Nodes Up | Metric | inventory|nodes_up | connections | Number of reporting edge devices that are available. Emitted even when zero, because a count is a fact | derived from the node reachability | — |
Inventory > Nodes Down | Metric | inventory|nodes_down | connections | Number of reporting edge devices that are not available | derived from the node reachability | — |
Inventory > Nodes Reporting | Metric | inventory|nodes_total_reporting | connections | Number of edge devices that actually reported a reachability, i.e. the denominator of node_availability_pct. Without it nodes_up / nodes_down cannot distinguish "1 of 1 down" from "1 of 2 reporting, the other unknown" | derived from the node reachability | — |
Relationships: parent of every SD-WAN Node of the site; child of the adapter instance.
SD-WAN Device (SDWANDevice)
Management and control plane appliance of the overlay. Cisco: the SD-WAN Manager, the vSmart controllers and the vBond validators, distinguished by role. Fortinet: the FortiManager.
| Data Name | Type | Key | Unit | Description | Cisco source | Fortinet source |
|---|---|---|---|---|---|---|
UUID | Identifier | uuid | — | Unique identifier of the appliance. Fortinet: FortiManager serial number, falling back to the host name | device UUID | Serial Number / host name |
Identity > Name | Property (key) | identity|name | — | Host name of the appliance | host-name | FortiManager host name |
Identity > Management IP | Property | identity|system_ip | — | System IP address of the appliance | system-ip | configured FortiManager address |
Identity > Device ID | Property | identity|device_id | — | Identifier of the device inside the management platform | deviceId | device identifier |
Identity > UUID | Property | identity|uuid | — | Unique identifier of the appliance | device UUID | serial number |
Identity > Serial Number | Property | identity|serial_number | — | Board serial number | board-serial | Serial Number |
Identity > Site ID | Property | identity|site_id | — | Identifier of the site the appliance belongs to | site-id | — |
Identity > Site Name | Property | identity|site_name | — | Human readable site label | site-name | — |
Identity > EndPoint | Property | identity|endpoint | — | Full product name identifying the monitored source | constant | constant |
Identity > Description | Property | identity|description | — | Free text description published by the platform | description | — |
Platform > Role | Property (key) | platform|role | — | Role in the overlay: vmanage, vsmart or vbond for Cisco; the FortiManager HA role for Fortinet | device-type / personality | HA status |
Platform > Model | Property | platform|model | — | Device model | device-model | Platform Full Name |
Platform > Software Version | Property | platform|software_version | — | Installed software version | version | Version |
Platform > Operating System | Property | platform|operating_system | — | Operating system of the appliance | platform | Platform Type |
Platform > Device Type | Property | platform|device_type | — | Device type as reported by the platform | device-type | device type |
Platform > Device Vendor | Property | platform|device_vendor | — | Hardware or platform vendor | device-vendor | vendor |
Platform > CPU Count | Property | platform|cpu_count | — | Number of CPU cores available to the appliance | cpu-load source record | CPU.Count |
Status > Reachability | Property (key) | status|reachability | — | reachable / unreachable as seen by the management platform. Fortinet: reachable when the FortiManager answered the system status RPC, else unreachable | reachability | system status RPC |
Status > Admin Status | Property | status|admin_status | — | Administrative status. Cisco writes it for interfaces only, a device exposes no administrative enable state | admin-status | — |
Status > Operational Status | Property | status|operational_status | — | Up / Down operational state | reachability normalised | system status RPC normalised |
Status > Device State | Property | status|device_state | — | Device state reported by the platform | device-state | cluster synchronisation state |
Status > Device State Description | Property | status|device_state_description | — | Human readable explanation of the device state | device-state-description | composed from device and config status |
Status > Certificate Validity | Property | status|certificate_validity | — | Validity of the appliance certificate | certificate endpoint | — |
SLA Level | Property | sla_level | — | SLA level assigned to the object: 1 or 2. Top level so a custom group rule can match it. Not part of the object identity | from sla_default_level / sla_overrides | from sla_default_level / sla_overrides |
SLA Availability Threshold | Property | sla_availability_threshold | — | Minimum availability the level implies: (1 - hours / (window days * 24)) * 100, two decimals. Defaults 98.89 (level 1) / 99.44 (level 2) | derived | derived |
SLA Allowed Downtime (hours) | Property | sla_allowed_downtime_hours | — | Unavailability budget of the level, in hours. Defaults 8 / 4 over a 30 day window | derived | derived |
Availability > Availability | Metric (KPI) | availability|availability | — | 1 when the appliance is reachable, else 0 | reachability | system status RPC |
Availability > Availability | Metric (KPI) | availability|availability_pct | percent | The same state scaled to 0 / 100; the column the device reports render | derived | derived |
System Resources > CPU Usage | Metric (KPI) | system|cpu_usage | percent | CPU usage | /dataservice/device/system/status | CPU.Used (/cli/global/system/performance) |
System Resources > Memory Usage | Metric (KPI) | system|memory_usage | percent | Used memory as a share of total memory | /dataservice/device/system/status | Memory.Used Percentage, fallback used/total |
System Resources > Memory Total | Metric | system|memory_total | byte | Total memory of the appliance | /dataservice/device/system/status | Memory.Total |
System Resources > Disk Usage | Metric | system|disk_usage | percent | Used disk as a share of total disk size | /dataservice/device/system/status | Hard Disk.Used Percentage |
System Resources > Uptime | Metric | system|uptime | seconds | Time since the appliance last booted | /dataservice/device/system/status | Uptime |
Control Plane > Control Connections | Metric (KPI) | control_plane|control_connections | connections | Established control plane connections. Fortinet: count of managed FortiGate with the connection up | /dataservice/device/control/connections | /dvmdb/device with conn_status = up |
Control Plane > OMP Peers | Metric | control_plane|omp_peers | — | Overlay Management Protocol peers | /dataservice/device/counters | — |
Control Plane > Connected Managers | Metric | control_plane|connected_managers | — | Connected management instances / managed domains | connected-vManage list | count of /dvmdb/adom |
Control Plane > Connected Devices | Metric (KPI) | control_plane|connected_devices | connections | Managed devices currently connected | connected device list | /dvmdb/device with conn_status = up |
Control Plane > Disconnected Devices | Metric | control_plane|disconnected_devices | connections | Managed devices not connected | connected device list | /dvmdb/device with conn_status != up |
Control Plane > Total Devices | Metric | control_plane|total_devices | connections | Managed devices in the inventory | device inventory | /dvmdb/device |
Health > Certificate Days To Expiry | Metric | health|certificate_days_to_expiry | days | Whole days left until the appliance certificate expires | certificate endpoint | — |
Health > Active Alarm Count | Metric | health|active_alarm_count | — | Active alarms attributed to this appliance. Fortinet: managed devices not connected | /dataservice/device/alarms | /dvmdb/device with conn_status != up |
Relationships: child of the adapter instance; parent of every SD-WAN Node when it is the API entry point; optional child of a VMWARE / VirtualMachine.
SD-WAN Node (SDWANNode)
Edge router at a customer site. Cisco: vEdge (Viptela OS) or cEdge (IOS-XE SD-WAN); the manager reports role = vedge for both. Fortinet: a FortiGate (hub or spoke).
| Data Name | Type | Key | Unit | Description | Cisco source | Fortinet source |
|---|---|---|---|---|---|---|
UUID | Identifier | uuid | — | Unique identifier of the router. Fortinet: FortiGate serial number, falling back to the device name | device UUID | sn / name |
Management IP | Property | management_ip | — | System IP of the router. Must stay ungrouped: the VCF IPAM Insight (phpIPAM) Management Pack matches its IP Address objects with the anchored pattern ^management_ip$, and grouping the property would rename it to group|management_ip and silently break that relation. Applies to both vendors | system-ip | /dvmdb/device.ip |
Identity > Name | Property (key) | identity|name | — | Host name of the router | host-name | FortiGate host name |
Identity > Device ID | Property | identity|device_id | — | Identifier of the device inside the management platform | deviceId | device identifier |
Identity > UUID | Property | identity|uuid | — | Unique identifier of the router | device UUID | serial number |
Identity > Serial Number | Property | identity|serial_number | — | Board serial number | board-serial | sn |
Identity > Site ID | Property (key) | identity|site_id | — | Identifier of the site the router is installed at | site-id | — |
Identity > Site Name | Property | identity|site_name | — | Human readable site label | site-name | — |
Identity > EndPoint | Property | identity|endpoint | — | Full product name identifying the monitored source | constant | constant |
Identity > Description | Property | identity|description | — | Free text description published by the platform | description | — |
Platform > Role | Property | platform|role | — | Role in the overlay. Cisco: typically vedge; Fortinet: the HA role (master, slave, standalone) | personality | HA status |
Platform > Model | Property | platform|model | — | Device model | device-model | platform_str |
Platform > Software Version | Property | platform|software_version | — | Installed software version | version | Version |
Platform > Operating System | Property | platform|operating_system | — | Operating system | platform | FortiOS |
Platform > Device Type | Property | platform|device_type | — | Device type as reported by the platform | device-type | device type |
Platform > Device Vendor | Property | platform|device_vendor | — | Hardware or platform vendor | device-vendor | vendor |
Status > Reachability | Property (key) | status|reachability | — | reachable / unreachable. Fortinet: conn_status = up maps to reachable, anything else to unreachable | reachability | conn_status |
Status > Admin Status | Property | status|admin_status | — | Administrative status of the device. Intentionally omitted for both vendors: neither API exposes an administrative enable/disable state | — | — |
Status > Operational Status | Property | status|operational_status | — | Up / Down operational state | reachability normalised | conn_status normalised |
Status > Device State | Property | status|device_state | — | Device state reported by the platform | device-state | device state |
Status > Device State Description | Property | status|device_state_description | — | Human readable explanation of the device state | device-state-description | composed from device and config status |
Status > Certificate State | Property | status|certificate_state | — | State of the device certificate | certificate endpoint | — |
Status > Config Operation Mode | Property | status|config_operation_mode | — | How the configuration is managed. Fortinet: FMG | config-operation-mode | FMG |
Status > Template Status | Property | status|template_status | — | Status of the attached configuration template, e.g. in_sync / out_of_sync. Fortinet derived from conf_status | template endpoint | conf_status |
Location > Latitude | Property | location|latitude | — | Latitude of the site | latitude | — |
Location > Longitude | Property | location|longitude | — | Longitude of the site | longitude | — |
SLA Level | Property | sla_level | — | SLA level assigned to the object: 1 or 2. Top level so a custom group rule can match it | from sla_default_level / sla_overrides | from sla_default_level / sla_overrides |
SLA Availability Threshold | Property | sla_availability_threshold | — | Minimum availability the level implies, derived as above | derived | derived |
SLA Allowed Downtime (hours) | Property | sla_allowed_downtime_hours | — | Unavailability budget of the level, in hours | derived | derived |
Availability > Availability | Metric (KPI) | availability|availability | — | 1 when the router is reachable, else 0 | reachability | conn_status = up |
Availability > Availability | Metric (KPI) | availability|availability_pct | percent | The same state scaled to 0 / 100 | derived | derived |
System Resources > CPU Usage | Metric (KPI) | system|cpu_usage | percent | CPU usage | /dataservice/device/system/status | proxy system/resource.results.cpu |
System Resources > Memory Usage | Metric (KPI) | system|memory_usage | percent | Used memory as a share of total | /dataservice/device/system/status | proxy system/resource.results.mem |
System Resources > Memory Total | Metric | system|memory_total | byte | Total memory of the device | /dataservice/device/system/status | proxy mem_total |
System Resources > Memory Free | Metric | system|memory_free | byte | Free memory of the device | /dataservice/device/system/status | proxy mem_free |
System Resources > Disk Usage | Metric | system|disk_usage | percent | Used disk as a share of total disk size | /dataservice/device/system/status | — |
System Resources > Uptime | Metric | system|uptime | seconds | Time since the router last booted | /dataservice/device/system/status | proxy uptime |
Control Plane > Control Connections | Metric (KPI) | control_plane|control_connections | connections | Established control plane connections. Fortinet: 1 when the FGFM tunnel to FortiManager is up, else 0 | /dataservice/device/control/connections | conn_status |
Control Plane > OMP Peers | Metric | control_plane|omp_peers | — | Overlay Management Protocol peers | /dataservice/device/counters | — |
BFD Sessions > BFD Sessions | Metric | bfd|bfd_sessions | sessions | Total BFD sessions terminated on the router | /dataservice/device/bfd/sessions | — |
BFD Sessions > BFD Sessions Up | Metric | bfd|bfd_sessions_up | sessions | BFD sessions currently up | /dataservice/device/bfd/sessions | — |
BFD Sessions > BFD Sessions Down | Metric (KPI) | bfd|bfd_sessions_down | sessions | Total minus up | /dataservice/device/bfd/sessions | — |
Sessions > Session Count | Metric (KPI) | sessions|session_count | sessions | Firewall sessions held by the device | — | proxy system/resource.results.session |
Sessions > Session Setup Rate | Metric | sessions|session_setup_rate | sessions | Rate at which new firewall sessions are established | — | proxy session_setup_rate |
Hardware Environment > Temperature | Metric | environment|temperature | celcius | Highest temperature sensor reading; hardware platforms only | /dataservice/device/hardware/environment | — |
Health > Certificate Days To Expiry | Metric | health|certificate_days_to_expiry | days | Whole days left until the certificate expires | certificate endpoint | — |
Health > Active Alarm Count | Metric | health|active_alarm_count | — | Active alarms attributed to this router | /dataservice/device/alarms | — |
Health > Reboot Count | Metric | health|reboot_count | — | Reboots recorded inside the collection window | /dataservice/device/reboothistory | — |
The temperature unit key is spelled
celciusbecause that is the spelling used by the VMware Aria Operations units registry.
Relationships: child of the API entry-point SD-WAN Device, or of the adapter instance when no entry-point device is present; child of the SD-WAN Location of its site on a Cisco deployment that carries sites; parent of its SD-WAN Link objects; optional child of a VMWARE / VirtualMachine; optional child of an IndevopsPhpIpam / IP Address.
SD-WAN Link (SDWANLink)
Transport interface of an edge router - the carrier circuit connecting the site to the overlay. Cisco: a TLOC. Fortinet: an SD-WAN member / WAN interface. Object name is <node host-name>:<ifname>.
An overlay tunnel interface is never turned into a WAN Link: it is the overlay leg, and its measurements are aggregated onto the physical link that carries it (see Tunnel aggregates).
| Data Name | Type | Key | Unit | Description | Cisco source | Fortinet source |
|---|---|---|---|---|---|---|
Device UUID | Identifier | device_uuid | — | Identifier of the router the interface belongs to. Part of the object key | device UUID | FortiGate sn |
VPN ID | Identifier | vpn_id | — | VPN the interface is placed in. Part of the object key | VPN identifier, normally 0 | VDOM, default 0 |
Interface Name | Identifier | ifname | — | Interface name on the router. Part of the object key | ifname | member interface, e.g. port1 |
Identity > Name | Property (key) | identity|name | — | Name of the link, composed as <node host-name>:<ifname> | composed | composed |
Identity > Device UUID | Property | identity|device_uuid | — | Identifier of the owning router | device UUID | sn |
Identity > Device Name | Property | identity|device_name | — | Host name of the owning router | host-name | FortiGate host name |
Identity > VPN ID | Property | identity|vpn_id | — | VPN the interface is placed in | VPN identifier | VDOM |
Identity > EndPoint | Property | identity|endpoint | — | Full product name identifying the monitored source | constant | constant |
Identity > Description | Property | identity|description | — | Circuit alias. Cisco reads the description field of the interface record (current releases publish the circuit alias there); Fortinet reads the interface alias | interface description | interface alias |
Transport > Transport Color | Property (key) | transport|transport_color | — | Transport colour of the link. Fortinet: the SD-WAN member zone | TLOC colour | member zone |
Transport > IP Address | Property | transport|ip_address | — | IP address configured on the interface | ip-address | live interface, fallback member source address |
Transport > Port Type | Property | transport|port_type | — | Type of the port. Fortinet: physical for port*, tunnel for tunnel / IPsec / VWAN interfaces | port-type | derived from the interface name |
Transport > Encapsulation | Property | transport|encapsulation | — | Tunnel encapsulation used on the link | encapsulation | — |
Status > Admin Status | Property | status|admin_status | — | Administrative status of the interface. Not written for Fortinet: the member body reports a single up/down state, which is already operational_status | admin-status | — |
Status > Operational Status | Property (key) | status|operational_status | — | Up / Down. Fortinet normalised from the member state | oper-status | member link |
Capacity > Speed | Property | capacity|speed | mbitps | Nominal circuit speed, the denominator of the utilization metrics | speed-mbps | matching health-check bandwidth |
Capacity > MTU | Property | capacity|mtu | — | Maximum transmission unit | mtu | — |
Site ID | Property | site_id | — | Site identifier inherited from the parent device. Top level so a report column or group rule can resolve the bare key | from device | — |
Site Name | Property | site_name | — | Site label inherited from the parent device. Top level, same reason | from device | — |
Location | Property | location | — | Name of the SDWANLocation object of the site - the identical string the Location uses as its name (the site name, else Site <site id>), so a link and its location can be joined directly. A link whose device carries no site writes no value | from the site object | — |
Link Type | Property | link_type | — | Closed vocabulary: MPLS, Internet, Biz Internet or Other. Resolved from link_type_overrides first, then the automatic classification, then Other; always populated. Top level so a custom group rule can match it | override, then transport colour | override, then member zone / name / alias |
Link Role | Property | link_role | — | primary or backup. Fortinet derives it from the member configuration: backup when cost > 0 or priority > 1, primary when cost == 0 and priority <= 1. Written only when the member configuration actually lists the interface. Cisco writes the constant primary, because vManage exposes no member cost/priority and every Cisco link is a primary path | constant primary | member cost / priority |
Link Cost | Property | link_cost | — | Raw SD-WAN member cost the role was derived from | — | member cost |
Link Priority | Property | link_priority | — | Raw SD-WAN member priority the role was derived from | — | member priority |
SLA Level | Property | sla_level | — | SLA level of the link. Inherited from the parent node; sla_overrides may match the link name as well. Top level | resolved | resolved |
SLA Availability Threshold | Property | sla_availability_threshold | — | Minimum availability the level implies | derived | derived |
SLA Allowed Downtime (hours) | Property | sla_allowed_downtime_hours | — | Unavailability budget of the level, in hours | derived | derived |
Availability > Availability | Metric (KPI) | availability|availability | — | 1 when the link is up, else 0 | interface state | member status |
Availability > Availability | Metric (KPI) | availability|availability_pct | percent | The same state scaled to 0 / 100 | derived | derived |
Inventory > Path Count | Metric | inventory|path_count | connections | Number of overlay paths the link carries. A count, so a link with no paths emits 0 instead of nothing. Drives the path-existence filter of the dashboards and link reports | BFD session list | merged health-check / IPsec legs |
Inventory > Path Up Count | Metric | inventory|path_up_count | connections | Number of those paths that are up. Emitted as 0 for a link with no live path | BFD session list | merged legs |
Inventory > Paths SLA Violated | Metric | inventory|paths_sla_violated | connections | Number of tunnels of the link that currently breach their SLA class. Emitted only when at least one tunnel carried an evaluable SLA class | app-route vs SLA class | sla_targets_met |
Utilization > Utilization Download | Metric (KPI) | utilization|utilization_download | percent | Receive rate as a share of the circuit speed. Emitted only when a capacity resolves | interface stats | RTM sd-wan-intf-log rx_bandwidth / capacity |
Utilization > Utilization Upload | Metric (KPI) | utilization|utilization_upload | percent | Transmit rate as a share of the circuit speed | interface stats | RTM tx_bandwidth / capacity |
Utilization > Utilization Aggregate | Metric (KPI) | utilization|utilization_aggregate | percent | Combined rate as a share of the circuit speed | interface stats | RTM bi_bandwidth (fallback rx+tx) / capacity |
Utilization > TLOC Utilization | Metric | utilization|tloc_utilization | percent | TLOC utilization as reported by the router itself | /dataservice/device/tloc-util | — |
Throughput > Rx Throughput | Metric (rate) | throughput|rx_throughput | mbitps | Receive throughput | interface stats | RTM rx_bandwidth (kbps → Mbit/s) |
Throughput > Tx Throughput | Metric (rate) | throughput|tx_throughput | mbitps | Transmit throughput | interface stats | RTM tx_bandwidth (kbps → Mbit/s) |
Errors and Drops > Rx Errors | Metric | errors|rx_errors | errors | Cumulative receive errors since the counters were last reset | /dataservice/device/interface/stats | — |
Errors and Drops > Tx Errors | Metric | errors|tx_errors | errors | Cumulative transmit errors since the counters were last reset | /dataservice/device/interface/stats | — |
Errors and Drops > Rx Drops | Metric | errors|rx_drops | packets | Received packets dropped by the interface | /dataservice/device/interface/stats | — |
Errors and Drops > Tx Drops | Metric | errors|tx_drops | packets | Transmitted packets dropped by the interface | /dataservice/device/interface/stats | — |
Stability > Flaps | Metric | stability|flaps | — | Cumulative interface flap counter since the device booted | num-flaps | — |
Stability > Flap Rate | Metric (KPI) | stability|flap_rate | — | The flap counter normalised to flaps per hour over the node uptime | derived from num-flaps | — |
Stability > BFD Transitions | Metric | stability|bfd_transitions | — | Sum of the BFD state changes of every tunnel of the link | BFD counters | merged legs |
Stability > BFD Transition Rate | Metric (KPI) | stability|bfd_transition_rate | — | The worst per-tunnel transition rate, in transitions per hour - the flapping indicator | BFD counters | merged legs |
Stability > Tunnel Uptime | Metric | stability|tunnel_uptime | seconds | Uptime of the youngest tunnel of the link, i.e. the one that reset most recently | BFD session | IPsec creation time |
Quality > Ping | Metric (KPI) | quality|ping | milliseconds | Mean latency over the tunnels whose session is up. No up leg → no point | app-route records of the link colour, state != down | RTM sd-wan-sla-log latency[], down samples excluded |
Quality > Jitter | Metric (KPI) | quality|jitter | milliseconds | Mean delay variation over the live tunnels | app-route jitter | RTM jitter[], down samples excluded |
Quality > Packet Loss | Metric (KPI) | quality|packet_loss | percent | Mean packet loss over the live tunnels | app-route loss_percentage | RTM packetloss[], down samples excluded |
Quality > Average Latency | Metric | quality|average_latency | milliseconds | Mean latency over the measurement window | app-route statistics | mean of RTM samples taken while the leg was up |
Quality > Average Jitter | Metric | quality|average_jitter | milliseconds | Mean delay variation over the measurement window | app-route statistics | mean of RTM samples while up |
Quality > Average Loss | Metric | quality|average_loss | percent | Mean packet loss over the measurement window | app-route statistics | mean of RTM samples while up |
Quality > vQoE Score | Metric | quality|vqoe_score | — | Quality of experience score, 0 to 10 | app-route FEC aggregation | — |
Traffic > Rx Octets | Metric | traffic|rx_octets | byte | Octets received, summed over every tunnel of the link regardless of state | tunnel statistics | IPsec incoming_bytes |
Traffic > Tx Octets | Metric | traffic|tx_octets | byte | Octets transmitted, summed over every tunnel of the link | tunnel statistics | IPsec outgoing_bytes |
Relationships: child of its SD-WAN Node; child of the SD-WAN Device of the same adapter instance (the Device -> Link relation required by the specification); no child objects.
Tunnel aggregates on the link
The management pack does not create an object per overlay tunnel. A live fleet carried about 6148 tunnel objects and about 6000 tunnel-to-link relationships per collection cycle, which dominated the collection cost and left most relationship keys unresolved; none of the per-tunnel objects was consumed on its own, because every operator-facing view, alert and report acts on the link. The kind was therefore removed and its measurements aggregated onto the link:
| Aggregated metric | Aggregation over the tunnels of the link |
|---|---|
inventory|path_count, inventory|path_up_count | count / count of up legs |
inventory|paths_sla_violated | count of legs breaching their SLA class |
quality|ping, quality|jitter, quality|packet_loss | mean over the legs whose session is up |
quality|average_latency, quality|average_jitter, quality|average_loss | mean over the measurements of the window, per leg, then over the legs |
quality|vqoe_score | mean over the legs that report a score (Cisco only) |
traffic|rx_octets, traffic|tx_octets | sum over every leg, regardless of state |
stability|bfd_transitions | sum over the legs |
stability|bfd_transition_rate | max over the legs - the worst flapping leg |
stability|tunnel_uptime | min over the legs that report an uptime - the youngest tunnel |
The per-tunnel configuration properties that only made sense on a tunnel object - protocol, detection multiplier, transmit interval, SLA class name, and the tunnel endpoint fields - are not carried over. The tunnel endpoints remain visible indirectly through the link's transport_color and through the SLA evaluation the link performs.
A down leg carries no usable measurement: both vendors log it as packetloss = 100 with latency and jitter 0. Averaging that in would render a link down for half the window as roughly 50 % loss. The quality means are therefore computed over the up samples only; a leg that is down is expressed by availability alone, and a window with no up sample emits no quality point.
Units
| Unit key | Meaning |
|---|---|
percent | percentage, Aria Operations renders the % suffix on its own |
seconds | seconds |
milliseconds | milliseconds |
days | whole days |
connections | object or path count |
sessions | session count |
celcius | degrees Celsius - the spelling used by the Aria Operations units registry |
mbitps | megabits per second |
errors | error counter |
packets | packet counter |
byte | bytes |
