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 | URL of the region where the regional address resides. This field is not applicable to global addresses. | |
| 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 address facts
gcp_compute_address_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 | |
| users list | success | The URLs of the resources that are using this address. | |
| region str | success | URL of the region where the regional address resides. This field is not applicable to global addresses. | |
| 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. | |
| address str | success | The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any. | |
| subnetwork dict | success | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. | |
| address_type str | success | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | |
| creation_timestamp str | success | Creation timestamp in RFC3339 text format. | |
| id int | success | The unique identifier for the resource. | |
| description str | success | An optional description of this resource. | |
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_address_facts_module.html