google.cloud.gcp_compute_target_pool_info – Сбор информации о целевом пуле GCP

Примечание

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

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

Для использования в playbook укажите: google.cloud.gcp_compute_target_pool_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-запросов.
filters список / элементы=строка		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка		Проект Google Cloud Platform, который нужно использовать.
region строка / обязательно		Регион, в котором находится целевой пул.
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 a target pool
  gcp_compute_target_pool_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources сложный		всегда	Список ресурсов
	backupPool словарь	успех	Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула и поле failoverRatio правильно установлено в значение между [0, 1]. backupPool и failoverRatio вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или ниже failoverRatio, трафик, поступающий на IP-адрес балансировки нагрузки, будет перенаправлен на резервный пул. В случае, когда failoverRatio и backupPool не установлены или все экземпляры в резервном пуле нездоровы, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, когда экземпляр не является здоровым.
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса.
	failoverRatio строка	успех	Это поле применимо только тогда, когда содержащий целевой пул работает как основной пул для правила переадресации (т. е. не как резервный пул для другого целевого пула). Значение поля должно быть в диапазоне [0, 1]. Если установлено, backupPool также должно быть установлено. Они вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше этого числа, трафик, поступающий на IP-адрес балансировки нагрузки, будет перенаправлен на резервный пул. В случае, когда failoverRatio не установлено или все экземпляры в резервном пуле нездоровы, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, когда экземпляр не является здоровым.
	healthCheck словарь	успех	Ссылка на ресурс HttpHealthCheck. Экземпляр члена в этом пуле считается здоровым только в том случае, если проверки работоспособности пройдены. Если не указано, это означает, что все экземпляры членов будут считаться здоровыми во все время.
	id целое число	успех	Уникальный идентификатор ресурса.
	instances список / элементы=строка	успех	Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в том же регионе, что и этот пул.
	name строка	успех	Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. То есть длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	region строка	успех	Регион, в котором находится целевой пул.
	sessionAffinity строка	успех	Опция сессионной аффилированности. Должно быть одно из этих значений: - NONE: Подключения от одного и того же IP-адреса клиента могут идти к любому экземпляру в пуле. - CLIENT_IP: Подключения от одного и того же IP-адреса клиента будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. - CLIENT_IP_PROTO: Подключения от одного и того же IP-адреса клиента с тем же протоколом IP будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым.

Авторы

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