NSX-T Data Center REST API

Get IPSec VPN session statistics under Tier-1

- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
Please note that cache synchronization is based on triggering this API with
source=realtime or empty source and not polling based.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
Request Headers:
n/a
Query Parameters:
PolicyRuntimeRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1_Server/ipsec-vpn-services/Tier-1A_IPSecVpnService/sessions/T1_Session/statistics

Successful Response:

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

Example Response:

{ "results": [ { "ike_status": { "ike_session_state": "UP", "fail_reason": "" }, "policy_statistics": [ { "rule_path": "/infra/tier-1s/TLR1_Server/ipsec-vpn-services/Tier-1A_IPSecVpnService/sessions/T1_Session/rules/f9262b9f-05c3-4906-967d-e5a31eca15d4", "tunnel_statistics": [ { "tunnel_status": "UP", "tunnel_down_reason": "", "packets_in": 0, "packets_out": 0, "bytes_in": 0, "bytes_out": 0, "packets_received_other_error": 0, "replay_errors": 0, "integrity_failures": 0, "decryption_failures": 0, "packets_sent_other_error": 0, "seq_number_overflow_error": 0, "encryption_failures": 0, "sa_mismatch_errors_in": 0, "nomatching_policy_errors": 0, "sa_mismatch_errors_out": 0, "peer_subnet": "192.168.6.0/24", "local_subnet": "192.168.3.0/24", "dropped_packets_in": 0, "dropped_packets_out": 0, "policy_id": "00003400-2000-0014-2000-001500000000" } ], "aggregate_traffic_counters": { "packets_in": 0, "packets_out": 0, "bytes_in": 0, "bytes_out": 0, "dropped_packets_in": 0, "dropped_packets_out": 0 } } ], "aggregate_traffic_counters": { "packets_in": 0, "packets_out": 0, "bytes_in": 0, "bytes_out": 0, "dropped_packets_in": 0, "dropped_packets_out": 0 }, "last_update_timestamp": 1725962384162, "display_name": "T1_Session", "enforcement_point_path": "/infra/sites/default/enforcement-points/default", "resource_type": "IPSecVpnSessionStatisticsNsxT" } ], "intent_path": "/infra/tier-1s/TLR1_Server/ipsec-vpn-services/Tier-1A_IPSecVpnService/sessions/T1_Session" }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: