gcp_compute_global_address – Creates a GCP GlobalAddress
gcp_compute_global_address – Creates a GCP GlobalAddress
New in version 2.6.
Synopsis
- Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.
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 |
---|---|---|
address - added in 2.8 |
The static external IP address represented by this resource. | |
address_type - added in 2.8 |
|
The type of the address to reserve, default is EXTERNAL.
|
auth_kind string / required |
|
The type of credential used. |
description - |
An optional description of this resource. | |
ip_version - |
|
The IP Version that will be used by this address. Valid options are `IPV4` or `IPV6`. The default value is `IPV4`. |
name - / required |
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. | |
project string |
The Google Cloud Platform project to use. | |
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. | |
state - |
|
Whether the given object should exist in GCP |
Notes
Note
- API Reference: https://cloud.google.com/compute/docs/reference/v1/globalAddresses
- Reserving a Static External IP Address: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address
- 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: create a global address
gcp_compute_global_address:
name: test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
address string |
success |
The static external IP address represented by this resource.
|
addressType string |
success |
The type of the address to reserve, default is EXTERNAL.
|
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. This identifier is defined by the server.
|
ipVersion string |
success |
The IP Version that will be used by this address. Valid options are `IPV4` or `IPV6`. The default value is `IPV4`.
|
name string |
success |
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.
|
region string |
success |
A reference to the region where the regional address resides.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Google Inc. (@googlecloudplatform)
© 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_global_address_module.html