NSX-T Data Center REST API

VPN session summary (Deprecated)

VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode. Deprecated:
The information is already displayed on UI.

Request:

Method:
GET
URI Path(s):
/api/v1/vpn/ipsec/sessions/summary
Request Headers:
n/a
Query Parameters:
SessionSummaryParameters+
Request Body:
n/a

Example Request:

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

Successful Response:

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

Example Response:

{ "session_summary": "{ "established_sessions": 1, "failed_sessions": 0, "degraded_sessions": 0, "total_sessions": 1 }", "traffic_summary_per_session": "[{ "traffic_stats": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "ipsec_vpn_session": "{ "target_display_name": "4630aadd-25d7-4c73-b03c-227ac314dfc4", "is_valid": true, "target_type": "LogicalRouter", "target_id": "4630aadd-25d7-4c73-b03c-227ac314dfc4" }", }]", "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000" }

Required Permissions:

read

Feature:

vpn

Additional Errors: