This plugin is part of the google.cloud collection.
To install it use:
ansible-galaxy collection install google.cloud.
To use it in a playbook, specify:
The below requirements are needed on the host that executes this module.
| auth_kind |
string / required
| || |
The type of credential used.
| env_type |
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
| filters |
list / elements=string
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 |
The Google Cloud Platform project to use.
| scopes |
list / elements=string
Array of scopes to be used
| service_account_contents |
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
| 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.
- name: get info on an external vpn gateway gcp_compute_external_vpn_gateway_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem"
Common return values are documented here, the following are the fields unique to this module:
| resources |
List of resources
| description |
An optional description of this resource.
| interfaces |
A list of interfaces on this external VPN gateway.
| id |
The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
| ipAddress |
IP address of the interface in the external VPN gateway.
Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
| 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 `[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.
| redundancyType |
Indicates the redundancy type of this external VPN gateway .
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.