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

Примечание

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

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

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

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

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

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

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
address string	IP-адрес участника. Обязателен, если значение state — `present`. Этот атрибут нельзя обновить.
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	Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов 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.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, извлекаемый из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
monitor_address string	IP-адрес, используемый для мониторинга этого участника.
monitor_port integer	Порт, используемый для мониторинга этого участника.
name string / обязательный	Имя, назначаемое участнику.
pool string / обязательный	Имя или идентификатор пула, к которому относится этот участник. Этот атрибут нельзя обновить.
protocol_port integer	Номер порта протокола для участника. Обязателен, если значение state — `present`. Этот атрибут нельзя обновить.
region_name string	Название региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.
state string	Ресурс должен быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet_id string	Идентификатор подсети, из которой доступна служба участника. Этот атрибут нельзя обновить.
timeout integer	Время ожидания Ansible запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы SSL API. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Следует ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)
weight integer	Вес участника определяет долю запросов или подключений, обслуживаемых им по сравнению с другими участниками пула. Например, участник с весом 10 получает в пять раз больше запросов, чем участник с весом 2. Значение 0 означает, что участник не получает новые подключения, но продолжает обслуживать существующие. Допустимые значения: от 0 до 256. Значение параметра weight по умолчанию для Octavia — `1`.

Примечания

Примечание

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

Примеры

- name: Create member in a load-balancer pool
  openstack.cloud.lb_member:
    address: 192.168.10.3
    cloud: mycloud
    name: test-member
    pool: test-pool
    protocol_port: 8080
    state: present

- name: Delete member from a load-balancer pool
  openstack.cloud.lb_member:
    cloud: mycloud
    name: test-member
    pool: test-pool
    state: absent

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

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

Ключ	Описание
member dictionary	Словарь с описанием участника пула балансировщика нагрузки. Возвращается: при успешном выполнении, если state имеет значение `present`.
address string	IP-адрес сервера — участника серверной части. Возвращается: при успешном выполнении
backup boolean	Логическое значение, указывающее, является ли участник резервным. Резервные участники получают трафик только тогда, когда все основные участники недоступны. Возвращается: при успешном выполнении
created_at string	Время создания участника. Возвращается: при успешном выполнении
id string	Уникальный UUID. Возвращается: при успешном выполнении
is_admin_state_up boolean	Административное состояние участника. Возвращается: при успешном выполнении
monitor_address string	IP-адрес, используемый для проверки этого участника. Возвращается: при успешном выполнении
monitor_port integer	Порт, используемый для проверки этого участника. Возвращается: при успешном выполнении
name string	Имя, присвоенное участнику. Возвращается: при успешном выполнении
operating_status string	Рабочее состояние участника. Возвращается: при успешном выполнении
project_id string	Идентификатор проекта, с которым связан этот участник. Возвращается: при успешном выполнении
protocol_port integer	Номер порта протокола для участника. Возвращается: при успешном выполнении
provisioning_status string	Состояние подготовки участника. Возвращается: при успешном выполнении
subnet_id string	Идентификатор подсети, из которой доступна служба участника. Возвращается: при успешном выполнении
tags list / elements=string	Список связанных тегов. Возвращается: при успешном выполнении
updated_at string	Время последнего обновления участника. Возвращается: при успешном выполнении
weight integer	Положительное целое число, указывающее относительную долю трафика из пула, которую должен получать этот участник. Например, участник с весом 10 получает в пять раз больше трафика, чем участник с весом 2. Возвращается: при успешном выполнении
pool dictionary	Словарь с описанием пула балансировщика нагрузки. Возвращается: при успешном выполнении, если state имеет значение `present`.
alpn_protocols list / elements=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 / elements=string	Список идентификаторов прослушивателей. Возвращается: при успешном выполнении
loadbalancer_id string	Идентификатор балансировщика нагрузки, к которому относится пул. Это поле задается, если пул не относится ни к одному прослушивателю балансировщика нагрузки. Возвращается: при успешном выполнении
loadbalancers list / elements=string	Список идентификаторов балансировщиков нагрузки. Возвращается: при успешном выполнении
members list / elements=string	Список идентификаторов участников. Возвращается: при успешном выполнении
name string	Имя, присвоенное пулу. Возвращается: при успешном выполнении
operating_status string	Рабочее состояние пула. Возвращается: при успешном выполнении
project_id string	Идентификатор проекта. Возвращается: при успешном выполнении
protocol string	Протокол для пула. Возвращается: при успешном выполнении
provisioning_status string	Состояние подготовки пула. Возвращается: при успешном выполнении
session_persistence dictionary	Объект JSON с настройками сохранения сеансов для пула. Возвращается: при успешном выполнении
tags list / elements=string	Список связанных тегов. Возвращается: при успешном выполнении
tls_ciphers string	Содержит строку наборов шифров в формате OpenSSL. Возвращается: при успешном выполнении
tls_enabled boolean	Использовать TLS для подключений к серверам — участникам серверной части. Возвращается: при успешном выполнении
tls_versions list / elements=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_member_module.html