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

Примечание

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

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

Для использования в плейбуке укажите: 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.
Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
Параметры 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_target_pool_info_module.html