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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
|
label_fingerprint |
str
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. This field is a member of oneof_ _label_fingerprint.
|
labels |
MutableMapping[str, str]
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 |
MutableSequence[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. Possible values are: 0, 1, 2,
3. The number of IDs in use depends on the external VPN
gateway redundancy type.
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 |
MutableSequence[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. Possible values are: 0, 1.
This field is a member of oneof_ _vpn_gateway_interface.
|
Classes
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
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.
Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. ALLOCATING_RESOURCES (320922816): Cloud VPN is in the process of allocating all required resources (specifically, a borg task). AUTHORIZATION_ERROR (23580290): Auth error (e.g. bad shared secret). DEPROVISIONING (428935662): Resources is being deallocated for the VPN tunnel. ESTABLISHED (88852344): Secure session is successfully established with peer VPN. FAILED (455706685): Tunnel creation has failed and the tunnel is not ready to be used. FIRST_HANDSHAKE (191393000): Successful first handshake with peer VPN. NEGOTIATION_FAILURE (360325868): Handshake failed. NETWORK_ERROR (193912951): Deprecated, replaced by NO_INCOMING_PACKETS NO_INCOMING_PACKETS (119983216): No incoming packets from peer PROVISIONING (290896621): Resource is being allocated for the VPN tunnel. REJECTED (174130302): Tunnel configuration was rejected, can be result of being denylisted. STOPPED (444276141): Tunnel is stopped due to its Forwarding Rules being deleted. WAITING_FOR_FULL_CONFIG (41640522): Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.