Get Gre Tunnel Connectivity Status

Get Gre Tunnel Connectivity Status

Retrieves the connectivity status for a GRE Tunnel on the Provider Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/greTunnels/{tunnelId}/connectivityStatus
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
tunnelId
Required

tunnelId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayGreTunnelConnectivityStatus of type(s) application/json;version=39.1 
{
    "destinationAddress": "string",
    "tunnelAddressStatuses": [
        {
            "edgeNodeRef": {
                "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                "name": "string",
                "type": "string"
            },
            "lastUpdated": "string",
            "sourceAddress": "string",
            "connectivityStatus": "string",
            "tunnelUpCount": {
                "eventCount": 0,
                "lastOccurrenceTime": "string"
            },
            "tunnelDownCount": {
                "eventCount": 0,
                "lastOccurrenceTime": "string"
            },
            "keepAliveState": "string",
            "keepAliveTransmittedCount": {
                "eventCount": 0,
                "lastOccurrenceTime": "string"
            },
            "keepAliveReceivedCount": {
                "eventCount": 0,
                "lastOccurrenceTime": "string"
            },
            "keepAliveAckCount": {
                "eventCount": 0,
                "lastOccurrenceTime": "string"
            }
        }
    ]
}
string
destinationAddress
Optional

The destination address of the GRE Tunnel.

array of tunnelAddressStatuses
tunnelAddressStatuses
Optional
Constraints: minItems: 1 maxItems: 8

The connectivity status of the GRE Tunnel for each Tunnel Address.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/greTunnels/{tunnelId}/connectivityStatus
Availability
Added in 39.0
On This Page
Provider Gateway Gre Tunnels Operations
GET
List Gre Tunnels
POST
Create Gre Tunnel
GET
Get Gre Tunnel
PUT
Update Gre Tunnel
DELETE
Delete Gre Tunnel
GET
Get Gre Tunnel Statistics
GET
Get Gre Tunnel Connectivity Status