GetVpnTunnelResult

data class GetVpnTunnelResult(val creationTimestamp: String, val description: String, val detailedStatus: String, val ikeVersion: Int, val kind: String, val labelFingerprint: String, val labels: Map<String, String>, val localTrafficSelector: List<String>, val name: String, val peerExternalGateway: String, val peerExternalGatewayInterface: Int, val peerGcpGateway: String, val peerIp: String, val region: String, val remoteTrafficSelector: List<String>, val router: String, val selfLink: String, val sharedSecret: String, val sharedSecretHash: String, val status: String, val targetVpnGateway: String, val vpnGateway: String, val vpnGatewayInterface: Int)

Constructors

Link copied to clipboard
fun GetVpnTunnelResult(creationTimestamp: String, description: String, detailedStatus: String, ikeVersion: Int, kind: String, labelFingerprint: String, labels: Map<String, String>, localTrafficSelector: List<String>, name: String, peerExternalGateway: String, peerExternalGatewayInterface: Int, peerGcpGateway: String, peerIp: String, region: String, remoteTrafficSelector: List<String>, router: String, selfLink: String, sharedSecret: String, sharedSecretHash: String, status: String, targetVpnGateway: String, vpnGateway: String, vpnGatewayInterface: Int)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Creation timestamp in RFC3339 text format.

Link copied to clipboard

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

Link copied to clipboard

Detailed status message for the VPN tunnel.

Link copied to clipboard

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.

Link copied to clipboard

Type of resource. Always compute#vpnTunnel for VPN tunnels.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

IP address of the peer VPN gateway. Only IPv4 is supported.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Server-defined URL for the resource.

Link copied to clipboard

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

Link copied to clipboard

Hash of the shared secret.

Link copied to clipboard

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.

Link copied to clipboard

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

Link copied to clipboard

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.

Link copied to clipboard

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