Management Plane API > Networking > VPN > Statistics > L2VPN Session Status

Get L2VPN session status

Aggregated status of L2VPN session. Query parameter source=realtime|cached is supported.

Request:

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

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/l2vpn/sessions/f962173f-ac03-4d08-8366-56a41779f61d/status?source=realtime|cached

Successful Response:

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

Example Response:

{ "session_id": "1f74abad-caec-4889-87e3-ebe9dfa1ad24", "transport_tunnels": [ { "tunnel_id": { "target_id": "94e03cc2-92f3-4b9b-a3b7-65cd2252cfcd" }, "tunnel_type": "IPSecVPNSession", "status": { "ike_status": { "ike_session_state": "NEGOTIATING", "fail_reason": "Unknown" }, "aggregate_traffic_counters": { "bytes_out": 0, "dropped_packets_in": 0, "packets_out": 0, "bytes_in": 0, "packets_in": 0, "dropped_packets_out": 0 }, "total_tunnels": 0, "failed_tunnels": 0, "last_update_timestamp": 1522734083907, "negotiated_tunnels": 0, "ipsec_vpn_session_id": "94e03cc2-92f3-4b9b-a3b7-65cd2252cfcd", "session_status": "DOWN" } } ], "display_name": "l2vpnsession", "status": "UP" }

Required Permissions:

read

Feature:

vpn

Additional Errors: