Модуль google.cloud.gcp_compute_target_pool_info — сбор сведений о TargetPool в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_target_pool_info.
Краткое описание
- Сбор сведений о TargetPool в GCP
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если в качестве типа учетных данных выбрано accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов API. |
filters list / elements=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
region string / обязательный | Регион, в котором находится целевой пул. |
scopes list / elements=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать 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 complex | Список ресурсов Возвращается: всегда |
|
backupPool dictionary |
Это поле применимо только в том случае, если содержащий его целевой пул обслуживает правило переадресации в качестве основного пула, а поле failoverRatio задано надлежащим образом значением в диапазоне [0, 1]. Поля backupPool и failoverRatio совместно определяют поведение при переключении основного целевого пула: если доля работоспособных экземпляров в основном пуле меньше или равна failoverRatio, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул. Если failoverRatio и backupPool не заданы или все экземпляры в резервном пуле неработоспособны, трафик будет перенаправлен обратно в основной пул в режиме «принудительной» обработки. В этом режиме трафик по возможности распределяется между работоспособными экземплярами, а если ни один экземпляр не работоспособен — между всеми экземплярами. Возвращается: при успешном выполнении |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успешном выполнении |
|
failoverRatio string |
Это поле применимо только в том случае, если содержащий его целевой пул обслуживает правило переадресации в качестве основного пула (то есть не является резервным пулом для другого целевого пула). Значение поля должно находиться в диапазоне [0, 1]. Если это поле задано, необходимо также задать backupPool. Вместе они определяют поведение при переключении основного целевого пула: если доля работоспособных экземпляров в основном пуле меньше или равна этому значению, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул. Если failoverRatio не задан или все экземпляры в резервном пуле неработоспособны, трафик будет перенаправлен обратно в основной пул в режиме «принудительной» обработки. В этом режиме трафик по возможности распределяется между работоспособными экземплярами, а если ни один экземпляр не работоспособен — между всеми экземплярами. Возвращается: при успешном выполнении |
|
healthCheck dictionary |
Ссылка на ресурс HttpHealthCheck. Экземпляр — участник этого пула — считается работоспособным только в том случае, если проверки работоспособности пройдены. Если это поле не задано, все экземпляры-участники считаются работоспособными постоянно. Возвращается: при успешном выполнении |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успешном выполнении |
|
instances list / elements=string |
Список экземпляров виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах того же региона, что и этот пул. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса. Задается клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов, а само имя должно соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается: при успешном выполнении |
|
region string |
Регион, в котором находится целевой пул. Возвращается: при успешном выполнении |
|
sessionAffinity string |
Параметр привязки сеанса. Должно быть указано одно из следующих значений: * NONE: подключения с одного IP-адреса клиента могут направляться к любому экземпляру в пуле. * CLIENT_IP: подключения с одного IP-адреса клиента будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остается работоспособным. * CLIENT_IP_PROTO: подключения с одного IP-адреса клиента и с одним и тем же IP-протоколом будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остается работоспособным. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_target_pool_info_module.html