get-tunnel-statistics
Retrieves tunnel statistics -
count of bytes and frames transmitted and received.
Resource URIs
| URI |
Description |
| <base_URI>/operations/get-tunnel-statistics |
Retrieves tunnel statistics - count of
bytes and frames transmitted and received. Output records are sorted
in ascending order of tunnel ID. |
Input Parameters
- page-cursor
- Opaque data identifying the
next page, returned by previous RPC call. RPC returns first page data if
this value is not present or empty.
- node-id
- Node from which the tunnel statistics is to be retrieved. If not specified,
data is retrieved from all nodes.
- tunnel-id-type
- Filter by tunnel ID. Output can have at most only one tunnel information.
The last-rcvd-record-id parameter is ignored.
- filter-by-mode
- Filter by tunnel mode.
- case filter-by-gateway
- Filter by overlay gateway name.
Output Parameters
- id
- Displays the tunnel ID.
- tx-frames
- Displays the number of frames transmitted.
- tx-bytes
- Displays the number of bytes transmitted
- rx-frames
- Displays the number of frames received.
- rx-bytes
- Displays the number of bytes received. Value will not be present if the
hardware does not support rx byte counter.
- next-page-cursor
- Opaque data identifying the next page. Client must pass this value as
'page-cursor' parameter in following RPC to retrieve next page tunnel data.
Value will not be present if no more tunnel records exist i.e. if current
page is the last page.
Usage Guidelines
Only POST operation is supported.
URI
http://host:80/rest/operations/get-tunnel-statistics
<get-tunnel-statistics></get-tunnel-statistics>
