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

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_spanner_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_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 словарь	успех	Объект, содержащий список пар "ключ": значение. Пример: { "имя": "ключ", "масса": "1.3кг", "количество": "3" }.
	name строка	успех	Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна быть от 6 до 30 символов.
	nodeCount целое число	успех	Количество узлов, выделенных для данного экземпляра.

Авторы

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_spanner_instance_info_module.html