Get Ip Sec Vpn Tunnel Default Connection Properties

Retrieves the default connection properties that are used for a given IPSec Tunnel in when security type is default, or is unspecified.

Request

URI

GET

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

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

string

externalNetworkId

Required

externalNetworkId

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns GatewayIpSecVpnTunnelConnectionProperties of type(s) application/json;version=39.0

{
    "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.

Availability

Added in 38.1

Deprecated in 39.0

With alternative: see

/2.0.0/edgeGateways/{gatewayId}/ipsec/tunnels/presetConnectionProperties/DEFAULT endpoint

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body