vpn_tunnels

Creates, updates, deletes, gets or lists a vpn_tunnels resource.

Overview

Name	`vpn_tunnels`
Type	Resource
Id	`google.compute.vpn_tunnels`

Fields

Name	Datatype	Description
`id`	`string`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`detailedStatus`	`string`	[Output Only] Detailed status message for the VPN tunnel.
`ikeVersion`	`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`	`string`	[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
`labelFingerprint`	`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`	`object`	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.
`localTrafficSelector`	`array`	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.
`peerExternalGateway`	`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.
`peerExternalGatewayInterface`	`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.
`peerGcpGateway`	`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.
`peerIp`	`string`	IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.
`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.
`remoteTrafficSelector`	`array`	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`	`string`	URL of the router resource to be used for dynamic routing.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`sharedSecret`	`string`	Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`sharedSecretHash`	`string`	Hash of the shared secret.
`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.
`targetVpnGateway`	`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.
`vpnGateway`	`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.
`vpnGatewayInterface`	`integer`	The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.

Methods

Name	Accessible by	Required Params	Description
`aggregated_list`	`SELECT`	`project`	Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`get`	`SELECT`	`project, region, vpnTunnel`	Returns the specified VpnTunnel resource.
`list`	`SELECT`	`project, region`	Retrieves a list of VpnTunnel resources contained in the specified project and region.
`insert`	`INSERT`	`project, region`	Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`delete`	`DELETE`	`project, region, vpnTunnel`	Deletes the specified VpnTunnel resource.
`set_labels`	`EXEC`	`project, region, resource`	Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

`SELECT` examples

Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
creationTimestamp,
detailedStatus,
ikeVersion,
kind,
labelFingerprint,
labels,
localTrafficSelector,
peerExternalGateway,
peerExternalGatewayInterface,
peerGcpGateway,
peerIp,
region,
remoteTrafficSelector,
router,
selfLink,
sharedSecret,
sharedSecretHash,
status,
targetVpnGateway,
vpnGateway,
vpnGatewayInterface
FROM google.compute.vpn_tunnels
WHERE project = '{{ project }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new vpn_tunnels resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.vpn_tunnels (
project,
region,
name,
description,
region,
targetVpnGateway,
vpnGateway,
vpnGatewayInterface,
peerExternalGateway,
peerExternalGatewayInterface,
peerGcpGateway,
router,
peerIp,
sharedSecret,
sharedSecretHash,
status,
ikeVersion,
detailedStatus,
localTrafficSelector,
remoteTrafficSelector,
labels,
labelFingerprint
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ targetVpnGateway }}',
'{{ vpnGateway }}',
'{{ vpnGatewayInterface }}',
'{{ peerExternalGateway }}',
'{{ peerExternalGatewayInterface }}',
'{{ peerGcpGateway }}',
'{{ router }}',
'{{ peerIp }}',
'{{ sharedSecret }}',
'{{ sharedSecretHash }}',
'{{ status }}',
'{{ ikeVersion }}',
'{{ detailedStatus }}',
'{{ localTrafficSelector }}',
'{{ remoteTrafficSelector }}',
'{{ labels }}',
'{{ labelFingerprint }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: region
      value: string
    - name: targetVpnGateway
      value: string
    - name: vpnGateway
      value: string
    - name: vpnGatewayInterface
      value: integer
    - name: peerExternalGateway
      value: string
    - name: peerExternalGatewayInterface
      value: integer
    - name: peerGcpGateway
      value: string
    - name: router
      value: string
    - name: peerIp
      value: string
    - name: sharedSecret
      value: string
    - name: sharedSecretHash
      value: string
    - name: status
      value: string
    - name: selfLink
      value: string
    - name: ikeVersion
      value: integer
    - name: detailedStatus
      value: string
    - name: localTrafficSelector
      value:
        - string
    - name: remoteTrafficSelector
      value:
        - string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string

`DELETE` example

Deletes the specified vpn_tunnels resource.

/*+ delete */
DELETE FROM google.compute.vpn_tunnels
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND vpnTunnel = '{{ vpnTunnel }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​