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>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary

Request Headers:

n/a

Query Parameters:

PolicyRuntimeRequestParameters+

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/locale-services/TIER1_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc/summary

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyIpsecVpnIkeServiceSummary+

Name	Description	Type	Notes
aggregate_traffic_counters	Traffic summary Aggregate traffic statistics across all selected sessions.	IPSecVPNTrafficCounters
display_name	Display name of IPSec VPN service	string	Readonly
ipsec_vpn_service_path	Policy path of IPSec VPN service	string	Readonly
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:

{ "ipsec_vpn_service_path": "/infra/tier-1s/TLR1_LR/locale-services/TIER1_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc", "display_name": "test-ipsec-svc", "session_summary": { "established_sessions": 0, "failed_sessions": 1, "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_LR/locale-services/TIER1_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc/sessions/2a30271f-a856-4168-9097-b5955f40d446", "target_type": "IPSecVPNSession", "is_valid": true } } ] }

Get IPSec VPN Session Summary

Request:

PolicyRuntimeRequestParameters (schema)

Example Request:

Successful Response:

PolicyIpsecVpnIkeServiceSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: