NSX-T Data Center REST API

Returns the statuses of the CSM VPN sessions.

Request:

Method:
GET
URI Path(s):
/api/v1/csm/vpn/sessions/status
Request Headers:
n/a
Query Parameters:
CsmVpnSessionStatusListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/vpn/sessions/status

Successful Response:

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

Example Response:

{ "cursor": "0008236", "sort_ascending": true, "result_count": 2, "resource_type": "CsmVpnSessionStatusListResult", "results": [ { "details": { "id": "9174ffd1-41b1-42d6-a28d-05c61a0698e2", "display_name": "aws azure session 01", "source_endpoint": { "id": "vpc-12345678", "display_name": "vpc-02", "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": "8154ffd1-41b1-42d6-a28d-05c61a0697g2", "display_name": "azure aws session 02", "source_endpoint": { "id": "42935e4d-ff7c-433a-a59c-85ab5559cda2", "display_name": "Vnet-WA-4", "endpoint_type": "AZURE" }, "destination_endpoint": { "id": "vpc-87654321", "display_name": "vpc-01", "endpoint_type": "AWS" } }, "status": "DOWN", "status_message": "Failed to create NSX Policy IPSec VPN sessions" } ], "_last_modified_user": "admin", "_last_modified_time": 1435284879143, "_create_time": 1435284566908, "_create_user": "admin", "_revision": 1 }

Required Permissions:

read

Feature:

csm_vpn

Additional Errors: