vpn_tunnels

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	[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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`cipherSuite`	`object`	User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. (id: VpnTunnelCipherSuite)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`detailedStatus`	`string`	[Output Only] Detailed status message for the VPN tunnel.
`ikeVersion`	`integer (int32)`	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. [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. (default: compute#vpnTunnel)
`labelFingerprint`	`string (byte)`	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 error412 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 thesetLabels method. Each label key/value pair must comply withRFC1035. 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.
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: VpnTunnelParams)
`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 (int32)`	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. (ALLOCATING_RESOURCES, AUTHORIZATION_ERROR, DEPROVISIONING, ESTABLISHED, FAILED, FIRST_HANDSHAKE, NEGOTIATION_FAILURE, NETWORK_ERROR, NO_INCOMING_PACKETS, PROVISIONING, REJECTED, STOPPED, WAITING_FOR_FULL_CONFIG)
`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 (int32)`	The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of VpnTunnel resources.
`kind`	`string`	Output only. [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. (default: compute#vpnTunnelList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Name	Datatype	Description
`id`	`string (uint64)`	[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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`cipherSuite`	`object`	User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. (id: VpnTunnelCipherSuite)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`detailedStatus`	`string`	[Output Only] Detailed status message for the VPN tunnel.
`ikeVersion`	`integer (int32)`	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. [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. (default: compute#vpnTunnel)
`labelFingerprint`	`string (byte)`	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 error412 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 thesetLabels method. Each label key/value pair must comply withRFC1035. 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.
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: VpnTunnelParams)
`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 (int32)`	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. (ALLOCATING_RESOURCES, AUTHORIZATION_ERROR, DEPROVISIONING, ESTABLISHED, FAILED, FIRST_HANDSHAKE, NEGOTIATION_FAILURE, NETWORK_ERROR, NO_INCOMING_PACKETS, PROVISIONING, REJECTED, STOPPED, WAITING_FOR_FULL_CONFIG)
`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 (int32)`	The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `vpnTunnel`		Returns the specified VpnTunnel resource.
`list`	`select`	`project`, `region`	`orderBy`, `filter`, `maxResults`, `pageToken`, `returnPartialSuccess`	Retrieves a list of VpnTunnel resources contained in the specified project and region.
`aggregated_list`	`select`	`project`	`returnPartialSuccess`, `includeAllScopes`, `orderBy`, `maxResults`, `pageToken`, `filter`, `serviceProjectNumber`	Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`, `region`	`requestId`	Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`delete`	`delete`	`project`, `region`, `vpnTunnel`	`requestId`	Deletes the specified VpnTunnel resource.
`set_labels`	`exec`	`project`, `region`, `resource`	`requestId`	Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling Resources documentation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`project`	`string`
`region`	`string`
`resource`	`string`
`vpnTunnel`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified VpnTunnel resource.

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

Retrieves a list of VpnTunnel resources contained in the specified
project and region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.vpn_tunnels
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

Retrieves an aggregated list of VPN tunnels.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
cipherSuite,
creationTimestamp,
description,
detailedStatus,
ikeVersion,
kind,
labelFingerprint,
labels,
localTrafficSelector,
params,
peerExternalGateway,
peerExternalGatewayInterface,
peerGcpGateway,
peerIp,
region,
remoteTrafficSelector,
router,
selfLink,
sharedSecret,
sharedSecretHash,
status,
targetVpnGateway,
vpnGateway,
vpnGatewayInterface
FROM google.compute.vpn_tunnels
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
;

`INSERT` examples

insert
Manifest

Creates a VpnTunnel resource in the specified project and region using
the data included in the request.

INSERT INTO google.compute.vpn_tunnels (
data__remoteTrafficSelector,
data__sharedSecretHash,
data__peerExternalGatewayInterface,
data__targetVpnGateway,
data__description,
data__detailedStatus,
data__id,
data__peerGcpGateway,
data__name,
data__status,
data__router,
data__peerExternalGateway,
data__sharedSecret,
data__region,
data__ikeVersion,
data__localTrafficSelector,
data__labels,
data__cipherSuite,
data__vpnGateway,
data__selfLink,
data__params,
data__vpnGatewayInterface,
data__peerIp,
data__labelFingerprint,
project,
region,
requestId
)
SELECT 
'{{ remoteTrafficSelector }}',
'{{ sharedSecretHash }}',
{{ peerExternalGatewayInterface }},
'{{ targetVpnGateway }}',
'{{ description }}',
'{{ detailedStatus }}',
'{{ id }}',
'{{ peerGcpGateway }}',
'{{ name }}',
'{{ status }}',
'{{ router }}',
'{{ peerExternalGateway }}',
'{{ sharedSecret }}',
'{{ region }}',
{{ ikeVersion }},
'{{ localTrafficSelector }}',
'{{ labels }}',
'{{ cipherSuite }}',
'{{ vpnGateway }}',
'{{ selfLink }}',
'{{ params }}',
{{ vpnGatewayInterface }},
'{{ peerIp }}',
'{{ labelFingerprint }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: vpn_tunnels
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the vpn_tunnels resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpn_tunnels resource.
  - name: remoteTrafficSelector
    value:
      - "{{ remoteTrafficSelector }}"
    description: |
      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.
  - name: sharedSecretHash
    value: "{{ sharedSecretHash }}"
    description: |
      Hash of the shared secret.
  - name: peerExternalGatewayInterface
    value: {{ peerExternalGatewayInterface }}
    description: |
      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.
  - name: targetVpnGateway
    value: "{{ targetVpnGateway }}"
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: detailedStatus
    value: "{{ detailedStatus }}"
    description: |
      [Output Only] Detailed status message for the VPN tunnel.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: peerGcpGateway
    value: "{{ peerGcpGateway }}"
    description: |
      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.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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: status
    value: "{{ status }}"
    description: |
      [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.
    valid_values: ['ALLOCATING_RESOURCES', 'AUTHORIZATION_ERROR', 'DEPROVISIONING', 'ESTABLISHED', 'FAILED', 'FIRST_HANDSHAKE', 'NEGOTIATION_FAILURE', 'NETWORK_ERROR', 'NO_INCOMING_PACKETS', 'PROVISIONING', 'REJECTED', 'STOPPED', 'WAITING_FOR_FULL_CONFIG']
  - name: router
    value: "{{ router }}"
    description: |
      URL of the router resource to be used for dynamic routing.
  - name: peerExternalGateway
    value: "{{ peerExternalGateway }}"
    description: |
      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.
  - name: sharedSecret
    value: "{{ sharedSecret }}"
    description: |
      Shared secret used to set the secure session between the Cloud VPN gateway
      and the peer VPN gateway.
  - name: region
    value: "{{ region }}"
    description: |
      [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.
  - name: ikeVersion
    value: {{ ikeVersion }}
    description: |
      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.
  - name: localTrafficSelector
    value:
      - "{{ localTrafficSelector }}"
    description: |
      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: labels
    value: "{{ labels }}"
    description: |
      Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      Label values may be empty.
  - name: cipherSuite
    description: |
      User specified list of ciphers to use for the phase 1 and phase 2 of the
      IKE protocol.
    value:
      phase1:
        dh:
          - "{{ dh }}"
        encryption:
          - "{{ encryption }}"
        integrity:
          - "{{ integrity }}"
        prf:
          - "{{ prf }}"
      phase2:
        encryption:
          - "{{ encryption }}"
        integrity:
          - "{{ integrity }}"
        pfs:
          - "{{ pfs }}"
  - name: vpnGateway
    value: "{{ vpnGateway }}"
    description: |
      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.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: vpnGatewayInterface
    value: {{ vpnGatewayInterface }}
    description: |
      The interface ID of the VPN gateway with which this VPN tunnel is
      associated.
      Possible values are: `0`, `1`.
  - name: peerIp
    value: "{{ peerIp }}"
    description: |
      IP address of the peer VPN gateway. Only IPv4 is supported. This field can
      be set only for Classic VPN tunnels.
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      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 error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve a VpnTunnel.
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes the specified VpnTunnel resource.

DELETE FROM google.compute.vpn_tunnels
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND vpnTunnel = '{{ vpnTunnel }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_labels

Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling
Resources documentation.

EXEC google.compute.vpn_tunnels.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​