PIM
API calls for real-time monitoring of protocol independent multicast (PIM):
PIM Interface List
List interfaces that are running PIM (on vEdge routers only).
CLI Equivalent: show pim interface
URL: https://vmanage-ip-address/dataservice/device/pim/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.
PIM Neighbor List
List PIM neighbors (on vEdge routers only).
CLI Equivalent: show pim neighbor
URL: https://vmanage-ip-address/dataservice/pim/neighbor?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.
PIM RP Mapping List
Display the mappings of multicast groups to RPs (on vEdge routers only).
CLI Equivalent: show pim rp-mapping
URL: https://vmanage-ip-address/dataservice/device/pim/rp-mapping?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.
PIM Statistics List
Display all PIM-related statistics on the router (on vEdge routers only).
CLI Equivalent: show pim statistics
URL: https://vmanage-ip-address/dataservice/pim/statistics?deviceId=deviceId
Method: GET/POST
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 ] }