gcp_compute_target_pool_info – Сбор информации о целевом пуле GCP
Новая в версии 2.7.
Обзор
- Сбор информации о целевом пуле GCP
- Этот модуль назывался
gcp_compute_target_pool_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: gcp_compute_target_pool_facts
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | |
| filters список | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (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 с помощью переменной среды 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. - Значения переменных среды будут использоваться только в том случае, если значения в 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 будут идти на тот же экземпляр в пуле, пока этот экземпляр остается здоровым. | |
Статус
- Не гарантируется, что у этого модуля будет обратная совместимость. [превью]
- Этот модуль поддерживается сообществом 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_compute_target_pool_info_module.html
