Resource: VpnTunnel
Represents a Cloud VPN Tunnel resource.
For more information about VPN, read the the Cloud VPN Overview.
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "targetVpnGateway": string, "vpnGateway": string, "vpnGatewayInterface": number, "peerExternalGateway": string, "peerExternalGatewayInterface": number, "peerGcpGateway": string, "router": string, "peerIp": string, "sharedSecret": string, "sharedSecretHash": string, "status": enum, "selfLink": string, "ikeVersion": number, "detailedStatus": string, "localTrafficSelector": [ string ], "remoteTrafficSelector": [ string ], "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
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. |
targetVpnGateway |
URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. |
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 targetVpnGateway) if a High Availability VPN gateway resource is created. |
vpnGatewayInterface |
The interface ID of the VPN gateway with which this VPN tunnel is associated. |
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. |
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. |
peerGcpGateway |
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. |
router |
URL of the router resource to be used for dynamic routing. |
peerIp |
IP address of the peer VPN gateway. Only IPv4 is supported. |
sharedSecret |
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. |
sharedSecretHash |
Hash of the shared secret. |
status |
[Output Only] The status of the VPN tunnel, which can be one of the following:
|
selfLink |
[Output Only] Server-defined URL for the resource. |
ikeVersion |
IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are |
detailedStatus |
[Output Only] Detailed status message for the VPN tunnel. |
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: |
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. |
kind |
[Output Only] Type of resource. Always |
Methods |
|
---|---|
|
Retrieves an aggregated list of VPN tunnels. |
|
Deletes the specified VpnTunnel resource. |
|
Returns the specified VpnTunnel resource. |
|
Creates a VpnTunnel resource in the specified project and region using the data included in the request. |
|
Retrieves a list of VpnTunnel resources contained in the specified project and region. |
|
Sets the labels on a VpnTunnel. |
|
Returns permissions that a caller has on the specified resource. |