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

Interface

API calls for real-time monitoring of interface information:

ARP Statistics

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

CLI Equivalent: show interface arp-stats

URL: https://vmanage-ip-address/dataservice/device/interface/arp_stats?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Error Statistics

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

CLI Equivalent: show interface errors

URL: https://vmanage-ip-address/dataservice/device/interface/error_stats?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Interface

Display information about IPv4 interfaces on a Viptela device.

CLI Equivalent: show interface

URL: https://vmanage-ip-address/dataservice/device/interface?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Interface from vManage NMS

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

CLI Equivalent: show interface

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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Packet Size

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

CLI Equivalent: show interface packet-sizes

URL: https://vmanage-ip-address/dataservice/device/interface/pkt_size?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Port Statistics

Display interface port statistics (on vEdge routers only).

CLI Equivalent: show interface port-stats

URL: https://vmanage-ip-address/dataservice/device/interface/port_stats?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Queue Statistics

Display interface queue statistics (on vEdge routers only).

CLI Equivalent: show interface queue

URL: https://vmanage-ip-address/dataservice/device/interface/queue_stats?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 IF name Query String
af-type Optional AF type Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Statistics

Display interface statistics (on vEdge routers only).

CLI Equivalent: show interface statistics

URL: https://vmanage-ip-address/dataservice/device/interface/stats?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 IF name Query String
af-type Optional AF type 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?