Get Ip Sec Vpn Tunnel Status
Retrieves status of 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}/status
COPY
Path Parameters
string
externalNetworkId
Required
externalNetworkId
string
tunnelId
Required
tunnelId
string
externalNetworkId
Required
externalNetworkId
string
tunnelId
Required
tunnelId
Responses
200
OK
Returns GatewayIpSecVpnTunnelStatus of type(s) application/json;version=39.0
{
"tunnelStatus": "string",
"ikeServiceStatus": "string",
"ikeFailedReason": "string"
}
string
tunnelStatus
Optional
Gives the overall IPSec VPN Tunnel Status. If IKE is properly set and the tunnel is up, the tunnel status will be UP. Below are valid values.
UP
DOWN
DEGRADED
UNKNOWN
string
ikeServiceStatus
Optional
The status for the IPSec VPN IKE Session/Tunnel. Below are valid values.
UP
DOWN
NEGOTIATING
string
ikeFailedReason
Optional
The reason for the IKE Session establishment failure. This will only be set if ikeServiceStatus is DOWN.
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
Edge Gateway Ip Sec Vpn Tunnel Operations
DELETE
Delete Ip Sec Vpn Tunnel
GET
Get Ip Sec Vpn Tunnel
GET
Get Ip Sec Vpn Tunnel Default Connection Properties
GET
Get Ip Sec Vpn Tunnel Statistics
GET
Get Ip Sec Vpn Tunnel Status
PUT
Update Ip Sec Vpn Tunnel