vpn_gateways

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [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])?`)
`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.
`gatewayIpVersion`	`string`	The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. (IPV4, IPV6)
`kind`	`string`	Output only. [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. (default: compute#vpnGateway)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this VpnGateway, 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 VpnGateway.
`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.
`network`	`string`	URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: VpnGatewayParams)
`region`	`string`	Output only. [Output Only] URL of the region where the VPN gateway resides.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`stackType`	`string`	The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6. (IPV4_IPV6, IPV4_ONLY, IPV6_ONLY)
`vpnInterfaces`	`array`	The list of VPN interfaces associated with this VPN gateway.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of VpnGateway resources.
`kind`	`string`	Output only. [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. (default: compute#vpnGatewayList)
`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. [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])?`)
`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.
`gatewayIpVersion`	`string`	The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. (IPV4, IPV6)
`kind`	`string`	Output only. [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. (default: compute#vpnGateway)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this VpnGateway, 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 VpnGateway.
`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.
`network`	`string`	URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: VpnGatewayParams)
`region`	`string`	Output only. [Output Only] URL of the region where the VPN gateway resides.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`stackType`	`string`	The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6. (IPV4_IPV6, IPV4_ONLY, IPV6_ONLY)
`vpnInterfaces`	`array`	The list of VPN interfaces associated with this VPN gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `vpnGateway`		Returns the specified VPN gateway.
`list`	`select`	`project`, `region`	`returnPartialSuccess`, `filter`, `maxResults`, `pageToken`, `orderBy`	Retrieves a list of VPN gateways available to the specified project and region.
`aggregated_list`	`select`	`project`	`returnPartialSuccess`, `maxResults`, `pageToken`, `filter`, `serviceProjectNumber`, `includeAllScopes`, `orderBy`	Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`, `region`	`requestId`	Creates a VPN gateway in the specified project and region using the data included in the request.
`delete`	`delete`	`project`, `region`, `vpnGateway`	`requestId`	Deletes the specified VPN gateway.
`set_labels`	`exec`	`project`, `region`, `resource`	`requestId`	Sets the labels on a VpnGateway. 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`
`vpnGateway`	`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 VPN gateway.

SELECT
id,
name,
creationTimestamp,
description,
gatewayIpVersion,
kind,
labelFingerprint,
labels,
network,
params,
region,
selfLink,
stackType,
vpnInterfaces
FROM google.compute.vpn_gateways
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND vpnGateway = '{{ vpnGateway }}' -- required
;

Retrieves a list of VPN gateways available to the specified
project and region.

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

Retrieves an aggregated list of VPN gateways.

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

SELECT
id,
name,
creationTimestamp,
description,
gatewayIpVersion,
kind,
labelFingerprint,
labels,
network,
params,
region,
selfLink,
stackType,
vpnInterfaces
FROM google.compute.vpn_gateways
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
;

`INSERT` examples

insert
Manifest

Creates a VPN gateway in the specified project and region using
the data included in the request.

INSERT INTO google.compute.vpn_gateways (
data__vpnInterfaces,
data__gatewayIpVersion,
data__network,
data__stackType,
data__labelFingerprint,
data__name,
data__params,
data__labels,
data__description,
project,
region,
requestId
)
SELECT 
'{{ vpnInterfaces }}',
'{{ gatewayIpVersion }}',
'{{ network }}',
'{{ stackType }}',
'{{ labelFingerprint }}',
'{{ name }}',
'{{ params }}',
'{{ labels }}',
'{{ description }}',
'{{ 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_gateways
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the vpn_gateways resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpn_gateways resource.
  - name: vpnInterfaces
    description: |
      The list of VPN interfaces associated with this VPN gateway.
    value:
      - ipv6Address: "{{ ipv6Address }}"
        id: {{ id }}
        interconnectAttachment: "{{ interconnectAttachment }}"
        ipAddress: "{{ ipAddress }}"
  - name: gatewayIpVersion
    value: "{{ gatewayIpVersion }}"
    description: |
      The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
      specified, IPV4 will be used.
    valid_values: ['IPV4', 'IPV6']
  - name: network
    value: "{{ network }}"
    description: |
      URL of the network to which this VPN gateway is attached. Provided by the
      client when the VPN gateway is created.
  - name: stackType
    value: "{{ stackType }}"
    description: |
      The stack type for this VPN gateway to identify the IP protocols that are
      enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
    valid_values: ['IPV4_IPV6', 'IPV4_ONLY', 'IPV6_ONLY']
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      A fingerprint for the labels being applied to this VpnGateway, 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 VpnGateway.
  - 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: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - 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: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes the specified VPN gateway.

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

Lifecycle Methods

set_labels

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

EXEC google.compute.vpn_gateways.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​