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

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

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

Обзор

Сбор информации об экземпляре GCP Instance
Этот модуль назывался gcp_redis_instance_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_redis_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, который нужно использовать.
region строка / обязательно		Имя региона Redis экземпляра.
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.
Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
Параметры 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].
	authorizedNetwork строка	успех	Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, будет использоваться сеть по умолчанию.
	createTime строка	успех	Время создания экземпляра в формате RFC3339 UTC «Zulu» с точностью до наносекунд.
	currentLocationId строка	успех	Текущая зона, где размещается конечная точка Redis. Для экземпляров Basic Tier это всегда будет таким же, как и [locationId], указанный пользователем при создании. Для экземпляров Standard Tier это может быть либо [locationId], либо [alternativeLocationId], и может измениться после события переключения.
	displayName строка	успех	Произвольное и необязательное имя, предоставленное пользователем для экземпляра.
	host строка	успех	Имя хоста или IP-адрес экспонированной конечной точки Redis, используемой клиентами для подключения к службе.
	labels словарь	успех	Метки ресурсов для представления пользовательских метаданных.
	locationId строка	успех	Зона, в которой будет размещен экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также указан [alternativeLocationId], он должен отличаться от [locationId].
	memorySizeGb целое число	успех	Размер памяти Redis в ГБ.
	name строка	успех	Идентификатор экземпляра или полное квалифицированное идентификатор экземпляра.
	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_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: высокодоступные экземпляры первичный/повторитель .

Статус

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

Авторы

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