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

Successful response

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 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. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 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.
kind	string	[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 error 412 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 the setLabels method. Each label key/value pair must comply with RFC1035. 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.
region	string	[Output Only] URL of the region where the VPN gateway resides.
selfLink	string	[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 is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.
vpnInterfaces	array	The list of VPN interfaces associated with this VPN gateway.

list

Successful response

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] 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 than maxResults, 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] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Successful response

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 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. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 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.
kind	string	[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 error 412 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 the setLabels method. Each label key/value pair must comply with RFC1035. 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.
region	string	[Output Only] URL of the region where the VPN gateway resides.
selfLink	string	[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 is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.
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	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of VPN gateways available to the specified project and region.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	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 the Labeling 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

Returns the specified VPN gateway.

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

list

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 filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

aggregated_list

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,
region,
selfLink,
stackType,
vpnInterfaces
FROM google.compute.vpn_gateways
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';

INSERT examples

insert

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

INSERT INTO google.compute.vpn_gateways (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__region,
data__network,
data__selfLink,
data__labels,
data__labelFingerprint,
data__vpnInterfaces,
data__stackType,
data__gatewayIpVersion,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ network }}',
'{{ selfLink }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ vpnInterfaces }}',
'{{ stackType }}',
'{{ gatewayIpVersion }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: vpn_gateways
  props:
    - name: project
      value: string
      description: Required parameter for the vpn_gateways resource.
    - name: region
      value: string
      description: Required parameter for the vpn_gateways resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
        
      default: compute#vpnGateway
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: region
      value: string
      description: >
        [Output Only] URL of the region where the VPN gateway resides.
        
    - name: network
      value: string
      description: >
        URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: labelFingerprint
      value: string
      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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.
        
    - name: vpnInterfaces
      value: array
      description: >
        The list of VPN interfaces associated with this VPN gateway.
        
    - name: stackType
      value: string
      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 is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.
        
      valid_values: ['IPV4_IPV6', 'IPV4_ONLY', 'IPV6_ONLY']
    - name: gatewayIpVersion
      value: string
      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: requestId
      value: string

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 the Labeling 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 }}"
}';