EdgeL2VpnTunnel
Specifies the L2 VPN tunnel configuration.
Properties
The IP address of the local endpoint, which corresponds to the Edge Gateway the tunnel is being configured on.
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.
The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
Name for the tunnel.
The list of OrgVDC Network entity references which are currently attached to this L2VPN tunnel.
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.
Whether logging for the tunnel is enabled or not.
Described whether the tunnel is enabled or not. The default is true.
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.
This is the Pre-shared key used for authentication, no specific format is required. Relevant only for SERVER session modes.
Description for the tunnel.
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.
The list of OrgVDC Network entity references which are currently attached to this L2VPN tunnel.
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.
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.
JSON Example
{}
Vendor Extensions
x-vcloud-property-annotations:
attachedNetworks:
x-vcloud-added-in: "35.0"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-deprecated-alternative: stretchedNetworks
x-vcloud-deprecated-in: "36.0"
x-vcloud-removed-in: "36.0"
connectorInitiationMode:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
description:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
enabled:
x-vcloud-constraints:
- constraint: NonSortable
id:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
- constraint: ReadOnly
localEndpointIP:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
- args:
- arg: IPV4_IP
- arg: IPV6_IP
constraint: NetworkAddress
logging:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-deprecated-alternative: No alternative, this field has never been valid
x-vcloud-deprecated-in: "37.0"
name:
x-vcloud-constraints:
- constraint: NonSearchable
peerCode:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
preSharedKey:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
remoteEndpointIP:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
- args:
- arg: IPV4_IP
- arg: IPV6_IP
constraint: NetworkAddress
stretchedNetworks:
x-vcloud-added-in: "36.0"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
tunnelInterface:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
- args:
- arg: CIDR
constraint: NetworkAddress
version:
x-vcloud-constraints:
- constraint: ReadOnly
Availability
Property Of
InlineEdgeL2VpnTunnels1
Parameter To
Create L2 VPN Tunnel
Update L2 VPN Tunnel
Returned By
Get L2 VPN Tunnel
