paths¶
API to get reports for paths (bandwidth is in Kbps and data is in KB)
Read/write properties¶
Read only properties¶
wan_2_lan_packets<String>
WAN to LAN packets for all packet types.
lan_2_wan_down_time<String>
The total time in the selected time period that the service was unusable, in seconds.
lan_2_wan_worst_state<String>
The worst LAN to WAN state observed during the time period.
wan_2_lan_bad_silence_time<String>
The total time in the selected time period that the service was bad because silence time exceeded threshold, in seconds.
wan_2_lan_percent_down_time<String>
The time, in percent that the service was unusable.
lan_2_wan_bandwidth<Double>
The LAN to WAN bandwidth for all packet types.
lan_2_wan_percent_good_time<String>
The time, in percent that the service was good.
lan_2_wan_congestion<String>
Congestion detected due to increased, unexpected delay in packet flow in the WAN.
lan_2_wan_percent_dead_silence_time<String>
The time, in percent that the service was dead because silence time exceeded threshold.
lan_2_wan_percent_dead_peer_time<String>
The time, in percent that the service was dead because notified by peer.
lan_2_wan_bulk_packets<Integer>
The LAN to WAN bulk packets.
wan_2_lan_mismatched_bandwidth<Double>
WAN to LAN bandwidth not matching an MPLS Queue.
wan_2_lan_percent_loss<Double>
WAN to LAN loss, in percent.
lan_2_wan_data_coverage<Double>
The amount, in percent of the selected time period for which there is data.
maximum_transmission_unit<Integer>
The maximum transmission unit, in bytes.
wan_2_lan_packets_lost<Integer>
WAN to LAN packets lost.
lan_2_wan_state_dead_silence_time<String>
The total time in the selected time period that the service was dead because silence time exceeded threshold, in seconds.
wan_2_lan_percent_dead_silence_time<String>
The time, in percent that the service was dead because silence time exceeded threshold.
wan_2_lan_congestion<String>
Congestion detected due to increased, unexpected delay in packet flow in the WAN.
wan_2_lan_bandwidth<Double>
WAN to LAN bandwidth for all packet types.
lan_2_wan_worst_state_reason<String>
The reason for the worst state observed during the time period.
lan_2_wan_realtime_bandwidth<Double>
The LAN to WAN real-time bandwidth.
wan_2_lan_percent_up_time<String>
The time, in percent that the service was usable.
wan_2_lan_percent_bad_silence_time<String>
The time, in percent that the service was bad because silence time exceeded threshold.
wan_2_lan_percent_good_time<String>
The time, in percent that the service was good.
wan_2_lan_state_dead_silence_time<String>
The total time in the selected time period that the service was dead because silence time exceeded threshold, in seconds.
wan_2_lan_best_one_way_time_latency_ms<Integer>
WAN to LAN best one way time latency in milliseconds.
wan_2_lan_worst_state_reason<String>
The reason for the worst state observed during the time period.
lan_2_wan_bad_time<String>
The total time in the selected time period that the service was bad, in seconds.
wan_2_lan_good_time<String>
The total time in the selected time period that the service was good, in seconds.
wan_2_lan_jitter_ms<Integer>
WAN to LAN jitter in milliseconds.
to_destination_port<Integer>
The configured Destination UDP port.
lan_2_wan_percent_bad_silence_time<String>
The time, in percent that the service was bad because silence time exceeded threshold.
lan_2_wan_percent_up_time<String>
The time, in percent that the service was usable.
wan_2_lan_mismatched_packets<Integer>
WAN to LAN packets not matching an MPLS Queue.
to_site_name<String>
To site name.
from_wanlink_name<String>
From wanlink name.
lan_2_wan_state_bad_silence_time<String>
The total time in the selected time period that the service was bad because silence time exceeded threshold, in seconds.
lan_2_wan_interactive_packets<Integer>
The LAN to WAN interactive packets.
lan_2_wan_control_bandwidth<Double>
The LAN to WAN control bandwidth.
lan_2_wan_good_time<String>
The total time in the selected time period that the service was good, in seconds.
lan_2_wan_up_time<String>
The total time in the selected time period that the service was usable, in seconds.
wan_2_lan_down_time<String>
The total time in the selected time period that the service was unusable, in seconds.
wan_2_lan_percent_bad_loss_time<String>
The time, in percent that the service was bad because packet loss exceeded threshold.
to_external_destination_port<Integer>
The external destination UDP port, as observed by remote sites.
region_name<String>
The region name.
from_site_name<String>
From site name.
wan_2_lan_data_coverage<Double>
The amount, in percent of the selected time period for which there is data.
wan_2_lan_percent_ooo<Double>
WAN to LAN out-of-order, in percent.
lan_2_wan_dead_peer_time<String>
The total time in the selected time period that the service was dead because notified by peer, in seconds.
lan_2_wan_state_bad_peer_time<String>
The total time in the selected time period that the service was bad because notified by peer, in seconds.
to_wanlink_name<String>
To wanlink name.
lan_2_wan_percent_down_time<String>
The time, in percent that the service was unusable.
lan_2_wan_control_packets<Integer>
The LAN to WAN control packets.
path_name<String>
The path name.
lan_2_wan_realtime_packets<Integer>
The LAN to WAN real-time packets.
lan_2_wan_percent_bad_time<String>
The time, in percent that the service was bad.
from_source_port<Integer>
The configured source UDP port.
wan_2_lan_bad_time<String>
The total time in the selected time period that the service was bad, in seconds.
lan_2_wan_bulk_bandwidth<Double>
The LAN to WAN bulk bandwidth.
wan_2_lan_packets_ooo<Integer>
WAN to LAN packets out-of-order.
wan_2_lan_up_time<String>
The total time in the selected time period that the service was usable, in seconds.
from_external_source_port<Integer>
The external source UDP port, as observed by remote sites.
wan_2_lan_bad_loss_time<String>
The total time in the selected time period that the service was bad because packet loss exceeded threshold, in seconds.
lan_2_wan_interactive_bandwidth<Double>
The LAN to WAN interactive bandwidth.
lan_2_wan_percent_bad_peer_time<String>
The time, in percent that the service was bad because notified by peer.
lan_2_wan_packets<Integer>
LAN to WAN packets for all packet types.
wan_2_lan_worst_state<String>
The worst WAN to LAN state observed during the time period.
Operations¶
get (all)¶
URL: http://<MGMT-IP>/sdwan_center/nitro/v1/reports/paths
Description: Use this operation to get a report for paths. The response payload also contains the meta_data block.
HTTP Method: GET
Response Payload: JSON
{"paths":[{ "wan_2_lan_packets":<String_value>, "lan_2_wan_down_time":<String_value>, "lan_2_wan_worst_state":<String_value>, "wan_2_lan_bad_silence_time":<String_value>, "wan_2_lan_percent_down_time":<String_value>, "lan_2_wan_bandwidth":<Double_value>, "lan_2_wan_percent_good_time":<String_value>, "lan_2_wan_congestion":<String_value>, "lan_2_wan_percent_dead_silence_time":<String_value>, "lan_2_wan_percent_dead_peer_time":<String_value>, "lan_2_wan_bulk_packets":<Integer_value>, "wan_2_lan_mismatched_bandwidth":<Double_value>, "wan_2_lan_percent_loss":<Double_value>, "lan_2_wan_data_coverage":<Double_value>, "maximum_transmission_unit":<Integer_value>, "wan_2_lan_packets_lost":<Integer_value>, "lan_2_wan_state_dead_silence_time":<String_value>, "wan_2_lan_percent_dead_silence_time":<String_value>, "wan_2_lan_congestion":<String_value>, "wan_2_lan_bandwidth":<Double_value>, "lan_2_wan_worst_state_reason":<String_value>, "lan_2_wan_realtime_bandwidth":<Double_value>, "wan_2_lan_percent_up_time":<String_value>, "wan_2_lan_percent_bad_silence_time":<String_value>, "wan_2_lan_percent_good_time":<String_value>, "wan_2_lan_state_dead_silence_time":<String_value>, "wan_2_lan_best_one_way_time_latency_ms":<Integer_value>, "wan_2_lan_worst_state_reason":<String_value>, "lan_2_wan_bad_time":<String_value>, "wan_2_lan_good_time":<String_value>, "wan_2_lan_jitter_ms":<Integer_value>, "to_destination_port":<Integer_value>, "lan_2_wan_percent_bad_silence_time":<String_value>, "lan_2_wan_percent_up_time":<String_value>, "wan_2_lan_mismatched_packets":<Integer_value>, "to_site_name":<String_value>, "from_wanlink_name":<String_value>, "lan_2_wan_state_bad_silence_time":<String_value>, "lan_2_wan_interactive_packets":<Integer_value>, "lan_2_wan_control_bandwidth":<Double_value>, "lan_2_wan_good_time":<String_value>, "lan_2_wan_up_time":<String_value>, "wan_2_lan_down_time":<String_value>, "wan_2_lan_percent_bad_loss_time":<String_value>, "to_external_destination_port":<Integer_value>, "region_name":<String_value>, "from_site_name":<String_value>, "wan_2_lan_data_coverage":<Double_value>, "wan_2_lan_percent_ooo":<Double_value>, "lan_2_wan_dead_peer_time":<String_value>, "lan_2_wan_state_bad_peer_time":<String_value>, "to_wanlink_name":<String_value>, "lan_2_wan_percent_down_time":<String_value>, "lan_2_wan_control_packets":<Integer_value>, "path_name":<String_value>, "lan_2_wan_realtime_packets":<Integer_value>, "lan_2_wan_percent_bad_time":<String_value>, "from_source_port":<Integer_value>, "wan_2_lan_bad_time":<String_value>, "lan_2_wan_bulk_bandwidth":<Double_value>, "wan_2_lan_packets_ooo":<Integer_value>, "wan_2_lan_up_time":<String_value>, "from_external_source_port":<Integer_value>, "wan_2_lan_bad_loss_time":<String_value>, "lan_2_wan_interactive_bandwidth":<Double_value>, "lan_2_wan_percent_bad_peer_time":<String_value>, "lan_2_wan_packets":<Integer_value>, "wan_2_lan_worst_state":<String_value>}]}