New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind required |
| The type of credential used. |
filters | A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) | |
project | Default: None | The Google Cloud Platform project to use. |
region required | The region where the tunnel is located. | |
scopes | Array of scopes to be used. | |
service_account_email | An optional service account email address if machineaccount is selected and the user does not wish to use the default email. | |
service_account_file | The path of a Service Account JSON file if serviceaccount is selected as type. |
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: a vpn tunnel facts gcp_compute_vpn_tunnel_facts: region: us-west1 filters: - name = test_object project: test_project auth_kind: service_account service_account_file: "/tmp/auth.pem"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
items complex | always | List of items | |
description str | success | An optional description of this resource. | |
remote_traffic_selector list | success | Remote traffic selector to use when establishing the VPN tunnel with 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. | |
name str | success | Name of the resource. 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. | |
region str | success | The region where the tunnel is located. | |
labels dict | success | Labels to apply to this VpnTunnel. | |
peer_ip str | success | IP address of the peer VPN gateway. Only IPv4 is supported. | |
target_vpn_gateway dict | success | URL of the Target VPN gateway with which this VPN tunnel is associated. | |
shared_secret_hash str | success | Hash of the shared secret. | |
shared_secret str | success | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | |
router str | success | URL of router resource to be used for dynamic routing. | |
ike_version int | success | IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. | |
creation_timestamp str | success | Creation timestamp in RFC3339 text format. | |
local_traffic_selector list | success | Local traffic selector to use when establishing the VPN tunnel with 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. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gcp_compute_vpn_tunnel_facts_module.html