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

DHCP

API calls for real-time monitoring of DHCP information:

IPv6 Interface

Display information about interfaces that are DHCPv6 clients (on vEdge routers and vSmart controllers only).

CLI Equivalent: show ipv6 dhcp interface

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

Interface

Display information about interfaces that are DHCPv4 clients (on vEdge routers and vSmart controllers only).

CLI Equivalent: show dhcp interface

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

Server

Display information about the DHCP server functionality that is enabled on the router (on vEdge routers only).

CLI Equivalent: show dhcp server

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