Changed1
[{"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

Description

Retrieves a specific L2 VPN tunnel for a given edge gateway.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}
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 EdgeL2VpnTunnel of type(s) application/json;version=37.0
{
	"attachedNetworks": [
		{
			"id": "string",
			"name": "string"
		}
	],
	"connectorInitiationMode": "string",
	"description": "string",
	"enabled": false,
	"id": "36cc5a80-f99f-4350-b268-bb9111141a6e",
	"localEndpointIP": "string",
	"logging": false,
	"name": "string",
	"peerCode": "string",
	"preSharedKey": "string",
	"remoteEndpointIP": "string",
	"sessionMode": "string",
	"stretchedNetworks": [
		{
			"networkRef": {
				"id": "string",
				"name": "string"
			},
			"tunnelId": 0
		}
	],
	"tunnelInterface": "string",
	"version": {
		"version": 0
	}
}
string
localEndpointIP Required

The IP address of the local endpoint, which corresponds to the Edge Gateway the tunnel is being configured on.


string
sessionMode Required

The current session mode, one of either SERVER or CLIENT.

  • SERVER - In which the edge gateway acts as the server side of the L2 VPN tunnel and generates peer codes to distribute to client sessions.
  • CLIENT - In which the edge gateway receives peer codes from the server side of the L2 VPN tunnel to establish a connection.


string
remoteEndpointIP Required

The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.


string
name Required

Name for the tunnel.


array of EntityReference
attachedNetworks Optional

The list of OrgVDC Network entity references which are currently attached to this L2VPN tunnel.


string
id Optional

The unique id of this L2 VPN tunnel. On updates, the id is required for the tunnel, while for create a new id will be generated. This id is not a VCD URN.


boolean
logging Optional

Whether logging for the tunnel is enabled or not.


boolean
enabled Optional

Described whether the tunnel is enabled or not. The default is true.


string
peerCode Optional

This property is a base64 encoded string of the full configuration for the tunnel, generated by the server-side L2 VPN session. An L2 VPN client session must receive and validate this string in order to successfully establish a tunnel, but be careful sharing or storing this code since it does contain the encoded PSK. Leave this property blank if this call is being used to establish a server-side session.


string
preSharedKey Changed Optional

This is the Pre-shared key used for authentication, no specific format is required. Relevant only for SERVER session modes.


string
description Optional

Description for the tunnel.


string
connectorInitiationMode Optional

This is the mode used by the local endpoint to establish an IKE Connection with the remote site. The default is INITIATOR.

  • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
  • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
  • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.


stretchedNetworks Optional

The list of OrgVDC Network entity references which are currently attached to this L2VPN tunnel.


string
tunnelInterface Changed Optional

The network CIDR block over which the session interfaces. Relevant only for SERVER session modes. If provided, the underlying IPSec tunnel will use the specified tunnel interface. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.


version Optional

This property describes the current version of the entity. To prevent clients from overwriting each other’s changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

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}


[{"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
What's changed in v37.0?
CHANGED (1)
Changed Data Structures

Availability
Added in 35.0
Edge Gateway L2 VPN Tunnel Operations
Feedback

Was this page helpful?