public sealed class VpnTunnel : IMessage<VpnTunnel>, IEquatable<VpnTunnel>, IDeepCloneable<VpnTunnel>, IBufferMessage, IMessageReference documentation and code samples for the Compute Engine v1 API class VpnTunnel.
Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.
Implements
IMessageVpnTunnel, IEquatableVpnTunnel, IDeepCloneableVpnTunnel, IBufferMessage, IMessageNamespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
VpnTunnel()
public VpnTunnel()VpnTunnel(VpnTunnel)
public VpnTunnel(VpnTunnel other)| Parameter | |
|---|---|
| Name | Description |
other |
VpnTunnel |
Properties
CreationTimestamp
public string CreationTimestamp { get; set; }[Output Only] Creation timestamp in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Description
public string Description { get; set; }An optional description of this resource. Provide this property when you create the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DetailedStatus
public string DetailedStatus { get; set; }[Output Only] Detailed status message for the VPN tunnel.
| Property Value | |
|---|---|
| Type | Description |
string |
|
HasCreationTimestamp
public bool HasCreationTimestamp { get; }Gets whether the "creation_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDescription
public bool HasDescription { get; }Gets whether the "description" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDetailedStatus
public bool HasDetailedStatus { get; }Gets whether the "detailed_status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasId
public bool HasId { get; }Gets whether the "id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasIkeVersion
public bool HasIkeVersion { get; }Gets whether the "ike_version" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasKind
public bool HasKind { get; }Gets whether the "kind" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasLabelFingerprint
public bool HasLabelFingerprint { get; }Gets whether the "label_fingerprint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasName
public bool HasName { get; }Gets whether the "name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPeerExternalGateway
public bool HasPeerExternalGateway { get; }Gets whether the "peer_external_gateway" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPeerExternalGatewayInterface
public bool HasPeerExternalGatewayInterface { get; }Gets whether the "peer_external_gateway_interface" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPeerGcpGateway
public bool HasPeerGcpGateway { get; }Gets whether the "peer_gcp_gateway" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPeerIp
public bool HasPeerIp { get; }Gets whether the "peer_ip" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasRegion
public bool HasRegion { get; }Gets whether the "region" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasRouter
public bool HasRouter { get; }Gets whether the "router" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSelfLink
public bool HasSelfLink { get; }Gets whether the "self_link" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSharedSecret
public bool HasSharedSecret { get; }Gets whether the "shared_secret" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSharedSecretHash
public bool HasSharedSecretHash { get; }Gets whether the "shared_secret_hash" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStatus
public bool HasStatus { get; }Gets whether the "status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasTargetVpnGateway
public bool HasTargetVpnGateway { get; }Gets whether the "target_vpn_gateway" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasVpnGateway
public bool HasVpnGateway { get; }Gets whether the "vpn_gateway" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasVpnGatewayInterface
public bool HasVpnGatewayInterface { get; }Gets whether the "vpn_gateway_interface" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Id
public ulong Id { get; set; }[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Property Value | |
|---|---|
| Type | Description |
ulong |
|
IkeVersion
public int IkeVersion { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
Kind
public string Kind { get; set; }[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
| Property Value | |
|---|---|
| Type | Description |
string |
|
LabelFingerprint
public string LabelFingerprint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
LocalTrafficSelector
public RepeatedField<string> LocalTrafficSelector { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PeerExternalGateway
public string PeerExternalGateway { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PeerExternalGatewayInterface
public int PeerExternalGatewayInterface { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PeerGcpGateway
public string PeerGcpGateway { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PeerIp
public string PeerIp { get; set; }IP address of the peer VPN gateway. Only IPv4 is supported.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Region
public string Region { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
RemoteTrafficSelector
public RepeatedField<string> RemoteTrafficSelector { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Router
public string Router { get; set; }URL of the router resource to be used for dynamic routing.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SelfLink
public string SelfLink { get; set; }[Output Only] Server-defined URL for the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SharedSecret
public string SharedSecret { get; set; }Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SharedSecretHash
public string SharedSecretHash { get; set; }Hash of the shared secret.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Status
public string Status { get; set; }[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. Check the Status enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TargetVpnGateway
public string TargetVpnGateway { get; set; }URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
| Property Value | |
|---|---|
| Type | Description |
string |
|
VpnGateway
public string VpnGateway { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
VpnGatewayInterface
public int VpnGatewayInterface { get; set; }The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
| Property Value | |
|---|---|
| Type | Description |
int |
|