EdgeIpSecVpnTunnel

EdgeIpSecVpnTunnel
EdgeIpSecVpnTunnel

Specifies the IPSec VPN tunnel configuration.

JSON Example 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "localEndpoint": {
        "localId": "string",
        "localAddress": "string",
        "localNetworks": [
            "string"
        ]
    },
    "remoteEndpoint": {
        "remoteId": "string",
        "remoteAddress": "string",
        "remoteNetworks": [
            "string"
        ]
    },
    "authenticationMode": "string",
    "preSharedKey": "string",
    "certificateRef": {
        "name": "string",
        "id": "string"
    },
    "caCertificateRef": {
        "name": "string",
        "id": "string"
    },
    "connectorInitiationMode": {},
    "securityType": "string",
    "logging": false,
    "version": {
        "version": 0
    }
}
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.

string
name
Required

Name for the tunnel.

string
description
Optional

description

boolean
enabled
Optional

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

LocalEndpoint
localEndpoint
Required

This represents the endpoint/IP Address on the Gateway where the tunnel needs to be terminated.

RemoteEndpoint
remoteEndpoint
Required

This represents the remote endpoint i.e. the endpoint which the tunnel from the Gateway will connect to.

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
preSharedKey
Optional

This is the Pre-shared key used for authentication.

EntityReference
certificateRef
Optional

Entity reference used to describe VCD entities

EntityReference
caCertificateRef
Optional

Entity reference used to describe VCD entities

ConnectorInitiationMode
connectorInitiationMode
Optional

This is used by a local endpoint to establish ike connection with the remote site.

Possible values are : INITIATOR, RESPOND_ONLY, ON_DEMAND,
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'.

boolean
logging
Optional

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

ObjectVersion
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.

Availability
Added in 33.0
Parameter To
Returned By