[{"label":"Latest (v36.3)","version":"latest"},{"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

Update IP Sec VPN Tunnel Connection Properties

Description

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

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
gatewayId Required

string
tunnelId Required

Request Body

Request Body

EdgeIpSecVpnTunnelConnectionProperties of type(s) application/json Required
{
	"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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

400

Invalid configuration.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"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}}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/ipsec/tunnels/{tunnelId}/connectionProperties


[{"label":"Latest (v36.3)","version":"latest"},{"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?