NSX-T Data Center REST API

Get IPSec VPN Session Summary

Summarized view of all tier-1 IPSec VPN sessions for a specified service.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary
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/summary

Successful Response:

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

Example Response:

{ "ipsec_vpn_service_path": "/infra/tier-1s/TLR1_Server/ipsec-vpn-services/Tier-1A_IPSecVpnService", "display_name": "Tier-1A_IPSecVpnService", "session_summary": { "established_sessions": 1, "failed_sessions": 0, "degraded_sessions": 0, "total_sessions": 1 }, "aggregate_traffic_counters": { "packets_in": 0, "packets_out": 0, "bytes_in": 0, "bytes_out": 0, "dropped_packets_in": 0, "dropped_packets_out": 0 }, "traffic_summary_per_session": [ { "traffic_counters": { "packets_in": 0, "packets_out": 0, "bytes_in": 0, "bytes_out": 0, "dropped_packets_in": 0, "dropped_packets_out": 0 }, "ipsec_vpn_session": { "target_id": "/infra/tier-1s/TLR1_Server/ipsec-vpn-services/Tier-1A_IPSecVpnService/sessions/T1_Session", "target_type": "IpSecVpnSessionConfig", "is_valid": true } } ], "last_update_timestamp": 1725962694302 }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: