Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

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).

CLI Equivalent: show tunnel gre-keepalives

URL: https://vmanage-ip-address/dataservice/device/tunnel/gre-keepalives?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Statistics

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

CLI Equivalent: show tunnel statistics

URL: https://vmanage-ip-address/dataservice/device/tunnel/statistics?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object for Real-Time Monitoring API Calls

Real-time monitoring API call responses have the following format:

{
  "header": {
    "generatedOn": timestamp, milliseconds (UNIX time format),                            
      "viewKeys": {
        "uniqueKey": ["key"]                       
      },
      "fields": [
        properties and types
      ],
   },
   "data": [
     array of objects
   ]
}

Additional Information

Using the vManage REST API

  • Was this article helpful?