NSX-T Data Center REST API
IPSecVpnSessionStatisticsNsxT (schema)
IPSec VPN session statistics
Provides the following details for an IPSec VPN session for a given enforcement point:
- Aggregated IPSec tunnel statistics which includes the number of incoming, outgoing and
dropped packet counters since the time the tunnels are UP.
- Aggregated IPSec tunnel statistics under a policy which includes the number of incoming,
outgoing and dropped packet counters of all IPSec tunnels under the policy since the time the tunnels
are UP.
- Individual tunnel statistics under a policy which includes the number of incoming, outgoing
and dropped packet counters. It also provides details of errors and failures causing the drops since
the time the tunnel is UP.
- Tunnel subnet details and state of all individual tunnels under a policy.
- Alarm information details.
- VPN session name.
- IKE status summary.
Note: IKE traffic statistics are not supported.
| Name | Description | Type | Notes |
|---|---|---|---|
| aggregate_traffic_counters | IPSec VPN traffic summary Provides the aggregated traffic statistics of all IPSec tunnels since the time the tunnels are UP. It includes the number of incoming, outgoing and dropped packet counters. |
IPSecVpnTrafficCounters | Readonly |
| alarm | Alarm Information Details Alarm information details. |
PolicyRuntimeAlarm | Readonly |
| display_name | Display Name Display Name of vpn session. |
string | Readonly |
| enforcement_point_path | Enforcement point Path Policy Path referencing the enforcement point where the info is fetched. |
string | Readonly |
| ike_status | Ike status summary Status for IPSec VPN Ike session UP/DOWN and fail reason if Ike session is down. |
IPSecVpnIkeSessionStatus | Readonly |
| ike_traffic_statistics | IKE traffic statistics Provides the aggregated IKE control plane statistics for an IPSec VPN session. It includes the number of incoming, outgoing and dropped packet counters. Note: IKE traffic statistics are not supported. |
IPSecVpnIkeTrafficStatistics | Readonly |
| last_update_timestamp | Last updated timestamp Timestamp when the data was last updated. |
EpochMsTimestamp | Readonly |
| policy_statistics | Policy traffic statistics Provides the aggregated traffic statistics of all IPSec tunnels under a policy and individual tunnel statistics associated with the policy. It includes the number of incoming, outgoing and dropped packet counters and, the number of errors and failures causing the drops. The counters are from the time the tunnels are UP. The individual tunnel subnets and state along with policy path referencing the IPSec VPN Rule and IPSec VPN Tunnel Interface are also available. |
array of IpSecVpnPolicyTrafficStatistics | Readonly |
| resource_type | Must be set to the value IPSecVpnSessionStatisticsNsxT | string | Required Enum: IPSecVpnSessionStatisticsNsxT |