New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
address |
The static external IP address represented by this resource. Only IPv4 is supported.
|
|
auth_kind
required |
|
The type of credential used.
|
description |
An optional description of this resource.
|
|
name |
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.
|
|
project |
The Google Cloud Platform project to use.
|
|
region
required |
A reference to Region resource.
|
|
scopes
required |
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.
|
|
state
required |
|
Whether the given object should exist in GCP
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a address
gcp_compute_address:
name: 'test-address1'
region: 'us-west1'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
address
str
|
success |
The static external IP address represented by this resource. Only IPv4 is supported.
|
creation_timestamp
str
|
success |
Creation timestamp in RFC3339 text format.
|
description
str
|
success |
An optional description of this resource.
|
id
int
|
success |
The unique identifier for the resource.
|
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.
|
region
str
|
success |
A reference to Region resource.
|
users
list
|
success |
The URLs of the resources that are using this address.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.