virtual_paths¶
API to get reports for virtual paths (bandwidth is in Kbps and data is in KB)
Read/write properties¶
Read only properties¶
wan_2_lan_packets_loss<Integer>
The WAN to LAN packets lost.
wan_2_lan_packets<Integer>
The WAN to LAN packets for all packet types.
good_time<String>
The time that the service was good, in seconds.
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_mismtached_packets<Integer>
The WAN to LAN packets not matching an MPLS Queue.
lan_2_wan_bandwidth<Double>
The LAN to WAN Bandwidth for all packet types.
region_name<String>
The region name.
lan_2_wan_bulk_packets<Integer>
The LAN to WAN bulk packets.
wan_2_lan_percent_ooo<Double>
The WAN to LAN out-of-order in percent.
wan_2_lan_mismatched_bandwidth<Double>
The WAN to LAN bandwidth not matching an MPLS Queue.
wan_2_lan_percent_loss<Double>
The WAN to LAN loss, in percent.
lan_2_wan_control_packets<Integer>
The LAN to WAN control packets.
lan_2_wan_realtime_packets<Integer>
The LAN to WAN real-time packets.
virtual_path_name<String>
The virtual path name.
ipsec_worst_state<String>
The IPsec tunnel worst state observed during the time period.
down_time<String>
The time that the service was unusable, in seconds.
wan_2_lan_bandwidth<Double>
The WAN to LAN bandwidth for all packet types.
good_time_percent<Double>
The time, in percent that the service was good.
lan_2_wan_realtime_bandwidth<Double>
The LAN to WAN Realtime Bandwidth.
site_name<String>
The site name.
down_time_percent<Double>
The time, in percent that the service was unusable.
bad_time_percent<Double>
The time, in percent that the service was bad.
up_time<String>
The time that the service was usable, in seconds.
worst_state<String>
The worst state observed during the time period.
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.
bad_time<String>
The time that the service was bad, in seconds.
lan_2_wan_permitted bandwidth<Double>
The LAN to WAN permitted bandwidth.
percent_up_time<Double>
The time, in percent that the service was usable.
lan_2_wan_interactive_bandwidth<Double>
The LAN to WAN interactive bandwidth.
virtual_path_type<String>
Virtual path type ( static or dynamic).
wan_2_lan_best_one_way_time_latency_ms<Integer>
The WAN to LAN best one way time latency in milliseconds.
wan_2_lan_congestion_count<String>
Congestion detected due to increased, unexpected delay in packet flow in the WAN.
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.
wan_2_lan_max_jitter_ms<Integer>
The maximum WAN to LAN jitter in milliseconds.
Operations¶
get (all)¶
URL: http://<MGMT-IP>/sdwan_center/nitro/v1/reports/virtual_paths
Description: Use this operation to get a report for virtual paths. The response payload also contains the meta_data block.
HTTP Method: GET
Response Payload: JSON
{"virtual_paths":[{ "wan_2_lan_packets_loss":<Integer_value>, "wan_2_lan_packets":<Integer_value>, "good_time":<String_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_mismtached_packets":<Integer_value>, "lan_2_wan_bandwidth":<Double_value>, "region_name":<String_value>, "lan_2_wan_bulk_packets":<Integer_value>, "wan_2_lan_percent_ooo":<Double_value>, "wan_2_lan_mismatched_bandwidth":<Double_value>, "wan_2_lan_percent_loss":<Double_value>, "lan_2_wan_control_packets":<Integer_value>, "lan_2_wan_realtime_packets":<Integer_value>, "virtual_path_name":<String_value>, "ipsec_worst_state":<String_value>, "down_time":<String_value>, "wan_2_lan_bandwidth":<Double_value>, "good_time_percent":<Double_value>, "lan_2_wan_realtime_bandwidth":<Double_value>, "site_name":<String_value>, "down_time_percent":<Double_value>, "bad_time_percent":<Double_value>, "up_time":<String_value>, "worst_state":<String_value>, "lan_2_wan_bulk_bandwidth":<Double_value>, "wan_2_lan_packets_ooo":<Integer_value>, "bad_time":<String_value>, "lan_2_wan_permitted bandwidth":<Double_value>, "percent_up_time":<Double_value>, "lan_2_wan_interactive_bandwidth":<Double_value>, "virtual_path_type":<String_value>, "wan_2_lan_best_one_way_time_latency_ms":<Integer_value>, "wan_2_lan_congestion_count":<String_value>, "data_coverage":<Double_value>, "lan_2_wan_packets":<Integer_value>, "wan_2_lan_max_jitter_ms":<Integer_value>}]}