Модуль google.cloud.gcp_compute_target_pool_info — Сбор информации о GCP TargetPool

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: google.cloud.gcp_compute_target_pool_info.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Сбор информации о GCP TargetPool

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
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.
для аутентификации можно установить 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"

END_OF_DOCUMENT_MARKER

Значения возвращаемых данных

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_target_pool_info_module.html