Модуль openstack.cloud.lb_pool — управление пулом балансировщика нагрузки в облаке OpenStack.

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.lb_pool.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Добавление, обновление или удаление пула балансировщика нагрузки в облаке OpenStack.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго уровень сокетов должен ожидать ответа, прежде чем завершить ожидание вызовов API по тайм-ауту. Если параметр не указан, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми выбранной облачной стратегией подключаемого модуля аутентификации. Для подключаемого модуля password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей в этом параметре должны содержаться необходимые им значения. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.
auth_type string	Имя подключаемого модуля аутентификации. Если в облаке используется не аутентификация по паролю, укажите здесь имя подключаемого модуля и настройте соответствующим образом параметр auth.
ca_cert псевдонимы: cacert string	Путь к набору сертификатов CA, который можно использовать для проверки SSL-запросов API.
client_cert псевдонимы: cert string	Путь к клиентскому сертификату, который будет использоваться при SSL-транзакции.
client_key псевдонимы: key string	Путь к клиентскому ключу, который будет использоваться при SSL-транзакции.
cloud any	Именованное облако или конфигурация облака, для которого выполняются действия. Если значение cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_. Если значение cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
description string	Описание пула балансировщика нагрузки для пользователей.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
lb_algorithm string	Алгоритм балансировки нагрузки для пула. Например, значение lb_algorithm может быть `LEAST_CONNECTIONS`, `ROUND_ROBIN`, `SOURCE_IP` или `SOURCE_IP_PORT`. По умолчанию: `"ROUND_ROBIN"`
listener string	Имя или идентификатор прослушивателя, которому принадлежит этот пул. При создании пула необходимо указать либо listener, либо loadbalancer. Этот атрибут нельзя обновить.
loadbalancer string	Имя или идентификатор балансировщика нагрузки, которому принадлежит этот пул. При создании пула необходимо указать либо listener, либо loadbalancer. Этот атрибут нельзя обновить.
name string / обязательный	Имя, которое необходимо присвоить пулу. Этот атрибут нельзя обновить.
protocol string	Протокол пула. Например, значение protocol может быть `HTTP`, `HTTPS`, `PROXY`, `PROXYV2`, `SCTP`, `TCP` или `UDP`. Этот атрибут нельзя обновить. По умолчанию: `"HTTP"`
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять SSL-запросы API. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
Обработка данных аутентификации осуществляется openstacksdk. Значения могут быть получены из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Подробнее см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Create a load-balancer pool
  openstack.cloud.lb_pool:
    cloud: mycloud
    lb_algorithm: ROUND_ROBIN
    loadbalancer: test-loadbalancer
    name: test-pool
    protocol: HTTP
    state: present

- name: Delete a load-balancer pool
  openstack.cloud.lb_pool:
    cloud: mycloud
    name: test-pool
    state: absent

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

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

Ключ	Описание
pool dictionary	Словарь с описанием пула балансировщика нагрузки. Возвращается: при успешном выполнении, если state имеет значение `present`.
alpn_protocols list / элементы=string	Список протоколов ALPN. Возвращается: при успешном выполнении
created_at string	Временная метка создания пула. Возвращается: при успешном выполнении
description string	Описание пула. Возвращается: при успешном выполнении
health_monitor_id string	Идентификатор монитора работоспособности. Возвращается: при успешном выполнении
id string	Уникальный UUID. Возвращается: при успешном выполнении
is_admin_state_up boolean	Административное состояние пула. Возвращается: при успешном выполнении
lb_algorithm string	Алгоритм балансировки нагрузки для пула. Возвращается: при успешном выполнении
listener_id string	Идентификатор прослушивателя, которому принадлежит пул. Возвращается: при успешном выполнении
listeners list / элементы=string	Список идентификаторов прослушивателей. Возвращается: при успешном выполнении
loadbalancer_id string	Идентификатор балансировщика нагрузки, которому принадлежит пул. Это поле задаётся, если пул не принадлежит ни одному прослушивателю балансировщика нагрузки. Возвращается: при успешном выполнении
loadbalancers list / элементы=string	Список идентификаторов балансировщиков нагрузки. Возвращается: при успешном выполнении
members list / элементы=string	Список идентификаторов участников. Возвращается: при успешном выполнении
name string	Имя, присвоенное пулу. Возвращается: при успешном выполнении
operating_status string	Рабочее состояние пула. Возвращается: при успешном выполнении
project_id string	Идентификатор проекта. Возвращается: при успешном выполнении
protocol string	Протокол пула. Возвращается: при успешном выполнении
provisioning_status string	Состояние подготовки пула. Возвращается: при успешном выполнении
session_persistence dictionary	Объект JSON с настройками сохранения сеансов для пула. Возвращается: при успешном выполнении
tags list / элементы=string	Список связанных тегов. Возвращается: при успешном выполнении
tls_ciphers string	Строка со списком наборов шифров в формате OpenSSL. Возвращается: при успешном выполнении
tls_enabled boolean	Использование TLS для подключений к серверам участников внутреннего пула. Возвращается: при успешном выполнении
tls_versions list / элементы=string	Список версий протокола TLS, используемых пулом. Возвращается: при успешном выполнении
updated_at string	Временная метка обновления пула. Возвращается: при успешном выполнении

Авторы

OpenStack Ansible SIG

Ссылки на коллекцию

© 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/openstack/cloud/lb_pool_module.html