google.cloud.gcp_bigtable_instance_info – Gather info for GCP Instance

Note

This plugin is part of the google.cloud collection (version 1.0.1).

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_bigtable_instance_info.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Gather info for GCP Instance

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	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.
project string		The Google Cloud Platform project to use.
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 instance
  gcp_bigtable_instance_info:
    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
	clusters complex		success	An array of clusters. Maximum 4.
		defaultStorageType string	success	The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
		location string	success	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//locations/`.
		name string	success	The unique name of the cluster.
		serveNodes integer	success	The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
		state string	success	The current state of the cluster.
	displayName string		success	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 dictionary		success	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 string		success	The unique name of the instance.
	state string		success	The current state of the instance.
	type string		success	The type of the instance. Defaults to `PRODUCTION`.

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.10/collections/google/cloud/gcp_bigtable_instance_info_module.html