Method: vpnTunnels.insert

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

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/vpnTunnels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region for this request.

Query parameters

Parameters
requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains data with the following structure:

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "targetVpnGateway": string,
  "vpnGateway": string,
  "vpnGatewayInterface": integer,
  "peerExternalGateway": string,
  "peerExternalGatewayInterface": integer,
  "peerGcpGateway": string,
  "router": string,
  "peerIp": string,
  "sharedSecret": string,
  "sharedSecretHash": string,
  "status": enum,
  "selfLink": string,
  "ikeVersion": integer,
  "detailedStatus": string,
  "localTrafficSelector": [
    string
  ],
  "remoteTrafficSelector": [
    string
  ],
  "kind": string
}
Fields
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

[REQUIRED] 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.
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.
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.

Authorization requires the following IAM permission on the specified resource targetVpnGateway:

  • compute.targetVpnGateways.use
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 targetVpnGateway) if a High Availability VPN gateway resource is created.

Authorization requires the following IAM permission on the specified resource vpnGateway:

  • compute.vpnGateways.use
vpnGatewayInterface

integer

The interface ID of the VPN gateway with which this VPN tunnel is associated.
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.

Authorization requires the following IAM permission on the specified resource peerExternalGateway:

  • compute.externalVpnGateways.use
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.
peerGcpGateway

string

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.

Authorization requires the following IAM permission on the specified resource peerGcpGateway:

  • compute.vpnGateways.use
router

string

URL of the router resource to be used for dynamic routing.

Authorization requires the following IAM permission on the specified resource router:

  • compute.routers.use
peerIp

string

IP address of the peer VPN gateway. Only IPv4 is supported.
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

enum

[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.
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.
detailedStatus

string

[Output Only] Detailed status message for the VPN tunnel.
localTrafficSelector[]

string

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.
remoteTrafficSelector[]

string

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.
kind

string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

Response body

If successful, the response body contains data with the following structure:

Represents an Operation resource.

Google Compute Engine has three Operation resources:

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

  • For global operations, use the globalOperations resource.
  • For regional operations, use the regionOperations resource.
  • For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources.

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,
  "kind": string
}
Fields
id

string (uint64 format)

[Output Only] The unique identifier for the operation. This identifier is defined by the server.
creationTimestamp

string

[Deprecated] This field is deprecated.
name

string

[Output Only] Name of the operation.
zone

string