VpnTunnels

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "compute#vpnTunnel",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "targetVpnGateway": string,
  "router": string,
  "peerIp": string,
  "sharedSecret": string,
  "sharedSecretHash": string,
  "status": string,
  "selfLink": string,
  "ikeVersion": integer,
  "detailedStatus": string,
  "localTrafficSelector": [
    string
  ],
  "remoteTrafficSelector": [
    string
  ]
}
Property name Value Description Notes
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.
detailedStatus string [Output Only] Detailed status message for the VPN tunnel.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ikeVersion integer IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
kind string [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
localTrafficSelector[] list Local traffic selector to use when establishing the VPN tunnel with 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.
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.
peerIp string IP address of the peer VPN gateway. Only IPv4 is supported.
region string [Output Only] URL of the region where the VPN tunnel resides.
remoteTrafficSelector[] list Remote traffic selectors to use when establishing the VPN tunnel with 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.
router string URL of router resource to be used for dynamic routing.
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.
targetVpnGateway string URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

Methods

aggregatedList
Retrieves an aggregated list of VPN tunnels.
delete
Deletes the specified VpnTunnel resource.
get
Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.
insert
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
list
Retrieves a list of VpnTunnel resources contained in the specified project and region.

Send feedback about...

Compute Engine