class Google::Apis::ComputeV1::VpnTunnel

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

Attributes

creation_timestamp[RW]
Output Only

Creation timestamp in RFC3339 text format.

Corresponds to the JSON property `creationTimestamp` @return [String]

description[RW]

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]

detailed_status[RW]
Output Only

Detailed status message for the VPN tunnel.

Corresponds to the JSON property `detailedStatus` @return [String]

id[RW]
Output Only

The unique identifier for the resource. This identifier is

defined by the server. Corresponds to the JSON property `id` @return [Fixnum]

ike_version[RW]

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. Corresponds to the JSON property `ikeVersion` @return [Fixnum]

kind[RW]
Output Only

Type of resource. Always compute#vpnTunnel for VPN tunnels.

Corresponds to the JSON property `kind` @return [String]

local_traffic_selector[RW]

Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168. 0.0/16. The ranges must be disjoint. Only IPv4 is supported. Corresponds to the JSON property `localTrafficSelector` @return [Array<String>]

name[RW]

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]*)?` 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. Corresponds to the JSON property `name` @return [String]

peer_external_gateway[RW]

URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. Corresponds to the JSON property `peerExternalGateway` @return [String]

peer_external_gateway_interface[RW]

The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Corresponds to the JSON property `peerExternalGatewayInterface` @return [Fixnum]

peer_gcp_gateway[RW]

URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. Corresponds to the JSON property `peerGcpGateway` @return [String]

peer_ip[RW]

IP address of the peer VPN gateway. Only IPv4 is supported. Corresponds to the JSON property `peerIp` @return [String]

region[RW]
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. Corresponds to the JSON property `region` @return [String]

remote_traffic_selector[RW]

Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168. 0.0/16. The ranges should be disjoint. Only IPv4 is supported. Corresponds to the JSON property `remoteTrafficSelector` @return [Array<String>]

router[RW]

URL of the router resource to be used for dynamic routing. Corresponds to the JSON property `router` @return [String]

shared_secret[RW]

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. Corresponds to the JSON property `sharedSecret` @return [String]

shared_secret_hash[RW]

Hash of the shared secret. Corresponds to the JSON property `sharedSecretHash` @return [String]

status[RW]
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. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. Corresponds to the JSON property `status` @return [String]

target_vpn_gateway[RW]

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. Corresponds to the JSON property `targetVpnGateway` @return [String]

vpn_gateway[RW]

URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. Corresponds to the JSON property `vpnGateway` @return [String]

vpn_gateway_interface[RW]

The interface ID of the VPN gateway with which this VPN tunnel is associated. Corresponds to the JSON property `vpnGatewayInterface` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/compute_v1/classes.rb, line 37373
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/compute_v1/classes.rb, line 37378
def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @detailed_status = args[:detailed_status] if args.key?(:detailed_status)
  @id = args[:id] if args.key?(:id)
  @ike_version = args[:ike_version] if args.key?(:ike_version)
  @kind = args[:kind] if args.key?(:kind)
  @local_traffic_selector = args[:local_traffic_selector] if args.key?(:local_traffic_selector)
  @name = args[:name] if args.key?(:name)
  @peer_external_gateway = args[:peer_external_gateway] if args.key?(:peer_external_gateway)
  @peer_external_gateway_interface = args[:peer_external_gateway_interface] if args.key?(:peer_external_gateway_interface)
  @peer_gcp_gateway = args[:peer_gcp_gateway] if args.key?(:peer_gcp_gateway)
  @peer_ip = args[:peer_ip] if args.key?(:peer_ip)
  @region = args[:region] if args.key?(:region)
  @remote_traffic_selector = args[:remote_traffic_selector] if args.key?(:remote_traffic_selector)
  @router = args[:router] if args.key?(:router)
  @self_link = args[:self_link] if args.key?(:self_link)
  @shared_secret = args[:shared_secret] if args.key?(:shared_secret)
  @shared_secret_hash = args[:shared_secret_hash] if args.key?(:shared_secret_hash)
  @status = args[:status] if args.key?(:status)
  @target_vpn_gateway = args[:target_vpn_gateway] if args.key?(:target_vpn_gateway)
  @vpn_gateway = args[:vpn_gateway] if args.key?(:vpn_gateway)
  @vpn_gateway_interface = args[:vpn_gateway_interface] if args.key?(:vpn_gateway_interface)
end