Skip to content

ipsec_tunnels

API to get reports for IPsec Tunnels (bandwidth is in Kbps and data is in KB)

Read/write properties

Read only properties

packets_dropped<Integer>

Packets dropped.

data_dropped<Integer>

Data dropped.

service_type<String>

The type of service associated with the IPsec tunnel.

region_name<String>

The region name.

ipsec_tunnel_worst_state<String>

The IPsec tunnel worst state observed during the time period.

packets_received<Integer>

Packets received.

ipsec_tunnel_name<String>

The IPsec Tunnel name.

bandwidth_transmitted<Double>

Transmit bandwidth.

packets_transmitted<Integer>

Packets transmitted.

site_name<String>

The site name.

mtu<Integer>

The maximum transmission unit, in bytes.

bandwidth_received<Double>

Receive bandwidth.

Operations

get (all)

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

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

HTTP Method: GET

Response Payload: JSON

{"ipsec_tunnels":[{
      "packets_dropped":<Integer_value>,
      "data_dropped":<Integer_value>,
      "service_type":<String_value>,
      "region_name":<String_value>,
      "ipsec_tunnel_worst_state":<String_value>,
      "packets_received":<Integer_value>,
      "ipsec_tunnel_name":<String_value>,
      "bandwidth_transmitted":<Double_value>,
      "packets_transmitted":<Integer_value>,
      "site_name":<String_value>,
      "mtu":<Integer_value>,
      "bandwidth_received":<Double_value>}]}
Was this article helpful?