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

Device Dashboard

API calls for retrieving troubleshooting information about Viptela devices in the overlay network:

Application-Aware Routing Aggregation

Display loss, latency, and jitter information for a device's TLOCs and tunnels.

URL: https://vmanage-ip-address/dataservice/statistics/approute/aggregation

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional vManage sample query to filter by device identifier and time. Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Display average loss, latency, and jitter for each local color on the device:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "100"
        ],
        "field":"loss_percentage",
        "type":"number","operator":"less"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      }
    ]
  },
  "aggregation":{
    "field":[
      {
        "property":"local_color",
        "order":"asc",
        "sequence":1
      }
    ],
    "metrics":[
      {
        "property":"loss_percentage",
        "type":"avg"
      },
      {
        "property":"latency",
        "type":"avg"
      },
      {
        "property":"jitter",
        "type":"avg"
      }
    ]
  }
}

Display average loss percentage in 30-minute intervals on each tunnel for the last 12 hours:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "12"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      },
      {
        "value": [
          "1.1.28.1"
        ],
        "field": "vdevice_name",
        "type": "string",
        "operator": "in"
      },
      {
        "value": [
          "1.1.28.1:public-internet-1.1.100.2:gold",
          "1.1.28.1:public-internet-100.100.100.2:gold",
          "1.1.28.1:public-internet-100.100.100.1:gold",
          "1.1.28.1:public-internet-1.1.100.100:public-internet",
          "1.1.28.1:public-internet-1.1.100.1:default",
          "1.1.28.1:public-internet-100.100.100.2:green"
        ],
        "field": "name",
        "type": "string",
        "operator": "in",
        "display": [
          {
            "name-hostname": "santosh:public-internet-Cage-1-B:gold",
            "name": "1.1.28.1:public-internet-1.1.100.2:gold"
          },
          {
            "name-hostname": "santosh:public-internet-site-1732-Gate2:gold",
            "name": "1.1.28.1:public-internet-100.100.100.2:gold"
          },
          {
            "name-hostname": "santosh:public-internet-site-1732-Gate1:gold",
            "name": "1.1.28.1:public-internet-100.100.100.1:gold"
          },
          {
            "name-hostname": "santosh:public-internet-vEdge-Cloud-1:public-internet",
            "name": "1.1.28.1:public-internet-1.1.100.100:public-internet"
          },
          {
            "name-hostname": "santosh:public-internet-Cage-1-A:default",
            "name": "1.1.28.1:public-internet-1.1.100.1:default"
          },
          {
            "name-hostname": "santosh:public-internet-site-1732-Gate2:green",
            "name": "1.1.28.1:public-internet-100.100.100.2:green"
          }
        ]
      }
    ]
  },
  "aggregation": {
    "field": [
      {
        "property": "name",
        "sequence": 1
      }
    ],
    "histogram": {
      "property": "entry_time",
      "type": "minute",
      "interval": 30,
      "order": "asc"
    },
    "metrics": [
      {
        "property": "loss_percentage",
        "type": "avg"
      }
    ]
  }
}

Control Connections

Display status and statistics for a device's control connections.

URL: https://vmanage-ip-address/dataservice/device/control/synced/connections?deviceId=deviceId

Method: POST

Request Parameters

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

Response Content Type: application/json

Response Object: See Response Object, below.

Device BFD State

Display information about a device's BFD sessions.

URL: https://vmanage-ip-address/dataservice/device/bfd/state/device?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.

Device Counters

Display device counters, including number of crashes, control connections, OMP peers up and down, reboots, and BFD sessions up and down.

URL: https://vmanage-ip-address/dataservice/device/counters?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.

Device Status Summary

Display hardware information about the device, including fans, temperature sensors, USB ports, and power supply.

URL: https://vmanage-ip-address/dataservice/device/hardware/status/summary?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.

Device System Summary

Display historical memory and CPU information about the device.

Device System Summary Using GET Method

If the query size is less than 2048 characters, use the GET method.

URL: https://vmanage-ip-address/dataservice/statistics/system?query=query

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Query String (JSON)

Device System Summary Using POST Method

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

URL: https://vmanage-ip-address/dataservice/statistics/system

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Display system statistics for the last 24 hours for a device:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      }
    ]
  },
  "fields":[
    "entry_time",
    "count","mem_util"
  ],
  "sort":[
    {
      "field":"entry_time",
      "type":"date",
      "order":"asc"
    }
  ]
}

Display CPU information averaged over 5-minute increments for the device 172.16.255.11 for the last 24 hours:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      }
    ]
  },
    "fields":[
      "entry_time",
      "count","min5_avg"],
      "sort":[{"field":"entry_time",
      "type":"date",
      "order":"asc"
    }
  ]
}

Events

Display information about events on the device. By default, the API call returns all events for the device.

URL: https://vmanage-ip-address/dataservice/event

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional vManage sample query to filter by device identifier and time Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Display events for the last 24 hours for a device:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "field":"system_ip",
        "operator":"in",
        "type":"string",
        "value":[
          "172.16.255.11"
        ]
      }
    ]
  },
  "size":10000
}

Events by Severity

Display information about events by severity level.

URL: https://vmanage-ip-address/dataservice/event/severity/summary

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
query Optional vManage sample query to filter by device identifier and time. Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Display events by severity for the last 24 hours for a device:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "field":"system_ip",
        "operator":"in",
        "type":"string",
        "value":[
          "1.1.200.7"
        ]
      }
    ]
  }
}

Flow Log

Display flow log information.

URL: https://vmanage-ip-address/dataservice/statistics/flowlog

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional vManage sample query to filter by device identifier and time Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Display flow log information for the last 24 hours for a device:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "1.1.200.7"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      }
    ]
  }
}

Interface Aggregation

Display aggregated interface information.

URL: https://vmanage-ip-address/dataservice/statistics/interface/aggregation

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned. Possible values for transfer and receive rates are drop, error, kbps, octets, packets, and pps. Body String (JSON)

Example

Return the average transfer and receive rates in intervals of 30 minutes for each specified interface:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      },
      {
        "value":[
          "ge0/1",
          "ge0/2",
          "ge0/3",
          "ge0/4",
          "ge0/5",
          "ge0/6"
        ],
        "field":"interface",
        "type":"string",
        "operator":"in"
      }
    ]
  },
  "sort":[
    {
      "field":"entry_time",
      "type":"date",
      "order":"asc"
    }
  ],
  "aggregation":
  {
    "field":[
      {
        "property":"interface",
        "sequence":1
      }
    ],
    "histogram":
      {
        "property":"entry_time",
        "type":"minute",
        "interval":30,
        "order":"asc"
      },
      "metrics":[
        {
          "property":"rx_kbps",
          "type":"avg"
        },
        {
          "property":"tx_kbps",
          "type":"avg"
        }
      ]
    }
  } 

Ping

Ping a device.

URL: https://vmanage-ip-address/dataservice/device/tools/ping/deviceId

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Path String
inputJson Yes Ping parameters Body
See Request Body Schema table, below
String (JSON)

Response Content Type: application/json

Request Body Schema

Value Description
deviceIp IP address of the device to ping
host IP address of host to ping
source Interface or IP address from which to send ping packets
vpn VPN in which to ping

Example

Ping a device whose IP address is 1.1.200.7:

{
  "deviceIp":"1.1.200.7",
  "host":"1.1.1.1",
  "vpn":"0",
  "source":"ge0/0"
}

Synced Interface

Display information about the interfaces on a Viptela device (from vManage NMS only).

URL: https://vmanage-ip-address/dataservice/device/interface/synced?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
vpn-id Optional VPN ID Query Number
ifname Optional Interface name Query String
af-type Optional Address family type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Top Applications for a Device

Display applications with the highest utilization for a device.

Top Applications Using GET Method

If the query size is less than 2048 characters, use the GET method.

URL: https://vmanage-ip-address/dataservice/statistics/dpi/aggregation?query=query

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Query String (JSON)

Top Applications Using POST Method

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

URL: https://vmanage-ip-address/statistics/dpi/aggregation

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Return the top applications for the last 24 hours:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
        }
      ]
    },
    "aggregation":{
    "field":[
      {
        "property":"family",
        "size":200,
        "sequence":1
      }
    ],
    "metrics":[
      {
        "property":"octets",
        "type":"sum",
        "order":"desc"
      }
    ]
  }
}

Top Destinations for a Device

Display top flows for a given destination for a device.

Top Destinations Using GET Method

If the query size is less than 2048 characters, use the GET method.

URL: https://vmanage-ip-address/dataservice/statistics/cflowd/aggregation?query=query

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Query String (JSON)

Top Destinations Using POST Method

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

URL: https://vmanage-ip-address/statistics/cflowd/aggregation

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
query Optional Query to filter data returned Body String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Example

Return the top destinations for the last 24 hours:

{
  "query":{
    "condition":"AND",
    "rules":[
      {
        "value":[
          "24"
        ],
        "field":"entry_time",
        "type":"date",
        "operator":"last_n_hours"
      },
      {
        "value":[
          "172.16.255.11"
        ],
        "field":"vdevice_name",
        "type":"string",
        "operator":"in"
      }
    ]
  },
  "aggregation":{
    "field":[
      {
        "property":"dest_ip",
        "size":200,"sequence":1
      }
      ],
      "metrics":[
        {"property":"total_bytes",
        "type":"sum",
        "order":"desc"
      }
    ]
  }
}

Traceroute

Display the path that packets take to reach a host or IP address on the network.

URL: https://vmanage-ip-address/dataservice/device/tools/traceroute/deviceId

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Path String
inputJson Yes Ping parameters Body
See Request Body Schema table, below
String (JSON)

Response Content Type: application/json

Request Body Schema

Value Description
deviceIp IP address of the destination device
host IP address of destination host
source Interface or IP address through which the traceroute should send packets
vpn VPN in which the host is located

Example

Run a traceroute to a device with IP address 1.1.200.7:

{
  "deviceIp":"1.1.200.7",
  "host":"1.1.1.1",
  "vpn":"0",
  "source":"ge0/0"
}

Response Object

Troubleshooting 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?