google.cloud.gcp_bigtable_instance_info – Сбор информации о виртуальной машине GCP

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_bigtable_instance_info.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о виртуальной машине GCP

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
project строка		Проект Google Cloud Platform для использования.
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран параметр machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды gcp_service_account_file.
для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
параметры service_account_email и service_account_file взаимно исключают друг друга.

Примеры

- name: get info on an instance
  gcp_bigtable_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
resources сложное			всегда	Список ресурсов
	clusters сложное		успех	Массив кластеров. Максимальное значение 4.
		defaultStorageType строка	успех	Тип хранилища, используемого этим кластером для предоставления таблиц родительской виртуальной машины, если явно не переопределён.
		location строка	успех	Расположение, где находятся узлы и хранилище этого кластера. Для наилучшей производительности клиенты должны размещаться как можно ближе к этому кластеру. В настоящее время поддерживаются только зоны, поэтому значения должны иметь вид `projects/<project>/locations/<zone>`.
		name строка	успех	Уникальное имя кластера.
		serveNodes целое число	успех	Количество узлов, выделенных для этого кластера. Большее количество узлов обеспечивает более высокую пропускную способность и более стабильную производительность.
		state строка	успех	Текущее состояние кластера.
	displayName строка		успех	Дескриптивное имя этой виртуальной машины, которое отображается в пользовательских интерфейсах. Может быть изменено в любое время, но должно быть уникальным для избежания путаницы.
	labels словарь		успех	Метки — гибкий и легкий механизм для группирования ресурсов облака, отражающий организационные потребности и стратегии развертывания клиента. Их можно использовать для фильтрации ресурсов и агрегирования метрик.
	name строка		успех	Уникальное имя виртуальной машины.
	state строка		успех	Текущее состояние виртуальной машины.
	type строка		успех	Тип виртуальной машины. По умолчанию `PRODUCTION`.

Авторы

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