Class VpnTunnel

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

Inheritance
object
VpnTunnel
Implements
Inherited Members
Namespace: Google.Apis.Compute.beta.Data
Assembly: Google.Apis.Compute.beta.dll
Syntax
public class VpnTunnel : IDirectResponseSchema

Properties

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

Description

An optional description of this resource. Provide this property when you create the resource.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DetailedStatus

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

Declaration
[JsonProperty("detailedStatus")]
public virtual string DetailedStatus { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

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

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

IkeVersion

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.

Declaration
[JsonProperty("ikeVersion")]
public virtual int? IkeVersion { get; set; }
Property Value
Type Description
int?

Kind

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

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LabelFingerprint

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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.

Declaration
[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }
Property Value
Type Description
string

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LocalTrafficSelector

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.

Declaration
[JsonProperty("localTrafficSelector")]
public virtual IList<string> LocalTrafficSelector { get; set; }
Property Value
Type Description
IList<string>

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PeerExternalGateway

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.

Declaration
[JsonProperty("peerExternalGateway")]
public virtual string PeerExternalGateway { get; set; }
Property Value
Type Description
string

PeerExternalGatewayInterface

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.

Declaration
[JsonProperty("peerExternalGatewayInterface")]
public virtual int? PeerExternalGatewayInterface { get; set; }
Property Value
Type Description
int?

PeerGcpGateway

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.

Declaration
[JsonProperty("peerGcpGateway")]
public virtual string PeerGcpGateway { get; set; }
Property Value
Type Description
string

PeerIp

IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.

Declaration
[JsonProperty("peerIp")]
public virtual string PeerIp { get; set; }
Property Value
Type Description
string

Region

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

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
string

RemoteTrafficSelector

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.

Declaration
[JsonProperty("remoteTrafficSelector")]
public virtual IList<string> RemoteTrafficSelector { get; set; }
Property Value
Type Description
IList<string>

Router

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

Declaration
[JsonProperty("router")]
public virtual string Router { get; set; }
Property Value
Type Description
string

[Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SharedSecret

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

Declaration
[JsonProperty("sharedSecret")]
public virtual string SharedSecret { get; set; }
Property Value
Type Description
string

SharedSecretHash

Hash of the shared secret.

Declaration
[JsonProperty("sharedSecretHash")]
public virtual string SharedSecretHash { get; set; }
Property Value
Type Description
string

Status

[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.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

TargetVpnGateway

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.

Declaration
[JsonProperty("targetVpnGateway")]
public virtual string TargetVpnGateway { get; set; }
Property Value
Type Description
string

VpnGateway

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.

Declaration
[JsonProperty("vpnGateway")]
public virtual string VpnGateway { get; set; }
Property Value
Type Description
string

VpnGatewayInterface

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

Declaration
[JsonProperty("vpnGatewayInterface")]
public virtual int? VpnGatewayInterface { get; set; }
Property Value
Type Description
int?

Implements