wan_links

API to get reports for WAN links (bandwidth is in Kbps and data is in KB)

Read/write properties

Read only properties

wan_2_lan_packets<Integer>

The WAN to LAN packets for all packet types.

wan_2_lan_mismatched_packets<Integer>

The WAN to LAN packets not matching an MPLS Queue.

wan_2_lan_permitted_bandwidth<Double>

The WAN to LAN permitted bandwidth.

lan_2_wan_interactive_packets<Integer>

The LAN to WAN interactive packets.

lan_2_wan_control_bandwidth<Double>

The LAN to WAN control bandwidth.

wan_2_lan_available_bandwidth<Double>

The WAN to LAN available bandwidth.

lan_2_wan_bandwidth<Double>

The LAN to WAN bandwidth for all packet types.

total_permitted_bandwidth<Double>

Total permitted bandwidth.

region_name<String>

The region name.

wan_2_lan_loss_percent<Double>

The WAN to LAN loss, in percent.

lan_2_wan_mismatched_bandwidth<Double>

The LAN to WAN Bandwidth not matching an MPLS Queue.

total_bandwidth<Double>

Total bandwidth.

wan_2_lan_best_one_way_time_latency<Integer>

The WAN to LAN best one way time latency, in milliseconds.

lan_2_wan_bulk_packets<Integer>

The LAN to WAN bulk packets.

wan_2_lan_jitter<Integer>

Maximum WAN to LAN jitter, in milliseconds.

wan_2_lan_mismatched_bandwidth<Double>

The WAN to LAN bandwidth not matching an MPLS Queue.

lan_2_wan_control_packets<Integer>

The LAN to WAN control packets.

lan_2_wan_mismatched_packets<Integer>

The LAN to WAN packets not matching an MPLS Queue.

wan_2_lan_packets_lost<Integer>

The WAN to LAN packet loss.

lan_2_wan_realtime_packets<Integer>

The LAN to WAN real-time packets.

lan_2_wan_available_bandwidth<Double>

The LAN to WAN available Bandwidth.

wan_2_lan_congestion<String>

Congestion detected due to increased, unexpected packet flow in the WAN.

wan_2_lan_bandwidth<Double>

The WAN to LAN bandwidth for all packet types.

lan_2_wan_realtime_bandwidth<Double>

The LAN to WAN real-time bandwidth.

site_name<String>

The site name.

lan_2_wan_bulk_bandwidth<Double>

The LAN to WAN bulk bandwidth.

wan_2_lan_packets_ooo<Integer>

The WAN to LAN packets out-of-order.

lan_2_wan_permitted_bandwidth<Double>

The LAN to WAN permitted Bandwidth.

total_available_bandwidth<Double>

Total available bandwidth.

total_data<Double>

Total data.

lan_2_wan_interactive_bandwidth<Double>

The LAN to WAN interactive bandwidth.

wan_link_name<String>

The WAN link name.

wan_2_lan_ooo_percent<Double>

The WAN to LAN out-of-order, in percent.

data_coverage<Double>

The amount, in percent of the selected time period for which there is data.

lan_2_wan_packets<Integer>

The LAN to WAN packets for all packet types.

Operations

get (all)

URL: http://<MGMT-IP>/sdwan_center/nitro/v1/reports/wan_links

Description: Use this operation to get a report for WAN Links. The response payload also contains the meta_data block.

HTTP Method: GET

Response Payload: JSON

{"wan_links":[{
      "wan_2_lan_packets":<Integer_value>,
      "wan_2_lan_mismatched_packets":<Integer_value>,
      "wan_2_lan_permitted_bandwidth":<Double_value>,
      "lan_2_wan_interactive_packets":<Integer_value>,
      "lan_2_wan_control_bandwidth":<Double_value>,
      "wan_2_lan_available_bandwidth":<Double_value>,
      "lan_2_wan_bandwidth":<Double_value>,
      "total_permitted_bandwidth":<Double_value>,
      "region_name":<String_value>,
      "wan_2_lan_loss_percent":<Double_value>,
      "lan_2_wan_mismatched_bandwidth":<Double_value>,
      "total_bandwidth":<Double_value>,
      "wan_2_lan_best_one_way_time_latency":<Integer_value>,
      "lan_2_wan_bulk_packets":<Integer_value>,
      "wan_2_lan_jitter":<Integer_value>,
      "wan_2_lan_mismatched_bandwidth":<Double_value>,
      "lan_2_wan_control_packets":<Integer_value>,
      "lan_2_wan_mismatched_packets":<Integer_value>,
      "wan_2_lan_packets_lost":<Integer_value>,
      "lan_2_wan_realtime_packets":<Integer_value>,
      "lan_2_wan_available_bandwidth":<Double_value>,
      "wan_2_lan_congestion":<String_value>,
      "wan_2_lan_bandwidth":<Double_value>,
      "lan_2_wan_realtime_bandwidth":<Double_value>,
      "site_name":<String_value>,
      "lan_2_wan_bulk_bandwidth":<Double_value>,
      "wan_2_lan_packets_ooo":<Integer_value>,
      "lan_2_wan_permitted_bandwidth":<Double_value>,
      "total_available_bandwidth":<Double_value>,
      "total_data":<Double_value>,
      "lan_2_wan_interactive_bandwidth":<Double_value>,
      "wan_link_name":<String_value>,
      "wan_2_lan_ooo_percent":<Double_value>,
      "data_coverage":<Double_value>,
      "lan_2_wan_packets":<Integer_value>}]}