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:
The below requirements are needed on the host that executes this module.
| auth_kind |
string / required
| || |
The type of credential used.
| env_type |
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.
| project |
The Google Cloud Platform project to use.
| scopes |
list / elements=string
Array of scopes to be used
| service_account_contents |
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
| 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.
- name: get info on an instance gcp_bigtable_instance_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem"
Common return values are documented here, the following are the fields unique to this module:
| resources |
List of resources
| clusters |
An array of clusters. Maximum 4.
| defaultStorageType |
The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
| location |
The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`.
| name |
The unique name of the cluster.
| serveNodes |
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
| state |
The current state of the cluster.
| displayName |
The descriptive name for this instance as it appears in UIs.
Can be changed at any time, but should be kept globally unique to avoid confusion.
| labels |
Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.
| name |
The unique name of the instance.
| state |
The current state of the instance.
| type |
The type of the instance. Defaults to `PRODUCTION`.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.