Update Ip Sec Vpn Tunnel Connection Properties

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

Request

URI

PUT

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

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

string

tunnelId

Required

tunnelId

string

externalNetworkId

Required

externalNetworkId

string

tunnelId

Required

tunnelId

Request Body

GatewayIpSecVpnTunnelConnectionProperties of type(s) application/json

Optional

{
    "securityType": "string",
    "ikeConfiguration": {
        "ikeVersion": "string",
        "dhGroups": [
            "string"
        ],
        "digestAlgorithms": [
            "string"
        ],
        "encryptionAlgorithms": [
            "string"
        ],
        "saLifeTime": 0
    },
    "tunnelConfiguration": {
        "perfectForwardSecrecyActive": false,
        "dfPolicy": "string",
        "dhGroups": [
            "string"
        ],
        "digestAlgorithms": [
            "string"
        ],
        "encryptionAlgorithms": [
            "string"
        ],
        "saLifeTime": 0
    },
    "dpdProbeInterval": 0
}

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.

GatewayIpSecVpnTunnelIkeConfig

ikeConfiguration

Optional

This configuration captures the IKE and phase one negotiation parameters. This configuration can be set for peering properly with remote peers.

GatewayIpSecVpnTunnelConfig

tunnelConfiguration

Optional

This configuration captures phase two negotiation parameters and tunnel properties.

integer

dpdProbeInterval

Optional

Specifies the Dead Peer Detection Profile. This configuration determines the number of seconds to wait in time between probes to detect if an IPSec peer is alive or not. The minimum is 3 seconds, and the maximum is 60 seconds. If unset, the system default of 60 seconds will be used.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

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

Operation doesn't return any data structure

Availability

Added in 38.1

On This Page

Description

Request