NSX Autonomous Edge REST API

Get IPSec VPN session statistics

Get statistics of a vpn session across all tunnels and IKE session.

Request:

Method:
GET
URI Path(s):
/vpn/ipsec/sessions/{session-id}/statistics
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<ip>/api/v1/vpn/ipsec/sessions/9ac3f2d8-9ba0-4e4e-8d34-2a5eb568f3e0/statistics

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IPSecVPNSessionStatistics+

Example Response:

{ "display_name": "IPSecVPN_PolicyBasesdSession_001", "policy_statistics": [ { "policy_id": "1026", "tunnel_statistics": [ { "packets_sent_other_error": 0, "packets_out": 0, "dropped_packets_out": 0, "integrity_failures": 0, "nomatching_policy_errors": 0, "sa_mismatch_errors_in": 0, "peer_subnet": "2.2.5.0/24", "replay_errors": 0, "bytes_in": 0, "local_subnet": "192.168.100.0/24", "dropped_packets_in": 0, "encryption_failures": 0, "decryption_failures": 0, "tunnel_down_reason": "", "packets_receive_other_error": 0, "bytes_out": 0, "sa_mismatch_errors_out": 0, "seq_number_overflow_error": 0, "packets_in": 0, "tunnel_status": "UP" } ], "aggregate_traffic_counters": { "packets_out": 0, "dropped_packets_out": 0, "bytes_out": 0, "dropped_packets_in": 0, "bytes_in": 0, "packets_in": 0 } } ], "partial_stats": false, "ike_status": { "fail_reason": "", "ike_session_state": "UP" }, "aggregate_traffic_counters": { "packets_out": 0, "dropped_packets_out": 0, "bytes_out": 0, "dropped_packets_in": 0, "bytes_in": 0, "packets_in": 0 }, "session_status": "UP", "failed_tunnels": 0, "negotiated_tunnels": 1, "total_tunnels": 1, "ipsec_vpn_session_id": "9ac3f2d8-9ba0-4e4e-8d34-2a5eb568f3e0" }

Required Permissions:

read

Feature:

vpn

Additional Errors: