NSX-T Data Center REST API

Returns the status and details of the particular CSM VPN session

Request:

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

Example Request:

GET https://<nsx-csm>/api/v1/csm/vpn/sessions/9174ffd1-41b1-42d6-a28d-05c61a0698e2/status GET https://<nsx-csm>/api/v1/csm/vpn/sessions/7344feb2-51b4-68b5-c57e-16e72b3817f3/status

Successful Response:

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

Example Response:

{ "details": { "id": "9174ffd1-41b1-42d6-a28d-05c61a0698e2", "display_name": "aws azure session 01", "source_endpoint": { "id": "vpc-12345678", "display_name": "vpc test", "endpoint_type": "AWS" }, "destination_endpoint": { "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "vnet-01", "endpoint_type": "AZURE" } }, "state": "UP", "status_message": "NSX Policy VPN sessions established" } { "details": { "id": "7344feb2-51b4-68b5-c57e-16e72b3817f3", "display_name": "aws azure session 02", "source_endpoint": { "id": "vpc-12345678", "display_name": "vpc test", "endpoint_type": "AWS" }, "destination_endpoint": { "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "vnet-01", "endpoint_type": "AZURE" } }, "state": "IN_PROGRESS", "status_message": "Configuring BGP routing on NSX Policy Tier0" }

Required Permissions:

read

Feature:

csm_vpn

Additional Errors: