Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Orchestrator

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

Connections

List the Viptela devices that have active DTLS connections to the vBond orchestrator (on vBond orchestrators only).

CLI Equivalent: show orchestrator connections

URL: https://vmanage-ip-address/dataservice/device/orchestrator/connections?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 History

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

CLI Equivalent: show orchestrator connections-history

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

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

CLI Equivalent: show orchestrator local-properties

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

Summary

Display a count of the vEdge routers, vManage Network Management Systems (NMSs), and vSmart 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.

CLI Equivalent: show orchestrator summary

URL: https://vmanage-ip-address/dataservice/device/orchestrator/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 vBond orchestrators only).

CLI Equivalent: show orchestrator valid-vedges

URL: https://vmanage-ip-address/dataservice/device/orchestrator/validvedges?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 vBond orchestrators only).

CLI Equivalent: show orchestrator valid-vsmarts

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