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

State

Bulk API calls returning state information for vManage components:

BFD Sessions

Display information about BFD sessions.

CLI Equivalentshow bfd sessions

URL: https://vmanage-ip-address/dataservice/data/device/state/BFDSessions?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

BGP Neighbor

List BGP neighbors.

CLI Equivalentshow bgp neighbor

URL: https://vmanage-ip-address/dataservice/data/device/state/BGPNeighbor?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Control Connection

Display information about active control plane connections.

CLI Equivalentshow control connections

URL: https://vmanage-ip-address/dataservice/data/device/state/ControlConnection?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Control Local Property

Display the basic configuration parameters and local properties related to the control plane.

CLI Equivalentshow control local-properties

URL: https://vmanage-ip-address/dataservice/data/device/state/ControlLocalProperty

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Control WAN Interface

Display information about the WAN interface control connection.

CLI Equivalent: show interface vpn 0

URL: https://vmanage-ip-address/dataservice/data/device/state/ControlWanInterface?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Hardware Alarms

Display information about currently active hardware alarms.

CLI Equivalent: show hardware alarms

URL: https://vmanage-ip-address/dataservice/data/device/state/HardwareAlarms?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Hardware Environment

Display status information about router components, including component temperature.

CLI Equivalentshow hardware environment

URL: https://vmanage-ip-address/dataservice/data/device/state/HardwareEnvironment?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Hardware Inventory

Display an inventory of router hardware components, including serial numbers.

CLI Equivalentshow hardware inventory

URL: https://vmanage-ip-address/dataservice/data/device/state/HardwareInventory?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Interface

Display information about IPv4 interfaces.

CLI Equivalentshow interface detail

URL: https://vmanage-ip-address/dataservice/data/device/state/Interface?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2] Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

OMP Peers

Display information about active OMP peering sessions.

CLI Equivalentshow omp peers

URL: https://vmanage-ip-address/dataservice/data/device/state/OMPPeer?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

System Status

Display logging, reboot, and configuration history.

CLI Equivalentshow running-config system and show reboot history

URL: https://vmanage-ip-address/dataservice/data/device/state/SystemStatus?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

System

Display summary of the parameters configured in the system hierarchy.

CLI Equivalentshow running-config system

URL: https://vmanage-ip-address/dataservice/data/device/state/System?count=count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type

count

Yes Number of devices to query. Query Number
startId Optional Device identifier or range of device identifiers to return data from number1[:number2]. Query Number Range

Response Content Type: application/json

Response Object: See Response Object below.

Response Object for Bulk State API Calls

The bulk state API call responses have the following format:

{
   "header": {
      "generatedOn": timestamp,
      "viewKeys": {
         "uniqueKey": [
           "vdevice-dataKey"
         ],
         "preferenceKey": "display-format"
      },
      "columns": []'
      "fields": [],
   },
   "data": [
      returned data
   ],
   "pageInfo": {
      "startId": "batch:start-device-identifier",
      "endID": "batch:end-device-identifier",
      "moreEntries": (true | false),
      "count": number
   }
}

Example

Request information about the first 100 BFD sessions:

https://vmanage-ip-address/dataservice/data/device/state/BFDSessions?count=100

The following output shows the data portion for a single BFD session. The attribute recordID identifies each record, and the attribute vdevice-dataKey identifies the unique key for each record in the output. The output is returned on one line. Line breaks have been added for readability.

"data":[
{
    "recordId":"#49:11450",
    "src-ip":"184.111.20.2",
    "dst-ip":"184.118.101.2",
    "vdevice-name":"172.16.251.20",
    "color":"mpls",
    "src-port":12346,
    "createTimeStamp":1466913875186,
    "system-ip":"172.16.248.101",
    "dst-port":12346,
    "site-id":80000001,
    "transitions":0,
    "vdevice-host-name":"vm6020",
    "local-color":"mpls",
    "detect-multiplier":"7",
    "vdevice-dataKey":"172.16.251.20-mpls-172.16.248.101-mpls",
    "proto":"ipsec",
    "lastupdated":1467763286045,
    "state":"up",
    "tx-interval":1000
},

The last section in the returned data, named pageInfo, reports the range of devices for which information has been returned. The moreEntries field indicates whether more entries are present.

"pageInfo":
{
    "startId":"49:32",
    "endId":"49:11133",
    "moreEntries":true,
    "count":100
}

If more entries are present, issue a second call, specifying the startId, to view data for additional devices. For example:

https://vmanage-ip-address/dataservice/data/device/state/BFDSessions?startId=49:11134&count=100

Continue issuing similar calls until the moreEntries field returns "false".

"pageInfo":
{
    "startId":"49:32",
    "endId":"49:11439",
    "moreEntries":false,
    "count":90
}

Additional Information

Using the vManage REST API

  • Was this article helpful?