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

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 vSmart controllers (on vEdge routers only).

CLI Equivalent: show control affinity config

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

Affinity Status

Display the status of the control connections between the vEdge router and one or more vSmart controllers (on vEdge routers only).

CLI Equivalent: show control affinity status

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

Connections

Display information about active control plane connections (on vSmart controllers and vEdge routers only).

CLI Equivalent: show control connections

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
peer-type Optional Peer type Query String
system-ip Optional IP address of peer device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Connections from vManage NMS

Display information about active control plane connections (from vManage NMS only).

CLI Equivalent: show control connections

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
peer-type Optional Peer type Query String
system-ip Optional IP address of peer device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Connections History

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

CLI Equivalent: show control connections-history

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
local-color Optional Local color Query String
peer-type Optional Peer type Query String
system-ip Optional IP address of peer device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Local Properties

Display the basic configuration parameters and local properties related to the control plane (on vEdge routers, vManage NMSs, and vSmart controllers only).

CLI Equivalent: show control local-properties

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

Local Properties from vManage NMS

Display the basic configuration parameters and local properties related to the control plane (from vManage NMS only).

CLI Equivalent: show control local-properties

URL: https://vmanage-ip-address/dataservice/device/control/synced/localproperties?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 statistics about the packets that a vEdge router or vSmart controller has transmitted and received in the process of establishing and maintaining secure DTLS connections to Viptela devices in the overlay network (on vEdge routers and vSmart controllers only).

CLI Equivalent: show control statistics

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

Summary

List a count of Viptela 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.

CLI Equivalent: show control summary

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

Valid vEdge Routers

List the chassis numbers of the valid vEdge routers in the overlay network (on vSmart controllers only).

CLI Equivalent: show control valid-vedges

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

Valid vSmart Controllers

List the serial numbers of the valid vSmart controllers in the overlay network (on vEdge routers and vSmart controllers only).

CLI Equivalent: show control valid-vsmarts

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

WAN Interface

Display the basic configuration parameters and local properties related to the control plane (on vEdge routers, vManage NMSs, and vSmart controllers only).

CLI Equivalent: show control local-properties

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

WAN Interface from vManage NMS

Display the basic configuration parameters and local properties related to the control plane (from vManage NMS only).

CLI Equivalent: show control local-properties

URL: https://vmanage-ip-address/dataservice/device/control/synced/waninterface?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

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