Get Ip Sec Vpn Tunnel Connection Properties

Get Ip Sec Vpn Tunnel Connection Properties

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

Request
URI
GET
https://{api_host}/cloudapi/2.0.0/edgeGateways/{gatewayId}/ipsec/tunnels/{tunnelId}/connectionProperties
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GatewayIpSecVpnTunnelConnectionProperties of type(s) application/json;version=38.1 
{
    "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

ikeConfiguration

GatewayIpSecVpnTunnelConfig
tunnelConfiguration
Optional

tunnelConfiguration

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
On This Page
Edge Gateway Ip Sec Vpn Tunnels Version2 Operations
POST
Create Ip Sec Vpn Tunnel
DELETE
Delete Ip Sec Vpn Tunnel
GET
Get Ip Sec Vpn Tunnel
GET
Get Ip Sec Vpn Tunnel Connection Properties
GET
Get Ip Sec Vpn Tunnel Default Connection Properties
GET
Get Ip Sec Vpn Tunnels
GET
Get Ip Sec Vpn Tunnel Statistics
GET
Get Ip Sec Vpn Tunnel Status
PUT
Update Ip Sec Vpn Tunnel
PUT
Update Ip Sec Vpn Tunnel Connection Properties