NSX-T Data Center REST API

Get status summary of all existing L2VPN sessions. (Deprecated)

Load all the existing L2VPN sessions and return the status summary of all L2VPN sessions. Query parameter source supports only cached mode. Deprecated:
The information is already displayed on UI.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/l2vpn/sessions/summary

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

DataSourceParameters (schema)

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/l2vpn/sessions/summary?source=cached

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

L2VPNSessionSummary+

L2VPNSessionSummary (schema)

Name	Description	Type	Notes
established_l2vpn_sessions	Established L2VPN sessions Number of established L2VPN sessions. L2VPN session is established when all the tunnels are up.	integer	Readonly
failed_l2vpn_sessions	Failed L2VPN sessions Number of failed L2VPN sessions. L2VPN session is failed when all the tunnels are down.	integer	Readonly
total_l2vpn_sessions	Total L2VPN sessions Total L2VPN sessions configured.	integer	Readonly

Example Response:

{ "total_l2vpn_sessions": 1, "failed_l2vpn_sessions": 0, "established_l2vpn_sessions": 1 }

Required Permissions:

read

Feature:

vpn

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable