BFD
API calls for real-time monitoring of BFD information:
History
Display the history of the BFD sessions running on a vEdge router (on vEdge routers only).
CLI Equivalent: show bfd history
URL: https://vmanage-ip-address/dataservice/device/bfd/history?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
| color | Optional | Remote color | Query | String |
| system-ip | Optional | Remote system IP address | Query | IPv4 |
Response Content Type: application/json
Response Object: See Response Object, below.
Sessions
Display information about the BFD sessions running on a vEdge router (on vEdge routers only).
CLI Equivalent: show bfd sessions
URL: https://vmanage-ip-address/dataservice/device/bfd/sessions?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
| color | Optional | Remote color | Query | String |
| local-color | Optional | Source color | Query | String |
| system-ip | Optional | Remote system IP address | Query | IPv4 |
Response Content Type: application/json
Response Object: See Response Object, below.
Sessions from vManage NMS
Display information about synced BFD sessions running on a vEdge router (from vManage NMS only).
URL: https://vmanage-ip-address/dataservice/device/bfd/synced/sessions?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
| color | Optional | Remote color | Query | String |
| local-color | Optional | Source color | Query | String |
| system-ip | Optional | Remote system IP address | Query | IPv4 |
Response Content Type: application/json
Response Object: See Response Object, below.
Summary
Display summary information about the BFD sessions running on a vEdge router (on vEdge routers only).
CLI Equivalent: show bfd summary
URL: https://vmanage-ip-address/dataservice/device/bfd/summary?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.
TLOC Summary
Display BFD session summary information per TLOC (on vEdge routers only).
CLI Equivalent: show bfd tloc-summary
URL: https://vmanage-ip-address/dataservice/device/bfd/tloc?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
]
}