Class: Google::Apis::ComputeV1::VpnTunnel

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VpnTunnel

Returns a new instance of VpnTunnel.



69405
69406
69407
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69405

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cipher_suite ⇒ Google::Apis::ComputeV1::VpnTunnelCipherSuite

User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. Corresponds to the JSON property cipherSuite

Returns:



69193
69194
69195
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69193

def cipher_suite
  @cipher_suite
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


69199
69200
69201
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69199

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


69205
69206
69207
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69205

def description
  @description
end

#detailed_status ⇒ String

[Output Only] Detailed status message for the VPN tunnel. Corresponds to the JSON property detailedStatus

Returns:

  • (String) 


69210
69211
69212
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69210

def detailed_status
  @detailed_status
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


69216
69217
69218
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69216

def id
  @id
end

#ike_version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


69223
69224
69225
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69223

def ike_version
  @ike_version
end

#kind ⇒ String

Output only. [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. Corresponds to the JSON property kind

Returns:

  • (String) 


69229
69230
69231
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69229

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


69242
69243
69244
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69242

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


69249
69250
69251
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69249

def labels
  @labels
end

#local_traffic_selector ⇒ Array<String>

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 for Classic VPN tunnels. This field is output only for HA VPN tunnels. Corresponds to the JSON property localTrafficSelector

Returns:

  • (Array<String>) 


69258
69259
69260
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69258

def local_traffic_selector
  @local_traffic_selector
end

#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 withRFC1035. 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. Corresponds to the JSON property name

Returns:

  • (String) 


69269
69270
69271
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69269

def name
  @name
end

#params ⇒ Google::Apis::ComputeV1::VpnTunnelParams

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. Corresponds to the JSON property params

Returns:



69276
69277
69278
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69276

def params
  @params
end

#peer_external_gateway ⇒ String

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

Returns:

  • (String) 


69284
69285
69286
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69284

def peer_external_gateway
  @peer_external_gateway
end

#peer_external_gateway_interface ⇒ Fixnum

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. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type. Corresponds to the JSON property peerExternalGatewayInterface

Returns:

  • (Fixnum) 


69292
69293
69294
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69292

def peer_external_gateway_interface
  @peer_external_gateway_interface
end

#peer_gcp_gateway ⇒ String

URL of the peer side HA 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 Google Cloud VPN gateway. Corresponds to the JSON property peerGcpGateway

Returns:

  • (String) 


69302
69303
69304
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69302

def peer_gcp_gateway
  @peer_gcp_gateway
end

#peer_ip ⇒ String

IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. Corresponds to the JSON property peerIp

Returns:

  • (String) 


69308
69309
69310
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69308

def peer_ip
  @peer_ip
end

#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. Corresponds to the JSON property region

Returns:

  • (String) 


69315
69316
69317
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69315

def region
  @region
end

#remote_traffic_selector ⇒ Array<String>

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 for Classic VPN tunnels. This field is output only for HA VPN tunnels. Corresponds to the JSON property remoteTrafficSelector

Returns:

  • (Array<String>) 


69324
69325
69326
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69324

def remote_traffic_selector
  @remote_traffic_selector
end

#router ⇒ String

URL of the router resource to be used for dynamic routing. Corresponds to the JSON property router

Returns:

  • (String) 


69329
69330
69331
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69329

def router
  @router
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


69334
69335
69336
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69334

def self_link
  @self_link
end

#shared_secret ⇒ String

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. Corresponds to the JSON property sharedSecret

Returns:

  • (String) 


69340
69341
69342
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69340

def shared_secret
  @shared_secret
end

#shared_secret_hash ⇒ String

Hash of the shared secret. Corresponds to the JSON property sharedSecretHash

Returns:

  • (String) 


69345
69346
69347
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69345

def shared_secret_hash
  @shared_secret_hash
end

#status ⇒ String

[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

Returns:

  • (String) 


69381
69382
69383
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69381

def status
  @status
end

#target_vpn_gateway ⇒ String

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. Corresponds to the JSON property targetVpnGateway

Returns:

  • (String) 


69388
69389
69390
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69388

def target_vpn_gateway
  @target_vpn_gateway
end

#vpn_gateway ⇒ String

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

Returns:

  • (String) 


69396
69397
69398
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69396

def vpn_gateway
  @vpn_gateway
end

#vpn_gateway_interface ⇒ Fixnum

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1. Corresponds to the JSON property vpnGatewayInterface

Returns:

  • (Fixnum) 


69403
69404
69405
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69403

def vpn_gateway_interface
  @vpn_gateway_interface
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



69410
69411
69412
69413
69414
69415
69416
69417
69418
69419
69420
69421
69422
69423
69424
69425
69426
69427
69428
69429
69430
69431
69432
69433
69434
69435
69436
69437
 
# File 'lib/google/apis/compute_v1/classes.rb', line 69410

def update!(**args)
  @cipher_suite = args[:cipher_suite] if args.key?(:cipher_suite)
  @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)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @local_traffic_selector = args[:local_traffic_selector] if args.key?(:local_traffic_selector)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @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