NSX-T Data Center REST API

Get IPSec VPN IKE session status (Deprecated)

List status of IPSec session. Query parameter source supports both realtime and cached mode. Deprecated:
Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status

Request:

Method:
GET
URI Path(s):
/api/v1/vpn/ipsec/sessions/<session-id>/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
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+

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

Required Permissions:

read

Feature:

vpn

Additional Errors: