Real-time Monitoring API Endpoints

Real-time monitoring APIs query device state and information in real-time.

Application-Aware Routing

API calls for real-time monitoring of application-aware routing.

  • SLA Class
    Display information about the SLA classes operating on the router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/app-route/sla-class?deviceId=deviceId

  • Statistics
    Display statistics about data traffic characteristics for all operational data plane tunnel (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/app-route/statistics?deviceId=deviceId

App Logs

API calls for real-time monitoring of packet flows.

  • Flow Count
    Display the count of packet flows that the system logs (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/app/log/flow-count?deviceId=deviceId

  • Flows
    Display logging information for packet flows (on vEdge routers only).

    GET https://{vmanage-ip-address/}dataservice/device/app/log/flows?deviceId=deviceId

Address Resolution Protocol (ARP)

API calls for real-time monitoring of ARP information. Display the IPv4 entries in the Address Resolution Protocol table, which lists the mapping of IP addresses to device MAC addresses.

GET https://{vmanage-ip-address}/dataservice/device/arp?deviceId=deviceId

Bidirectional Forwarding Detection (BFD)

API calls for real-time monitoring of BFD information.

  • History
    Displays the history of the BFD sessions running on a vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bfd/history?deviceId=deviceId

  • Sessions
    Display information about the BFD sessions running on a vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bfd/sessions?deviceId=deviceId

  • Sessions from Cisco Catalyst SD-WAN Manager Network Management System (NMS)
    Display information about synced BFD sessions running on a vEdge router (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/bfd/synced/sessions?deviceId=deviceId

  • Summary
    Display summary information about the BFD sessions running on a vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bfd/summary?deviceId=deviceId

  • Transport Locator (TLOC) Summary
    Display BFD session summary information per TLOC (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/bfd/tloc?deviceId=deviceId

Border Gateway Protocol (BGP)

API calls for real-time monitoring of BGP information.

  • Neighbors
    List the router's BGP neighbors (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bgp/neighbors?deviceId=deviceId

  • Routes
    List the router's BGP routes (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bgp/routes?deviceId=deviceId

  • Summary
    Displays the status of all BGP connections (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bgp/summary?deviceId=deviceId

Bridge

API calls for real-time monitoring of bridging information.

  • Interface
    List information about the interfaces on which bridging is running (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bridge/interface?deviceId=deviceId

  • MAC
    List the MAC addresses that this vEdge router has learned (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/bridge/mac?deviceId=deviceId

  • Table
    List the information in the bridge forwarding table.

    GET https://vmanage-ip-address/dataservice/device/bridge/table?deviceId=deviceId

Cellular

API calls for real-time monitoring of cellular information.

  • Modem
    Display cellular modem information and status (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/cellular/modem?deviceId=deviceId

  • Network
    Display cellular network information and status (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cellular/network?deviceId=deviceId

  • Profiles
    Display cellular profile information and status (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/cellular/profiles?deviceId=deviceId

  • Radio
    Display cellular radio band information (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cellular/radio?deviceId=deviceId

  • Sessions
    Display cellular session information (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cellular/sessions?deviceId=deviceId

  • Status
    Display cellular status information (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cellular/status?deviceId=deviceId

Cflowd

API calls for real-time monitoring of cflowd information.

  • Collector
    Display information about the configured cflowd collectors that the vEdge router has learned from a Cisco Catalyst SD-WAN Controller (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cflowd/collector?deviceId=deviceId

  • Flows
    Display cflowd flow information (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cflowd/flows?deviceId=deviceId

  • Flows Count
    Display the number of current cflowd traffic flows (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cflowd/flows-count?deviceId=deviceId

  • Statistics
    Display cflowd packet statistics (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/cflowd/statistics?deviceId=deviceId

  • Template
    Display the cflowd template information that the vEdge router transmits periodically to the cflowd collector (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/cflowd/template?deviceId=deviceId

CloudExpress

API call for real-time monitoring of CloudExpress service.

  • Applications
    Display the best interfaces for applications configured with CloudExpress service.

    GET https://{vmanage-ip-address}/dataservice/device/cloudx/applications?deviceId=deviceId

Control

API calls for real-time monitoring of control plane connection information.

  • Affinity Configuration
    Display configuration information about the control connections between the vEdge router and one or more Cisco Catalyst SD-WAN Controllers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/affinity/config?deviceId=deviceId

  • Affinity Status
    Display the status of the control connections between the vEdge router and one or more Cisco Catalyst SD-WAN Controllers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/affinity/status?deviceId=deviceId

  • Connections
    Display information about active control plane connections (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/connections?deviceId=deviceId

  • Connections from vManage NMS
    Display information about active control plane connections (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/control/synced/connections?deviceId=deviceId

  • Connections History
    Display information about control plane connection attempts initiated by the local device.

    GET https://{vmanage-ip-address}/dataservice/device/control/synced/connectionshistory?deviceId=deviceId

  • Local Properties
    Display the basic configuration parameters and local properties related to the control plane (on vEdge routers, Cisco Catalyst SD-WAN Manager NMSs, and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/localproperties?deviceId=deviceId

  • Local Properties from Cisco Catalyst SD-WAN Manager NMS
    Display the basic configuration parameters and local properties related to the control plane (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/control/synced/localproperties?deviceId=deviceId

  • Statistics
    Display statistics about the packets that a vEdge router or Cisco Catalyst SD-WAN Controller has transmitted and received in the process of establishing and maintaining secure DTLS connections to Cisco Catalyst SD-WAN devices in the overlay network (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/statistics?deviceId=deviceId

  • Summary
    List a count of Cisco SD-WAN devices that the local device is aware of. For devices running on virtual machines (VMs) that have more than one core, this API call shows the number of devices that each vdaemon process instance is handling.

    GET https://{vmanage-ip-address}/dataservice/device/control/summary?deviceId=deviceId

  • Valid vEdge Routers
    List the chassis numbers of the valid vEdge routers in the overlay network (on Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/validdevices?deviceId=deviceId

  • Valid Cisco Catalyst SD-WAN Controllers
    List the serial numbers of the valid Cisco Catalyst SD-WAN Controllers in the overlay network (on vEdge routers and Cisco Catalyst SD-WAN Controllers controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/validvsmarts?deviceId=deviceId

  • WAN Interface
    Display the basic configuration parameters and local properties related to the control plane (on vEdge routers, Cisco Catalyst SD-WAN Manager NMSs, and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/control/waninterface?deviceId=deviceId

  • WAN Interface from Cisco Catalyst SD-WAN Manager NMS
    Display the basic configuration parameters and local properties related to the control plane (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/control/synced/waninterface?deviceId=deviceId

Crash Log

API calls for real-time monitoring of crash logs.

  • Crash Log
    Display a list of the core files on the device.

    GET https://{vmanage-ip-address}/dataservice/device/crashlog?deviceId=deviceId

  • Crash Log from Cisco Catalyst SD-WAN Manager NMS
    Display a list of the core files on the device (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/crashlog/synced?deviceId=deviceId

DHCP

API calls for real-time monitoring of DHCP information.

  • IPv6 Interface
    Display information about interfaces that are DHCPv6 clients (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/dhcpv6/interface?deviceId=deviceId

  • Interface
    Display information about interfaces that are DHCPv4 clients (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/dhcp/interface?deviceId=deviceId

  • Server
    Display information about the DHCP server functionality that is enabled on the router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dhcp/server?deviceId=deviceId

Dot1x

API calls for real-time monitoring of IEEE 802.1X information.

  • Clients
    Display information about the 802.1X clients in the network (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dot1x/clients?deviceId=deviceId

  • Interfaces
    Display information about 802.1X–enabled interfaces (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dot1x/interfaces?deviceId=deviceId

  • Radius
    Display statistics about the sessions with RADIUS servers being used for IEEE 802.1X and IEEE 802.11i authentication (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dot1x/interfaces?deviceId=deviceId

Deep Packet Inspection (DPI)

API calls for real-time monitoring of DPI information.

  • Applications
    Display application-aware applications running on the vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dpi/applications?deviceId=deviceId

  • Flows
    Display flow information for the application-aware applications running on the vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dpi/flows?deviceId=deviceId

  • Summary
    Display summary statistics for DPI flows on the vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/dpi/summary?deviceId=deviceId

  • Supported Applications
    List all the application-aware applications supported by the Cisco Catalyst SD-WAN software on the vEdge router (on vEdge routers only).

    GET https://vmanage-ip-address/dataservice/device/dpi/supported-applications?deviceId=deviceId

Hardware

API calls for real-time monitoring of hardware information.

  • Alarms
    Display information about currently active hardware alarms (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/hardware/alarms?deviceId=deviceId

  • Alarms from Cisco Catalyst SD-WAN Manager NMS
    Display information about currently active hardware alarms (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/hardware/synced/alarms?deviceId=deviceId

  • Environment
    Display status information about the router components, including component temperature (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/hardware/environment?deviceId=deviceId

  • Environment from Cisco Catalyst SD-WAN Manager NMS
    Display status information about the router components, including component temperature (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/hardware/synced/environment?deviceId=deviceId

  • Inventory
    Display an inventory of the hardware components in the router, including serial numbers (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/hardware/synced/inventory?deviceId=deviceId

  • Inventory from Cisco Catalyst SD-WAN Manager NMS
    Display an inventory of the hardware components in the router, including serial numbers (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/hardware/synced/inventory?deviceId=deviceId

  • Threshold
    Display temperature thresholds at which green, yellow, and red alarms are generated (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/hardware/threshold?deviceId=deviceId

Internet Group Management Protocol (IGMP)

API calls for real-time monitoring of IGMP information.

  • Groups
    Display information about multicast groups (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/igmp/groups?deviceId=deviceId

  • Interface
    Display information about the interfaces on which IGMP is enabled on the router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/igmp/interface?deviceId=deviceId

  • Statistics
    Display IGMP statistics (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/igmp/statistics?deviceId=deviceId

  • Summary
    Display information about the IGMP version and IGMP timers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/igmp/summary?deviceId=deviceId

Interface

API calls for real-time monitoring of interface information.

  • ARP Statistics
    Display the ARP statistics for each interface (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/arp_stats?deviceId=deviceId

  • Error Statistics
    Display error statistics for interfaces (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/error_stats?deviceId=deviceId

  • Interface
    Display information about IPv4 interfaces on a device.

    GET https://{vmanage-ip-address}/dataservice/device/interface?deviceId=deviceId

  • Interface from Cisco Catalyst SD-WAN Manager NMS Display information about IPv4 interfaces on a Cisco Catalyst SD-WAN device (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/synced?deviceId=deviceId

  • Packet Size
    Display packet size information for each interface (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/pkt_size?deviceId=deviceId

  • Port Statistics
    Display interface port statistics (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/port_stats?deviceId=deviceId

  • Queue Statistics
    Display interface queue statistics (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/queue_stats?deviceId=deviceId

  • Statistics
    Display interface statistics (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/interface/stats?deviceId=deviceId

IP

API calls for real-time monitoring of IP information.

  • FIB
    Display the IPv4 entries in the local forwarding table (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/fib?deviceId=deviceId

  • MFIB OIL
    Display the list of outgoing interfaces from the Multicast Forwarding Information Base (MFIB) (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/mfiboil?deviceId=deviceId

  • MFIB Statistics
    Display packet transmission and receipt statistics for active entries in the Multicast Forwarding Information Base (MFIB) (on vEdge routers only). Packet rates are computed every 10 seconds.

    GET https://{vmanage-ip-address}/dataservice/device/ip/mfibstats?deviceId=deviceId

  • MFIB Summary
    Display a summary of all active entries in the Multicast Forwarding Information Base (MFIB) (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/mfibsummary?deviceId=deviceId

  • NAT Filter
    Display the NAT translational filters (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/nat/filter?deviceId=deviceId

  • NAT Interface List the interfaces on which NAT is enabled and the NAT translational filters on those interfaces (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/nat/interface?deviceId=deviceId

  • NAT Interface Statistics
    List packet, NAT, and ICMP statistics for the interfaces on which NAT is enabled (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ip/nat/interfacestatistics?deviceId=deviceId

  • Routes
    Display the IPv4 entries in the local route table. On Cisco Catalyst SD-WAN Controllers, the route table incorporates forwarding information.

    GET https://{vmanage-ip-address}/dataservice/device/ip/routetable?deviceId=deviceId

Internet Protocol Security (IPsec)

API calls for real-time monitoring of IPsec information.

  • Inbound Connections
    Display information about IPsec tunnels that originate on remote routers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ipsec/inbound?deviceId=deviceId

  • Local SA
    Display security association information for the IPsec tunnels that have been created for local TLOCs (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ipsec/localsa?deviceId=deviceId

  • Outbound Connections
    Display information about the IPsec connections to remote routers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ipsec/outbound?deviceId=deviceId

IPv6 Neighbors

API call for real-time monitoring of IPv6 neighbors.

  • IPv6 Neighbors Display the entries in the Address Resolution Protocol (ARP) table for IPv6 neighbors, which lists the mapping of IPv6 addresses to device MAC addresses (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/ndv6?deviceId=deviceId

Multicast

API calls for real-time monitoring of multicast overlay routing.

  • Replicator
    List information about multicast replicators (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/multicast/replicator?deviceId=deviceId

  • RPF List multicast reverse-path forwarding information (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/multicast/rpf?deviceId=deviceId

  • Topology
    List information related to the topology of the multicast domain (on vEdge routers only).

    https://{vmanage-ip-address}/dataservice/device/multicast/topology?deviceId=deviceId

  • Tunnel
    List information about the IPsec tunnels between multicast peers (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/multicast/tunnel?deviceId=deviceId

Network Time Protocol (NTP)

API calls for real-time monitoring of NTP information.

  • Associations
    Display information about the status of connections to NTP peers.

    GET https://{vmanage-ip-address}/dataservice/device/ntp/associations?deviceId=deviceId

  • Peer
    Display information about the NTP peers with which the Cisco Catalyst SD-WAN software is synchronizing its clocks.

    GET https://{vmanage-ip-address}/dataservice/device/ntp/peer?deviceId=deviceId

Overlay Management Protocol (OMP)

API calls for real-time monitoring of OMP information.

  • Multicast Auto-Discover Advertised
    List the advertised peers that support multicast (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/mcastautodiscoveradvt?deviceId=deviceId

  • Multicast Auto-Discover Received
    List the received peers that support multicast (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/mcastautodiscoverrecv?deviceId=deviceId

  • Multicast Routes Advertised
    List the advertised multicast routes that OMP has learned from PIM join messages (on vEdge routers and Cisco Catalyst SD-WAN Controllers).

    GET https://{vmanage-ip-address}/dataservice/device/omp/mcastroutesadvt?deviceId=deviceId

  • Multicast Routes Received
    List the received multicast routes that OMP has learned from PIM join messages (on vEdge routers and Cisco Catalyst SD-WAN Controllers).

    GET https://{vmanage-ip-address}/dataservice/device/omp/mcastroutesrecv?deviceId=deviceId

  • Peers
    Display information about the OMP peering sessions that are active on the local Cisco Catalyst SD-WAN Controller or vEdge router.

    GET https://{vmanage-ip-address}/dataservice/device/omp/peers?deviceId=deviceId

  • Peers from Cisco Catalyst SD-WAN Manager
    Display information about the OMP peering sessions that are active on the local Cisco Catalyst SD-WAN Controller or vEdge router (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/synced/peers?deviceId=deviceId

  • Routes Advertised
    Display advertised OMP routes (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/routes/advertised?deviceId=deviceId

  • Routes Received
    Display received OMP routes (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/routes/received?deviceId=deviceId

  • Services
    Display the services learned from OMP peering sessions (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/services?deviceId=deviceId

  • Summary
    Display information about the OMP sessions running between Cisco Catalyst SD-WAN Controllers and vEdge routers (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/summary?deviceId=deviceId

  • TLOCs Advertised
    Display information learned from the TLOC routes advertised over the OMP sessions running between Cisco Catalyst SD-WAN Controllers and vEdge routers (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/tlocs/advertised?deviceId=deviceId

  • TLOCs Received
    Display information learned from the TLOC routes received over the OMP sessions running between Cisco Catalyst SD-WAN Controllers and vEdge routers (on Cisco Catalyst SD-WAN Controllers and vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/omp/tlocs/received?deviceId=deviceId

Orchestrator

API calls for real-time monitoring of vBond orchestrator information.

  • Connections
    List the Cisco Catalyst SD-WAN devices that have active DTLS connections to the vBond orchestrator (on vBond orchestrators only).

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/connections?deviceId=deviceId

  • Connections History
    List the history of connections and connection attempts made by the vBond orchestrator (on vBond orchestrators only).

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/connectionshistory?deviceId=deviceId

  • Local Properties
    Display the basic configuration parameters of a vBond orchestrator (on vBond orchestrators only).

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/localproperties?deviceId=deviceId

  • Summary
    Display a count of the vEdge routers, Cisco Catalyst SD-WAN Manager Network Management Systems (NMSs), and Cisco Catalyst SD-WAN Controllers in the overlay network (on vBond orchestrators only). For vBond orchestrators running on virtual machines (VMs) that have more than one core, this API call shows the number of devices that each vdaemon process is handling.

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/summary?deviceId=deviceId

  • Valid vEdge Routers
    List the chassis numbers of the valid vEdge routers in the overlay network (on vBond orchestrators only).

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/validvedges?deviceId=deviceId

  • Valid Cisco Catalyst SD-WAN Controllers
    List the serial numbers of the valid Cisco Catalyst SD-WAN Controllers in the overlay network (on vBond orchestrators only).

    GET https://{vmanage-ip-address}/dataservice/device/orchestrator/validsmarts?deviceId=deviceId

Open Shortest Path First (OSPF)

API calls for real-time monitoring of OSPF information.

  • Database
    List the entries in the OSPF Link-State Advertisement (LSA) database (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/database?deviceId=deviceId

  • Database Summary
    List how many of each type of LSA is present in the OSPF database, along with the total number of LSAs in the database (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/databasesummary?deviceId=deviceId

  • External Database
    List the entries in the OSPF Link-State Advertisement (LSA) database (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/databaseexternal?deviceId=deviceId

  • Interface
    Display information about interfaces that are running OSPF (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/interface?deviceId=deviceId

  • Neighbor
    List information about OSPF neighbors (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/neighbor?deviceId=deviceId

  • Process
    Show information about each OSPF routing process running on the vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ospf/process?deviceId=deviceId

  • Routes
    Display the entries that the route table has learned from OSPF (on vEdge routers only).

    https://{vmanage-ip-address}/dataservice/device/ospf/routes?deviceId=deviceId

Protocol Independent Multicast (PIM)

API calls for real-time monitoring of protocol independent multi-cast (PIM).

  • PIM Interface List
    List interfaces that are running PIM (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/pim/interface?deviceId=deviceId

  • PIM Neighbor List
    List PIM neighbors (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/pim/neighbor?deviceId=deviceId

  • PIM RP Mapping List
    Display the mappings of multicast groups to RPs (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/pim/rp-mapping?deviceId=deviceId

  • PIM Statistics List
    Display all PIM-related statistics on the router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/pim/statistics?deviceId=deviceId

Policer

API call for real-time monitoring of policed interfaces.

  • Policer
    Display information about the policers that are in effect (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policer?deviceId=deviceId

Policy

API calls for real-time monitoring of policy information.

  • Access List Associations
    Display the IPv4 access lists that are operating on each interface (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/accesslistassociations?deviceId=deviceId

  • Access List Counters
    Display the number of packets counted by IPv4 access lists configured on the vEdge router (on vEdge routers only)

    GET https://{vmanage-ip-address}/dataservice/device/policy/accesslistcounters?deviceId=deviceId

  • Access List Names
    Display the names of the IPv4 access lists configured on the vEdge router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/accesslistnames?deviceId=deviceId

  • Access List Policers
    Display information about the policers configured in IPv4 access lists (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/accesslistpolicers?deviceId=deviceId

  • App Route Policy Filter
    Display information about application-aware routing policy filters configured in IPv4 access lists (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/approutepolicyfilter?deviceId=deviceId

  • Data Policy Filter
    Display information about data policy filters for configured counters and policers, and for out-of-sequence packets (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/datapolicyfilter?deviceId=deviceId

  • QoS Map Information
    Display information about the QoS maps are applied to each interface (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/qosmapinfo?deviceId=deviceId

  • QoS Scheduler Information
    Display information about the configured QoS schedulers and the associated QoS map (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/policy/qosschedulerinfo?deviceId=deviceId

  • Rewrite Associations
    Display information about rewrite rules to interface bindings (on vEdge routers only).

    https://{vmanage-ip-address}/dataservice/device/policy/rewriteassociations?deviceId=deviceId

PPP

API call for real-time monitoring of PPP interface information.

  • Interface
    Display PPP interface information (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/ppp/interface?deviceId=deviceId)

PPPoE

API calls for real-time monitoring of PPP over Ethernet.

  • Session
    Display PPPoE session information (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/pppoe/session?deviceId=deviceId

  • Statistics
    Display statistics for PPPoE sessions (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/pppoe/statistics?deviceId=deviceId

Reboot History

API calls for real-time monitoring of reboot history.

  • Reboot History
    Display the history of when this device has been rebooted.

    GET https://{vmanage-ip-address}/dataservice/device/reboothistory?deviceId=deviceId

  • Reboot History from Cisco Catalyst SD-WAN Manager NMS
    Display the history of when this device has been rebooted (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/reboothistory/synced?deviceId=deviceId

Security

API calls for real-time monitoring of security information.

  • Information
    List the configured security information for IPsec tunnel connections (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/security/information?deviceId=deviceId

Software

API calls for real-time monitoring of software.

  • Software
    Retrieve interface list.

    GET https://{vmanage-ip-address}/dataservice/device/software?deviceId=deviceId

  • Software from Cisco Catalyst SD-WAN Manager NMS
    Retrieve interface list from Cisco Catalyst SD-WAN Manager NMS only.

    GET https://{vmanage-ip-address}/dataservice/device/software/synced?deviceId=deviceId

System

API calls for real-time monitoring of a device.

  • Status
    Display time and process information for the device, as well as CPU, memory, and disk usage data.

    GET https://{vmanage-ip-address}/dataservice/device/system/status?deviceId=deviceId

  • Status from Cisco Catalyst SD-WAN Manager NMS
    Display time and process information for the device, as well as CPU, memory, and disk usage data (from Cisco Catalyst SD-WAN Manager NMS only).

    GET https://{vmanage-ip-address}/dataservice/device/system/synced/status?deviceId=deviceId

Transport

API call for real-time monitoring of tunnel transport connections.

  • Connection
    Display the status of the DTLS connection to a vBond orchestrator (on vEdge routers and Cisco Catalyst SD-WAN Controllers only).

    GET https://{vmanage-ip-address}/dataservice/tunnel/transport/connection?deviceId=deviceId

Tunnel

API calls for real-time monitoring of data plane tunnels.

  • GRE Keepalive
    Display information about the keepalive packets transmitted and received on GRE tunnels that originate on the local router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/tunnel/gre-keepalives?deviceId=deviceId

  • Statistics
    Display information about the packets transmitted and received on the data plane tunnels that originate on the local router (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/tunnel/statistics?deviceId=deviceId

Users

API call for real-time monitoring of users logged in to the device.

  • Device Users
    Display the users currently logged in to the device.

    GET https://{vmanage-ip-address}/dataservice/device/users?deviceId=deviceId

VPN

API call for real-time monitoring of VPNs.

  • VPN
    Display VPN instance list.

    GET https://{vmanage-ip-address}/dataservice/device/vpn?deviceId=deviceId

Virtual Router Redundancy Protocol (VRRP)

API call for real-time monitoring of VRRP.

  • Virtual Router Redundancy Protocol
    Display information about the configured VRRP interfaces and groups (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/vrrp?deviceId=deviceId

Wireless Local Area Network (WLAN)

API calls for real-time monitoring of WLAN.

  • Clients
    Display information about the clients on the wireless LAN (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/wlan/clients?deviceId=deviceId

  • Interface
    Display information about the virtual access point (VAP) interfaces (on vEdge routers only)

    GET https://{vmanage-ip-address}/dataservice/device/wlan/interfaces?deviceId=deviceId

  • Radios
    Display information about the WLAN radios (on vEdge routers only).

    GET https://{vmanage-ip-address}/dataservice/device/wlan/radios?deviceId=deviceId