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

Multicast

API calls for real-time monitoring of multicast overlay routing:

Replicator

List information about multicast replicators (on vEdge routers only).

CLI Equivalent: show multicast replicator

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

RPF

List multicast reverse-path forwarding information (on vEdge routers only).

CLI Equivalent: show multicast rpf

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

Topology

List information related to the topology of the multicast domain (on vEdge routers only).

CLI Equivalent: show multicast topology

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

Tunnel

List information about the IPsec tunnels between multicast peers (on vEdge routers only).

CLI Equivalent: show multicast tunnel

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