Get

Returns the specified VpnTunnel resource

3 variables
17 variables

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

vpnTunnel STRING Required

Name of the VpnTunnel resource to return

Output

This building block provides 17 output parameters

  = Parameter name
  = Format

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

An optional description of this resource. Provide this property when you create the resource

detailedStatus STRING

[Output Only] Detailed status message for the VPN tunnel

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

ikeVersion INTEGER

IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2

kind STRING

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels

localTrafficSelector[] STRING

name STRING

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash

peerIp STRING

IP address of the peer VPN gateway. Only IPv4 is supported

region STRING

[Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body

remoteTrafficSelector[] STRING

router STRING

URL of the router resource to be used for dynamic routing

selfLink STRING

[Output Only] Server-defined URL for the resource

sharedSecret STRING

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway

sharedSecretHash STRING

Hash of the shared secret

status ENUMERATION

[Output Only] The status of the VPN tunnel, which can be one of the following:

  • PROVISIONING: Resource is being allocated for the VPN tunnel.
  • WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel.
  • FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
  • ESTABLISHED: Secure session is successfully established with the peer VPN.
  • NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
  • AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
  • NEGOTIATION_FAILURE: Handshake failed.
  • DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
  • FAILED: Tunnel creation has failed and the tunnel is not ready to be used.

targetVpnGateway STRING

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created