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/1.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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 33.0
On This Page
Edge Gateway Ip Sec Vpn Tunnel Connection Properties Operations
GET
Get Ip Sec Vpn Tunnel Connection Properties
PUT
Update Ip Sec Vpn Tunnel Connection Properties