[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get L2 VPN Tunnel Status

Description

Retrieves status of a given L2 VPN Tunnel.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/status
Copy

Path Parameters

Path Parameters

string
gatewayId Required

string
tunnelId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns EdgeL2VpnTunnelStatus of type(s) application/json;version=36.3
{
	"failureReason": "string",
	"runtimeStatus": "string"
}
string
failureReason Optional

The error message which led to this tunnel’s failure (if applicable).


string
runtimeStatus Optional

Gives the overall L2 VPN Runtime Status (one of either UP or DOWN).

  • UP - Indicating that the tunnel connection has been successfully established.
  • DOWN - Indicating that the tunnel connection has not yet been successfully established.

Errors

Errors

404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/status


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 35.0
Edge Gateway L2 VPN Tunnel Operations
Feedback

Was this page helpful?