gcp_compute_vpn_tunnel
ancestors
Type: UNORDERED_LIST_STRING
creation_timestamp
Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.
description
Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.
detailed_status
Type: STRING
Provider name: detailedStatus
Description: [Output Only] Detailed status message for the VPN tunnel.
gcp_status
Type: STRING
Provider name: status
Description: [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.
Possible values:
ALLOCATING_RESOURCES - Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
AUTHORIZATION_ERROR - Auth error (e.g. bad shared secret).
DEPROVISIONING - Resources is being deallocated for the VPN tunnel.
ESTABLISHED - Secure session is successfully established with peer VPN.
FAILED - Tunnel creation has failed and the tunnel is not ready to be used.
FIRST_HANDSHAKE - Successful first handshake with peer VPN.
NEGOTIATION_FAILURE - Handshake failed.
NETWORK_ERROR - Deprecated, replaced by NO_INCOMING_PACKETS
NO_INCOMING_PACKETS - No incoming packets from peer
PROVISIONING - Resource is being allocated for the VPN tunnel.
REJECTED - Tunnel configuration was rejected, can be result of being denylisted.
STOPPED - Tunnel is stopped due to its Forwarding Rules being deleted.
WAITING_FOR_FULL_CONFIG - Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
id
Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ike_version
Type: INT32
Provider name: ikeVersion
Description: 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.
kind
Type: STRING
Provider name: kind
Description: [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
labels
Type: UNORDERED_LIST_STRING
local_traffic_selector
Type: UNORDERED_LIST_STRING
Provider name: localTrafficSelector
Description: 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.
name
Type: STRING
Provider name: name
Description: 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.
organization_id
Type: STRING
parent
Type: STRING
peer_external_gateway
Type: STRING
Provider name: peerExternalGateway
Description: 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.
peer_external_gateway_interface
Type: INT32
Provider name: peerExternalGatewayInterface
Description: 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.
peer_gcp_gateway
Type: STRING
Provider name: peerGcpGateway
Description: 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.
peer_ip
Type: STRING
Provider name: peerIp
Description: IP address of the peer VPN gateway. Only IPv4 is supported.
project_id
Type: STRING
project_number
Type: STRING
region
Type: STRING
Provider name: region
Description: [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.
remote_traffic_selector
Type: UNORDERED_LIST_STRING
Provider name: remoteTrafficSelector
Description: 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.
resource_name
Type: STRING
router
Type: STRING
Provider name: router
Description: URL of the router resource to be used for dynamic routing.
self_link
Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.
shared_secret_hash
Type: STRING
Provider name: sharedSecretHash
Description: Hash of the shared secret.
Type: UNORDERED_LIST_STRING
target_vpn_gateway
Type: STRING
Provider name: targetVpnGateway
Description: URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
vpn_gateway
Type: STRING
Provider name: vpnGateway
Description: 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.
vpn_gateway_interface
Type: INT32
Provider name: vpnGatewayInterface
Description: The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
