google.cloud.gcp_compute_address_info – Gather info for GCP Address

Note

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: google.cloud.gcp_compute_address_info.

Synopsis

  • Gather info 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
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
env_type
string
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
string
The Google Cloud Platform project to use.
region
string / required
URL of the region where the regional address resides.
This field is not applicable to global addresses.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
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_contents using the GCP_SERVICE_ACCOUNT_CONTENTS 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: get info on an address
  gcp_compute_address_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    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
resources
complex
always
List of resources

 
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.

 
addressType
string
success
The type of address to reserve.

 
creationTimestamp
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.

 
networkTier
string
success
The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.

 
purpose
string
success
The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
This should only be set when using an Internal address.

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

 
status
string
success
The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
An address that is RESERVING is currently in the process of being reserved.
A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

 
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 / elements=string
success
The URLs of the resources that are using this address.



Authors

  • Google Inc. (@googlecloudplatform)