google.cloud.gcp_redis_instance_info – Сбор информации об экземпляре GCP

Примечание

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_redis_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 для использования.
region строка / обязательно		Название региона Redis для экземпляра.
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_redis_instance_info:
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources комплексное		всегда	Список ресурсов
	alternativeLocationId строка	успех	Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев в зоне, развертывая его в двух зонах. Если указано, оно должно отличаться от зоны, указанной в [locationId].
	authEnabled логическое	успех	Необязательно. Указывает, включен ли для экземпляра OSS Redis AUTH. Если установлено «true», AUTH включена для экземпляра. Значение по умолчанию — «false», что означает, что AUTH отключена.
	authorizedNetwork строка	успех	Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, будет использоваться сеть по умолчанию.
	connectMode строка	успех	Режим подключения экземпляра Redis.
	createTime строка	успех	Время создания экземпляра в формате RFC3339 UTC «Zulu» с точностью до наносекунд.
	currentLocationId строка	успех	Текущая зона размещения конечной точки Redis. Для экземпляров базового уровня это всегда совпадает с [locationId], предоставленным пользователем при создании. Для экземпляров стандартного уровня это может быть либо [locationId], либо [alternativeLocationId], и оно может измениться после события переключения.
	displayName строка	успех	Произвольное и необязательное имя экземпляра, заданное пользователем.
	host строка	успех	Имя хоста или IP-адрес открытой конечной точки Redis, используемой клиентами для подключения к службе.
	labels словарь	успех	Метки ресурсов для представления пользовательских метаданных.
	locationId строка	успех	Зона, в которой будет развернут экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев в зонах. Если [alternativeLocationId] также указан, он должен отличаться от [locationId].
	memorySizeGb целое число	успех	Размер памяти Redis в ГБ.
	name строка	успех	Идентификатор экземпляра или полное имя идентификатора экземпляра.
	persistenceIamIdentity строка	успех	Только для вывода. Идентификатор Cloud IAM, используемый операциями импорта/экспорта для передачи данных в/из Cloud Storage. Формат «serviceAccount:». Значение может меняться со временем для данного экземпляра, поэтому следует проверять его перед каждой операцией импорта/экспорта.
	port целое число	успех	Номер порта открытой конечной точки Redis.
	redisConfigs словарь	успех	Параметры конфигурации Redis, в соответствии с http://redis.io/topics/config. Список поддерживаемых параметров см. в документации Memorystore: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs .
	redisVersion строка	успех	Версия программного обеспечения Redis. Если не указана, будет использована последняя поддерживаемая версия. В настоящее время поддерживаемые значения: - REDIS_5_0 для совместимости с Redis 5.0 - REDIS_4_0 для совместимости с Redis 4.0 - REDIS_3_2 для совместимости с Redis 3.2 .
	region строка	успех	Название региона Redis экземпляра.
	reservedIpRange строка	успех	Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если не указан, служба выберет неиспользуемый блок /29, например, 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не пересекаться с существующими подсетями в разрешенной сети.
	tier строка	успех	Уровень обслуживания экземпляра. Должно быть одно из следующих значений: - BASIC: автономный экземпляр - STANDARD_HA: высокодоступные экземпляры первичного/резервного копирования .

Авторы

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