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

Примечание

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

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

Для использования в playbook, укажите: 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.
Значения переменных среды будут использоваться только в том случае, если значения в 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 целое число	успех	Количество узлов, выделенных для этого экземпляра.

Авторы

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