Get IPSec VPN IKE session status

List status of IPSec session. Query parameter source supports both realtime and cached mode.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/sessions/<session-id>/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
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/f962173f-ac03-4d08-8366-56a41779f61d/status?source=realtime|cached

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNSessionStatus+

IPSecVPNSessionStatus (schema)

Name	Description	Type	Notes
aggregate_traffic_counters	Traffic summary Aggregate traffic statistics across all ipsec tunnels.	IPSecVPNTrafficCounters	Readonly
display_name	Display name Display name of vpn session.	string	Readonly
failed_tunnels	Failed tunnels Number of failed tunnels.	integer	Readonly
ike_status	IKE status Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE session is down.	IPSecVPNIKESessionStatus	Readonly
ipsec_vpn_session_id	Session identifier UUID of vpn session.	string	Readonly
last_update_timestamp	Last updated timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
negotiated_tunnels	Negotiated tunnels Number of negotiated tunnels.	integer	Readonly
session_status	Session status Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED.	string	Readonly Enum: UP, DOWN, DEGRADED
total_tunnels	Total tunnels Total number of tunnels.	integer	Readonly

Example Response:

{ "ipsec_vpn_session_id": "f962173f-ac03-4d08-8366-56a41779f61d", "display_name": "VPN Session", "ike_session_state": "UP", "fail_reason": "", "session_status": "UP", "total_tunnels": 10, "negotiated_tunnels": 10, "failed_tunnels": 0, "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000" }

Get IPSec VPN IKE session status

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

IPSecVPNSessionStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: