EdgeIpSecVpnTunnel

Specifies the IPSec VPN tunnel configuration.


Properties

localEndpoint Required

The Local Endpoint which corresponds to the Edge Gateway the tunnel is being configured on. Local Endpoint requires an IP. That IP must be suballocated to the edge gateway.


remoteEndpoint Required

The Remote Endpoints correspoinds to the device on the remote site terminating the VPN tunnel.


string
name Required

Name for the tunnel.


string
authenticationMode Optional

The authentication mode this IPSec tunnel will use to authenticate with the peer endpoint. The default is a pre-shared key (PSK).

  • PSK - A known key is shared between each site before the tunnel is established.
  • CERTIFICATE - Incoming connections are required to present an identifying digital certificate, which VCD verifies has been signed by a trusted certificate authority.


string
description Optional
Description not available

boolean
enabled Optional

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


string
id Optional

The unique id of this IPSec VPN tunnel. On updates, the id is required for the tunnel, while for create a new id will be generated.


connectorInitiationMode Optional

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


boolean
logging Optional

Whether logging for the tunnel is enabled or not. The default is false.


certificateRef Optional

The server certificate which will be used to secure the tunnel’s local endpoint. The certificate must be the end-entity certificate (leaf) for the local endpoint.


string
preSharedKey Optional

This is the Pre-shared key used for authentication.


caCertificateRef Optional

The certificate authority used to verify the remote endpoint’s certificate. The selected CA must be a root or intermediate CA. The selected CA should be able to directly verify the remote endpoint’s certificate.


string
securityType Optional

This is the security type used for the IPSec Tunnel. If nothing is specified, this will be set to ‘DEFAULT’ in which the default settings in NSX will be used. For custom settings, one should use the connectionProperties endpoint to specify custom settings. The security type will then appropriately reflect itself as ‘CUSTOM’.


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.

JSON Example

{
	"localEndpoint": {
		"localAddress": "string",
		"localNetworks": [
			"string"
		]
	},
	"name": "string",
	"remoteEndpoint": {
		"remoteAddress": "string"
	}
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
  authenticationMode:
    x-vcloud-added-in: "35.0"
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  caCertificateRef:
    x-vcloud-added-in: "36.0"
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  certificateRef:
    x-vcloud-added-in: "36.0"
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  connectorInitiationMode:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  description:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  enabled:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  id:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  localEndpoint:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  logging:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  name:
    x-vcloud-constraints:
    - constraint: NonSearchable
  preSharedKey:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  remoteEndpoint:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  securityType:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
Availability
Added in 33.0
Property Of

InlineEdgeIpSecVpnTunnels
Parameter To

Create IP Sec VPN Tunnel
Update IP Sec VPN Tunnel
Returned By

Get IP Sec VPN Tunnel

Feedback

Was this page helpful?