Get Gre Tunnel

Get Gre Tunnel

Retrieves a specific GRE Tunnel on the Provider Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/greTunnels/{tunnelId}
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 ProviderGatewayGreTunnel of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "destinationAddress": "string",
    "tunnelAddresses": [
        {
            "sourceAddress": "string",
            "edgeNodeRef": {
                "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                "name": "string",
                "type": "string"
            },
            "tunnelInterfaces": [
                "string"
            ]
        }
    ],
    "active": false,
    "mtu": 0,
    "keepAlive": {
        "active": false,
        "sendAck": false,
        "deadMultiplier": 0,
        "interval": 0
    },
    "version": {
        "version": 0
    },
    "realizedState": {
        "status": "string"
    },
    "aggregatedConnectivityStatus": "string"
}
string
id
Optional

The unique ID of this GRE tunnel. On updates, the ID is required for the object, while for create a new ID will be generated. This ID is not a VCD URN.

string
name
Required

The name of the tunnel.

string
description
Optional

Description of the tunnel.

string
destinationAddress
Required

The destination IP Address of the tunnel. IPv4 only.

array of ProviderGatewayGreTunnelAddress
tunnelAddresses
Required

The tunnel addresses of the tunnel. Specifies the source IP address to use per edge node, for the tunnel interface. Supports IPv4 and IPv6.

boolean
active
Optional

Whether the tunnel is active. If set to null, will use the default value.

integer As int32 As int32
mtu
Optional

The maximum transmission unit (in bytes) of the tunnel. If set to null, will use the default value.

ProviderGatewayGreTunnelKeepAlive
keepAlive
Optional

The keep-alive of the tunnel. Properties set to null will use their default value.

ObjectVersion
version
Optional

This property describes the current version of the entity. To prevent clients from overwriting each other's changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

NetworkingEntityStatus
realizedState
Optional

Represents status of a networking entity.

string
aggregatedConnectivityStatus
Optional

The connectivity status of the GRE Tunnel, aggregated across Tunnel Addresses (edge nodes). One of the following:

  • UP
  • DOWN
  • UNKNOWN

Availability
Added in 39.0
On This Page
Provider Gateway Gre Tunnels Operations
POST
Create Gre Tunnel
DELETE
Delete Gre Tunnel
GET
Get Gre Tunnel
GET
Get Gre Tunnel Connectivity Status
GET
Get Gre Tunnel Statistics
GET
List Gre Tunnels
PUT
Update Gre Tunnel