Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::VpnTunnel (v2.13.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::VpnTunnel.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#detailed_status

def detailed_status() -> ::String
Returns
  • (::String) — [Output Only] Detailed status message for the VPN tunnel.

#detailed_status=

def detailed_status=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Detailed status message for the VPN tunnel.
Returns
  • (::String) — [Output Only] Detailed status message for the VPN tunnel.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#ike_version

def ike_version() -> ::Integer
Returns
  • (::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.

#ike_version=

def ike_version=(value) -> ::Integer
Parameter
  • value (::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.
Returns
  • (::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

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Returns
  • (::String) — [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
Returns
  • (::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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

#local_traffic_selector

def local_traffic_selector() -> ::Array<::String>
Returns
  • (::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.

#local_traffic_selector=

def local_traffic_selector=(value) -> ::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#peer_external_gateway

def peer_external_gateway() -> ::String
Returns
  • (::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.

#peer_external_gateway=

def peer_external_gateway=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#peer_external_gateway_interface

def peer_external_gateway_interface() -> ::Integer
Returns
  • (::Integer) — 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.

#peer_external_gateway_interface=

def peer_external_gateway_interface=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#peer_gcp_gateway

def peer_gcp_gateway() -> ::String
Returns
  • (::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.

#peer_gcp_gateway=

def peer_gcp_gateway=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#peer_ip

def peer_ip() -> ::String
Returns
  • (::String) — IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.

#peer_ip=

def peer_ip=(value) -> ::String
Parameter
  • value (::String) — IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.
Returns
  • (::String) — IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.

#region

def region() -> ::String
Returns
  • (::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.

#region=

def region=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#remote_traffic_selector

def remote_traffic_selector() -> ::Array<::String>
Returns
  • (::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.

#remote_traffic_selector=

def remote_traffic_selector=(value) -> ::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#router

def router() -> ::String
Returns
  • (::String) — URL of the router resource to be used for dynamic routing.

#router=

def router=(value) -> ::String
Parameter
  • value (::String) — URL of the router resource to be used for dynamic routing.
Returns
  • (::String) — URL of the router resource to be used for dynamic routing.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#shared_secret

def shared_secret() -> ::String
Returns
  • (::String) — Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

#shared_secret=

def shared_secret=(value) -> ::String
Parameter
  • value (::String) — Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
Returns
  • (::String) — Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

#shared_secret_hash

def shared_secret_hash() -> ::String
Returns
  • (::String) — Hash of the shared secret.

#shared_secret_hash=

def shared_secret_hash=(value) -> ::String
Parameter
  • value (::String) — Hash of the shared secret.
Returns
  • (::String) — Hash of the shared secret.

#status

def status() -> ::String
Returns
  • (::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. Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String
Parameter
  • value (::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. Check the Status enum for the list of possible values.
Returns
  • (::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. Check the Status enum for the list of possible values.

#target_vpn_gateway

def target_vpn_gateway() -> ::String
Returns
  • (::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.

#target_vpn_gateway=

def target_vpn_gateway=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#vpn_gateway

def vpn_gateway() -> ::String
Returns
  • (::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.

#vpn_gateway=

def vpn_gateway=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#vpn_gateway_interface

def vpn_gateway_interface() -> ::Integer
Returns
  • (::Integer) — The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

#vpn_gateway_interface=

def vpn_gateway_interface=(value) -> ::Integer
Parameter
  • value (::Integer) — The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
Returns
  • (::Integer) — The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.