OMP
API calls for real-time monitoring of OMP information:
- Multicast Auto-Discover Advertised
- Multicast Auto-Discover Received
- Multicast Routes Advertised
- Multicast Routes Received
- Peers
- Peers from vManage
- Routes Advertised
- Routes Received
- Services
- Summary
- TLOCs Advertised
- TLOCs Received
Multicast Auto-Discover Advertised
List the advertised peers that support multicast (on vEdge routers and vSmart controllers only).
CLI Equivalent: show omp multicast-auto-discover
URL: https://vmanage-ip-address/dataservice/device/omp/mcastautodiscoveradvt?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.
Multicast Auto-Discover Received
List the received peers that support multicast (on vEdge routers and vSmart controllers only).
CLI Equivalent: show omp multicast-auto-discover
URL: https://vmanage-ip-address/dataservice/device/omp/mcastautodiscoverrecv?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.
Multicast Routes Advertised
List the advertised multicast routes that OMP has learned from PIM join messages (on vEdge routers and vSmart controllers).
CLI Equivalent: show omp multicast-routes
URL: https://vmanage-ip-address/dataservice/device/omp/mcastroutesadvt?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.
Multicast Routes Received
List the received multicast routes that OMP has learned from PIM join messages (on vEdge routers and vSmart controllers).
CLI Equivalent: show omp multicast-routes
URL: https://vmanage-ip-address/dataservice/device/omp/mcastroutesrecv?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.
Peers
Display information about the OMP peering sessions that are active on the local vSmart controller or vEdge router.
CLI Equivalent: show omp peers
URL: https://vmanage-ip-address/dataservice/device/omp/peers?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.
Peers from vManage
Display information about the OMP peering sessions that are active on the local vSmart controller or vEdge router (from vManage NMS only).
CLI Equivalent: show omp peers
URL: https://vmanage-ip-address/dataservice/device/omp/synced/peers?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.
Routes Advertised
Display advertised OMP routes (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp routes
URL: https://vmanage-ip-address/dataservice/device/omp/routes/advertised?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.
Routes Received
Display received OMP routes (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp routes
URL: https://vmanage-ip-address/dataservice/device/omp/routes/received?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.
Services
Display the services learned from OMP peering sessions (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp services
URL: https://vmanage-ip-address/dataservice/device/omp/services?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.
Summary
Display information about the OMP sessions running between vSmart controllers and vEdge routers (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp summary
URL: https://vmanage-ip-address/dataservice/device/omp/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.
TLOCs Advertised
Display information learned from the TLOC routes advertised over the OMP sessions running between vSmart controllers and vEdge routers (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp tlocs
URL: https://vmanage-ip-address/dataservice/device/omp/tlocs/advertised?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.
TLOCs Received
Display information learned from the TLOC routes received over the OMP sessions running between vSmart controllers and vEdge routers (on vSmart controllers and vEdge routers only).
CLI Equivalent: show omp tlocs
URL: https://vmanage-ip-address/dataservice/device/omp/tlocs/received?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 ] }