gcp_spanner_instance_info – Сбор информации о GCP-инстансе

Новое в версии 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор информации о GCP-инстансе
Этот модуль назывался gcp_spanner_instance_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: gcp_spanner_instance_facts

Требования

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

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, используя переменную среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

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

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
resources сложное		всегда	Список ресурсов
	config строка	успех	Название конфигурации инстанса (аналогичное, но не совсем то же, что и регион), определяющее географическое расположение и репликацию баз данных в этом инстансе. Определяет, где хранятся данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т. д. Для получения корректного списка обратитесь к [разделу конфигурации документации](https://cloud.google.com/spanner/docs/instances).
	displayName строка	успех	Описание имени этого инстанса, как оно отображается в пользовательских интерфейсах. Должно быть уникальным в рамках проекта и иметь длину от 4 до 30 символов.
	labels словарь	успех	Объект, содержащий список пар "ключ": значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }.
	name строка	успех	Уникальный идентификатор инстанса, который нельзя изменить после создания инстанса. Длина имени должна быть от 6 до 30 символов.
	nodeCount целое число	успех	Количество узлов, выделенных для этого инстанса.

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/gcp_spanner_instance_info_module.html