Class VpnTunnel (1.5.0)

Version 1.5.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

VpnTunnel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name	Description
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ ``_creation_timestamp``.
description	str An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ ``_description``.
detailed_status	str [Output Only] Detailed status message for the VPN tunnel. This field is a member of `oneof`_ ``_detailed_status``.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ ``_id``.
ike_version	int 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. This field is a member of `oneof`_ ``_ike_version``.
kind	str [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. This field is a member of `oneof`_ ``_kind``.
local_traffic_selector	Sequence[str] 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.
name	str 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. This field is a member of `oneof`_ ``_name``.
peer_external_gateway	str 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. This field is a member of `oneof`_ ``_peer_external_gateway``.
peer_external_gateway_interface	int 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. This field is a member of `oneof`_ ``_peer_external_gateway_interface``.
peer_gcp_gateway	str 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. This field is a member of `oneof`_ ``_peer_gcp_gateway``.
peer_ip	str IP address of the peer VPN gateway. Only IPv4 is supported. This field is a member of `oneof`_ ``_peer_ip``.
region	str [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. This field is a member of `oneof`_ ``_region``.
remote_traffic_selector	Sequence[str] 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.
router	str URL of the router resource to be used for dynamic routing. This field is a member of `oneof`_ ``_router``.
self_link	str [Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ ``_self_link``.
shared_secret	str Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. This field is a member of `oneof`_ ``_shared_secret``.
shared_secret_hash	str Hash of the shared secret. This field is a member of `oneof`_ ``_shared_secret_hash``.
status	str [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. This field is a member of `oneof`_ ``_status``.
target_vpn_gateway	str 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 is a member of `oneof`_ ``_target_vpn_gateway``.
vpn_gateway	str 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. This field is a member of `oneof`_ ``_vpn_gateway``.
vpn_gateway_interface	int The interface ID of the VPN gateway with which this VPN tunnel is associated. This field is a member of `oneof`_ ``_vpn_gateway_interface``.

Inheritance

builtins.object > proto.message.Message > VpnTunnel

Classes

Status

Status(value)

[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.