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.



41219
41220
41221
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41219

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

Instance Attribute Details

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


41069
41070
41071
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41069

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) 


41075
41076
41077
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41075

def description
  @description
end

#detailed_status ⇒ String

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

Returns:

  • (String) 


41080
41081
41082
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41080

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) 


41086
41087
41088
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41086

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) 


41092
41093
41094
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41092

def ike_version
  @ike_version
end

#kind ⇒ String

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

Returns:

  • (String) 


41097
41098
41099
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41097

def kind
  @kind
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. Corresponds to the JSON property localTrafficSelector

Returns:

  • (Array<String>) 


41104
41105
41106
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41104

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

Returns:

  • (String) 


41114
41115
41116
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41114

def name
  @name
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) 


41121
41122
41123
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41121

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

Returns:

  • (Fixnum) 


41127
41128
41129
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41127

def peer_external_gateway_interface
  @peer_external_gateway_interface
end

#peer_gcp_gateway ⇒ String

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

Returns:

  • (String) 


41137
41138
41139
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41137

def peer_gcp_gateway
  @peer_gcp_gateway
end

#peer_ip ⇒ String

IP address of the peer VPN gateway. Only IPv4 is supported. Corresponds to the JSON property peerIp

Returns:

  • (String) 


41142
41143
41144
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41142

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) 


41149
41150
41151
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41149

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

Returns:

  • (Array<String>) 


41156
41157
41158
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41156

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) 


41161
41162
41163
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41161

def router
  @router
end

#self_link ⇒ String

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

Returns:

  • (String) 


41166
41167
41168
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41166

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) 


41172
41173
41174
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41172

def shared_secret
  @shared_secret
end

#shared_secret_hash ⇒ String

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

Returns:

  • (String) 


41177
41178
41179
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41177

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) 


41199
41200
41201
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41199

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

Returns:

  • (String) 


41205
41206
41207
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41205

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) 


41212
41213
41214
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41212

def vpn_gateway
  @vpn_gateway
end

#vpn_gateway_interface ⇒ Fixnum

The interface ID of the VPN gateway with which this VPN tunnel is associated. Corresponds to the JSON property vpnGatewayInterface

Returns:

  • (Fixnum) 


41217
41218
41219
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41217

def vpn_gateway_interface
  @vpn_gateway_interface
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



41224
41225
41226
41227
41228
41229
41230
41231
41232
41233
41234
41235
41236
41237
41238
41239
41240
41241
41242
41243
41244
41245
41246
41247
 
# File 'lib/google/apis/compute_v1/classes.rb', line 41224

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