wan_links¶
Overview¶
API to get reports for WAN links (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- wan_links : Operations related to wan_links
Paths¶
Get operation for wan_links¶
GET /wan_links
Description¶
Use this operation to get a report for WAN Links. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | wan_links_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¶
- wan_links
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
lan_to_wan_available_bandwidth¶
The LAN to WAN available Bandwidth
Type : number
lan_to_wan_bandwidth¶
The LAN to WAN bandwidth for all packet types
Type : number
lan_to_wan_bulk_bandwidth¶
The LAN to WAN bulk bandwidth
Type : number
lan_to_wan_bulk_packets¶
The LAN to WAN bulk packets
Type : integer
lan_to_wan_control_bandwidth¶
The LAN to WAN control bandwidth
Type : number
lan_to_wan_control_packets¶
The LAN to WAN control packets
Type : integer
lan_to_wan_interactive_bandwidth¶
The LAN to WAN interactive bandwidth
Type : number
lan_to_wan_interactive_packets¶
The LAN to WAN interactive packets
Type : integer
lan_to_wan_max_bandwidth¶
The maximum LAN to WAN Bandwidth for all packet types
Type : number
lan_to_wan_min_bandwidth¶
The minimum LAN to WAN Bandwidth for all packet types
Type : number
lan_to_wan_mismatched_bandwidth¶
The LAN to WAN Bandwidth not matching an MPLS Queue
Type : number
lan_to_wan_mismatched_packets¶
The LAN to WAN packets not matching an MPLS Queue
Type : integer
lan_to_wan_packets¶
The LAN to WAN packets for all packet types
Type : integer
lan_to_wan_permitted_bandwidth¶
The LAN to WAN permitted Bandwidth
Type : number
lan_to_wan_realtime_bandwidth¶
The LAN to WAN real-time bandwidth
Type : number
lan_to_wan_realtime_packets¶
The LAN to WAN real-time packets
Type : integer
region_name¶
The region name
Type : string
site_name¶
The site name
Type : string
total_available_bandwidth¶
Total available bandwidth
Type : number
total_bandwidth¶
Total bandwidth
Type : number
total_data¶
Total data
Type : number
total_permitted_bandwidth¶
Total permitted bandwidth
Type : number
wan_link_name¶
The WAN link name
Type : string
wan_links_delete_success_schema¶
| Name | Schema |
|---|---|
| wan_links optional |
wan_links |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
wan_links_post_success_schema¶
| Name | Schema |
|---|---|
| wan_links optional |
wan_links |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
wan_links_put_success_schema¶
| Name | Schema |
|---|---|
| wan_links optional |
wan_links |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
wan_links_response_schema¶
Type : < wan_links_response_schema > array
| Name | Schema |
|---|---|
| data_coverage optional |
data_coverage |
| lan_to_wan_available_bandwidth optional |
lan_to_wan_available_bandwidth |
| lan_to_wan_bandwidth optional |
lan_to_wan_bandwidth |
| lan_to_wan_bulk_bandwidth optional |
lan_to_wan_bulk_bandwidth |
| lan_to_wan_bulk_packets optional |
lan_to_wan_bulk_packets |
| lan_to_wan_control_bandwidth optional |
lan_to_wan_control_bandwidth |
| lan_to_wan_control_packets optional |
lan_to_wan_control_packets |
| lan_to_wan_interactive_bandwidth optional |
lan_to_wan_interactive_bandwidth |
| lan_to_wan_interactive_packets optional |
lan_to_wan_interactive_packets |
| lan_to_wan_max_bandwidth optional |
lan_to_wan_max_bandwidth |
| lan_to_wan_min_bandwidth optional |
lan_to_wan_min_bandwidth |
| lan_to_wan_mismatched_bandwidth optional |
lan_to_wan_mismatched_bandwidth |
| lan_to_wan_mismatched_packets optional |
lan_to_wan_mismatched_packets |
| lan_to_wan_packets optional |
lan_to_wan_packets |
| lan_to_wan_permitted_bandwidth optional |
lan_to_wan_permitted_bandwidth |
| lan_to_wan_realtime_bandwidth optional |
lan_to_wan_realtime_bandwidth |
| lan_to_wan_realtime_packets optional |
lan_to_wan_realtime_packets |
| region_name optional |
region_name |
| site_name optional |
site_name |
| total_available_bandwidth optional |
total_available_bandwidth |
| total_bandwidth optional |
total_bandwidth |
| total_data optional |
total_data |
| total_permitted_bandwidth optional |
total_permitted_bandwidth |
| wan_link_name optional |
wan_link_name |
| wan_to_lan_available_bandwidth optional |
wan_to_lan_available_bandwidth |
| wan_to_lan_bandwidth optional |
wan_to_lan_bandwidth |
| wan_to_lan_best_one_way_time_latency optional |
wan_to_lan_best_one_way_time_latency |
| wan_to_lan_best_one_way_time_max_latency_ms optional |
wan_to_lan_best_one_way_time_max_latency_ms |
| wan_to_lan_best_one_way_time_min_latency_ms optional |
wan_to_lan_best_one_way_time_min_latency_ms |
| wan_to_lan_congestion optional |
wan_to_lan_congestion |
| wan_to_lan_jitter optional |
wan_to_lan_jitter |
| wan_to_lan_loss_percent optional |
wan_to_lan_loss_percent |
| wan_to_lan_max_bandwidth optional |
wan_to_lan_max_bandwidth |
| wan_to_lan_max_loss_percent optional |
wan_to_lan_max_loss_percent |
| wan_to_lan_min_bandwidth optional |
wan_to_lan_min_bandwidth |
| wan_to_lan_min_jitter_ms optional |
wan_to_lan_min_jitter_ms |
| wan_to_lan_min_loss_percent optional |
wan_to_lan_min_loss_percent |
| wan_to_lan_mismatched_bandwidth optional |
wan_to_lan_mismatched_bandwidth |
| wan_to_lan_mismatched_packets optional |
wan_to_lan_mismatched_packets |
| wan_to_lan_ooo_percent optional |
wan_to_lan_ooo_percent |
| wan_to_lan_packets optional |
wan_to_lan_packets |
| wan_to_lan_packets_lost optional |
wan_to_lan_packets_lost |
| wan_to_lan_packets_ooo optional |
wan_to_lan_packets_ooo |
| wan_to_lan_permitted_bandwidth optional |
wan_to_lan_permitted_bandwidth |
wan_to_lan_available_bandwidth¶
The WAN to LAN available bandwidth
Type : number
wan_to_lan_bandwidth¶
The WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_best_one_way_time_latency¶
The WAN to LAN best one way time latency, in milliseconds
Type : integer
wan_to_lan_best_one_way_time_max_latency_ms¶
The maximum WAN to LAN best one way time latency in milliseconds
Type : integer
wan_to_lan_best_one_way_time_min_latency_ms¶
The minimum WAN to LAN best one way time latency in milliseconds
Type : integer
wan_to_lan_congestion¶
Congestion detected due to increased, unexpected packet flow in the WAN
Type : string
wan_to_lan_jitter¶
Maximum WAN to LAN jitter, in milliseconds
Type : integer
wan_to_lan_loss_percent¶
The WAN to LAN loss, in percent
Type : number
wan_to_lan_max_bandwidth¶
The maximum WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_max_loss_percent¶
The maximum WAN to LAN loss, in percent
Type : number
wan_to_lan_min_bandwidth¶
The minimum WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_min_jitter_ms¶
The minimum WAN to LAN jitter in milliseconds
Type : integer
wan_to_lan_min_loss_percent¶
The minimum WAN to LAN loss, in percent
Type : number
wan_to_lan_mismatched_bandwidth¶
The WAN to LAN bandwidth not matching an MPLS Queue
Type : number
wan_to_lan_mismatched_packets¶
The WAN to LAN packets not matching an MPLS Queue
Type : integer
wan_to_lan_ooo_percent¶
The WAN to LAN out-of-order, in percent
Type : number
wan_to_lan_packets¶
The WAN to LAN packets for all packet types
Type : integer
wan_to_lan_packets_lost¶
The WAN to LAN packet loss
Type : integer
wan_to_lan_packets_ooo¶
The WAN to LAN packets out-of-order
Type : integer
wan_to_lan_permitted_bandwidth¶
The WAN to LAN permitted bandwidth
Type : number