NSX-T Data Center REST API

Get IPSec VPN session statistics (Deprecated)

Get statistics of a vpn session across all tunnels and IKE session. Query parameter "source=realtime" is the only supported source. Deprecated:
Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics

Request:

Method:
GET
URI Path(s):
/api/v1/vpn/ipsec/sessions/<session-id>/statistics
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/ipsec/sessions/f962173f-ac03-4d08-8366-56a41779f61d/statistics?source=realtime

Successful Response:

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

Example Response:

{ "ipsec_vpn_session_id": "f962173f-ac03-4d08-8366-56a41779f61d", "display_name": "VPN Session", "ike_status": "{ "ike_session_state": "UP", "fail_reason": "" }", "ike_traffic_statistics": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "fail_count": "23" }", "policy_statistics": "[{ "tunnel_statistics": "{ "tunnel_status": "UP", "tunnel_down_reason": "", "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "packets_recieve_other_error": "23", "replay_errors": "1", "integrity_failures": "2", "decryption_failures": "1", "sa_expired_errors": "1", "packets_sent_other_error": "1", "seq_number_overflow_error": "1", "encryption_failures": "1" }", "policy_id": "f962173f-ac03-4d08-8366-56a41779f61d", "tunnel_port_id": "efd962173f-ac03-4d08-8366-56a41779f61d" }]", "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000", "partial_stats": false }

Required Permissions:

read

Feature:

vpn

Additional Errors: