gre_tunnel_stats¶
Overview¶
This resource provides GRE Tunnels Statistics
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- gre_tunnel_stats : Operations related to gre_tunnel_stats
Paths¶
Get operation for gre_tunnel_stats¶
GET /gre_tunnel_stats
Description¶
Use this operation to get GRE Tunnels statistics. Filter and Pagination are supported for this API. Refer Getting Started Guide where filtering and pagination is explained via example of application monitoring API
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | gre_tunnel_stats_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_tunnel_stats
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
MTU¶
MTU of current GRE tunnel
Type : integer
destination_ip_address¶
Destination IP Address of the GRE Tunnel
Type : string
gre_tunnel_stats_delete_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnel_stats optional |
gre_tunnel_stats |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
gre_tunnel_stats_post_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnel_stats optional |
gre_tunnel_stats |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
gre_tunnel_stats_put_success_schema¶
| Name | Schema |
|---|---|
| gre_tunnel_stats optional |
gre_tunnel_stats |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
gre_tunnel_stats_response_schema¶
Type : < gre_tunnel_stats_response_schema > array
gre_tunnel_stats_response_schema
| Name | Schema |
|---|---|
| MTU optional |
MTU |
| destination_ip_address optional |
destination_ip_address |
| kbps_received optional |
kbps_received |
| kbps_sent optional |
kbps_sent |
| keepalive_reply_received optional |
keepalive_reply_received |
| keepalive_reply_sent optional |
keepalive_reply_sent |
| keepalive_request_sent optional |
keepalive_request_sent |
| name optional |
name |
| packets_dropped optional |
packets_dropped |
| packets_fragmented optional |
packets_fragmented |
| packets_received optional |
packets_received |
| packets_sent optional |
packets_sent |
| public_source_ip_address optional |
public_source_ip_address |
| routing_domain optional |
routing_domain |
| source_ip_address optional |
source_ip_address |
| state optional |
state |
| tunnel_subnet optional |
tunnel_subnet |
kbps_received¶
Total kbps received
Type : integer
kbps_sent¶
Total kbps sent
Type : integer
keepalive_reply_received¶
Keepalive reply received
Type : integer
keepalive_reply_sent¶
Keepalive reply sent
Type : integer
keepalive_request_sent¶
Keepalive Request Sent
Type : integer
name¶
Name of the GRE Tunnel
Type : string
packets_dropped¶
Total packets dropped
Type : integer
packets_fragmented¶
Total packets fragmented
Type : integer
packets_received¶
Total packets received
Type : integer
packets_sent¶
Total packets sent
Type : integer
public_source_ip_address¶
Public Source IP Address of the GRE Tunnel
Type : string
routing_domain¶
Routing Domain to which the GRE Tunnel belongs to
Type : string
source_ip_address¶
Source IP Address of the GRE Tunnel
Type : string
state¶
Current State of the GRE Tunnel
Type : string
tunnel_subnet¶
Tunnel Subnet IP Address of the GRE Tunnel
Type : string