VPN session summary

VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/sessions/summary

Request Headers:

n/a

Query Parameters:

SessionSummaryParameters+

Name	Description	Type	Notes
site_id	Peer site id Peer site id.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

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+

Name	Description	Type	Notes
aggregate_traffic_counters	Traffic summary Aggregate traffic statistics across all selected sessions.	IPSecVPNTrafficCounters
last_update_timestamp	Last updated timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
session_summary	Session summary Session summary for number of total, established, failed and degraded IPSec VPN sessions.	IPsecVPNIKESessionSummary	Readonly
traffic_summary_per_session	Traffic summary Traffic summary per session.	array of IPSecVPNSessionTrafficSummary

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" }

VPN session summary

Request:

SessionSummaryParameters (schema)

Example Request:

Successful Response:

IPSecVPNSessionSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: