gre_tunnels¶
Overview¶
API to get reports for GRE Tunnels (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- gre_tunnels : Operations related to gre_tunnels
Paths¶
Get operation for gre_tunnels¶
GET /gre_tunnels
Description¶
Use this operation to get a report for GRE Tunnels. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | gre_tunnels_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- gre_tunnels
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bandwidth_received¶
Receive bandwidth
Type : number
bandwidth_transmitted¶
Transmit bandwidth
Type : number
data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
gre_tunnel_name¶
The GRE Tunnel name
Type : string
gre_tunnels_delete_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnels optional |
gre_tunnels |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
gre_tunnels_post_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnels optional |
gre_tunnels |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
gre_tunnels_put_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnels optional |
gre_tunnels |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
gre_tunnels_response_schema¶
Type : < gre_tunnels_response_schema > array
| Name | Schema |
|---|---|
| bandwidth_received optional |
bandwidth_received |
| bandwidth_transmitted optional |
bandwidth_transmitted |
| data_coverage optional |
data_coverage |
| gre_tunnel_name optional |
gre_tunnel_name |
| link_state optional |
link_state |
| mtu optional |
mtu |
| packets_dropped optional |
packets_dropped |
| packets_fragmented optional |
packets_fragmented |
| packets_received optional |
packets_received |
| packets_transmitted optional |
packets_transmitted |
| region_name optional |
region_name |
| site_name optional |
site_name |
link_state¶
The worst state observed during the time period
Type : string
mtu¶
The maximum transmission unit
Type : string
packets_dropped¶
Packets dropped
Type : integer
packets_fragmented¶
Packets fragmented
Type : string
packets_received¶
Packets received
Type : integer
packets_transmitted¶
Packets transmitted
Type : integer
region_name¶
The region name
Type : string
site_name¶
The site name
Type : string