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

Cellular

API calls for real-time monitoring of cellular information:

Modem

Display cellular modem information and status (on vEdge routers only).

CLI Equivalent: show cellular modem

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

Network

Display cellular network information and status (on vEdge routers only).

CLI Equivalent: show cellular network

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

Profiles

Display cellular profile information and status (on vEdge routers only).

CLI Equivalent: show cellular profiles

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

Radio

Display cellular radio band information (on vEdge routers only).

CLI Equivalent: show cellular radio

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

Sessions

Display cellular session information (on vEdge routers only).

CLI Equivalent: show cellular sessions

URL: https://vmanage-ip-address/dataservice/device/cellular/sessions?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
if-name Optional Interface name Query String
ipv4-dns-pri Optional DNS primary IP Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Status

Display cellular status information (on vEdge routers only).

CLI Equivalent: show cellular status

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

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?