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

Примечание

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

Для его установки используйте: 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_bigtable_instance_info_module.html