[{"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 IP Sec VPN Tunnel Connection Properties

Description

Retrieves connection properties for a given IPSec VPN Tunnel configured on an Edge Gateway.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/ipsec/tunnels/{tunnelId}/connectionProperties
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 EdgeIpSecVpnTunnelConnectionProperties of type(s) application/json;version=36.3
{
	"dpdConfiguration": {
		"probeInterval": 0
	},
	"ikeConfiguration": {
		"dhGroups": "enum",
		"digestAlgorithms": "enum",
		"encryptionAlgorithms": "enum",
		"ikeVersion": "enum",
		"saLifeTime": 0
	},
	"securityType": "string",
	"tunnelConfiguration": {
		"dfPolicy": "enum",
		"dhGroups": "enum",
		"digestAlgorithms": "enum",
		"encryptionAlgorithms": "enum",
		"perfectForwardSecrecyEnabled": false,
		"saLifeTime": 0
	}
}
dpdConfiguration Optional

The Dead Peer Detection configuration. If nothing is explictly set, the system defaults will be used.


ikeConfiguration Optional

The IKE Configuration to be used for the tunnel. If nothing is explictly set, the system defaults will be used.


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. If ‘CUSTOM’ is specified, then ike, tunnel, and dpd configurations can be set.


tunnelConfiguration Optional

The Tunnel Configuration, which contains parameters such as encryption algorithm to be used. If nothing is explicitly set, the system defaults will be used.

Errors

Errors

Error
404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/ipsec/tunnels/{tunnelId}/connectionProperties


[{"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 33.0
Edge Gateway IP Sec VPN Tunnel Connection Properties Operations
Feedback

Was this page helpful?