Documentation

gcp_compute_address_facts – Gather facts for GCP Address

New in version 2.7.

Synopsis

  • Gather facts for GCP Address

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
- / required
    Choices:
  • machineaccount
  • serviceaccount
  • application
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.

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 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 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"

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

  address
string
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.

  address_type
string
success
The type of address to reserve, either INTERNAL or EXTERNAL.
If unspecified, defaults to EXTERNAL.

  creation_timestamp
string
success
Creation timestamp in RFC3339 text format.

  description
string
success
An optional description of this resource.

  id
integer
success
The unique identifier for the resource.

  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.

  region
string
success
URL of the region where the regional address resides.
This field is not applicable to global addresses.

  subnetwork
dictionary
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.

  users
list
success
The URLs of the resources that are using this address.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

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