gcp_compute_vpn_tunnel_facts – Gather facts for GCP VpnTunnel

From Get docs
Ansible/docs/2.8/modules/gcp compute vpn tunnel facts module


gcp_compute_vpn_tunnel_facts – Gather facts for GCP VpnTunnel

New in version 2.7.


Synopsis

  • Gather facts for GCP VpnTunnel

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments

auth_kind

string / required

  • application
  • machineaccount
  • serviceaccount

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

string

The Google Cloud Platform project to use.

region

- / required

The region where the tunnel is located.

scopes

list

Array of scopes to be used.

service_account_contents

string

A string representing the contents of a Service Account JSON file.

This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.



Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.


Examples

- name: " a vpn tunnel facts"
  gcp_compute_vpn_tunnel_facts:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: facts

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

items

complex

always

List of items


creationTimestamp

string

success

Creation timestamp in RFC3339 text format.


description

string

success

An optional description of this resource.


ikeVersion

integer

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.


localTrafficSelector

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.


name

string

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.


peerIp

string

success

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


region

string

success

The region where the tunnel is located.


remoteTrafficSelector

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.


router

dictionary

success

URL of router resource to be used for dynamic routing.


sharedSecret

string

success

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


sharedSecretHash

string

success

Hash of the shared secret.


targetVpnGateway

dictionary

success

URL of the Target VPN gateway with which this VPN tunnel is associated.





Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_compute_vpn_tunnel_facts_module.html