NSX-T Data Center REST API

Get the Realized State of a IPSec VPN Session (Deprecated)

Return realized state information of a ipsec vpn session.
Any configuration update that affects the ipsec vpn session can use this API
to get its realized state by passing a request_id returned by the
configuration change operation. e.g. Update configuration of ipsec vpn session,
service, endpoints, profiles, etc.
It will return a service disabled error, if the ipsec vpn service associated
with the session is disabled.
Deprecated:
Please use below Policy APIs.
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>

Request:

Method:
GET
URI Path(s):
/api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/state
Request Headers:
n/a
Query Parameters:
RealizationStateQueryParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/ipsec/sessions/f962173f-ac03-4d08-8366-56a41779f61d/state

Successful Response:

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

Example Response:

{ "details": [ { "sub_system_type": "TransportNode", "sub_system_id": "fe651e63-04bd-43a4-a8ec-45381a3b71b9", "state": "in_progress", "failure_message": "CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node." }, { "sub_system_type": "TransportNode", "sub_system_id": "ebe174ac-e4f1-4135-ba72-3dd2eb7099e3", "state": "in_sync" } ], "state": "in_progress", "failure_message": "The state realization is in progress at transport nodes." }

Required Permissions:

read

Feature:

vpn

Additional Errors: