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

Примечание

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

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

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

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

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

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

Добавление, обновление или удаление монитора работоспособности из пула балансировщика нагрузки в облаке 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.
delay integer	Интервал между проверками работоспособности в секундах. Обязателен, если значение state равно `present`.
expected_codes string	Список кодов состояния HTTP, ожидаемых в ответе от участника, чтобы считать его работоспособным. Укажите одно из следующих значений. Например, expected_codes может быть одним значением, например `200`, списком, например `200, 202`, или диапазоном, например `200-204`. Значение по умолчанию для expected_codes в Octavia — `200`.
health_monitor_timeout псевдонимы: resp_timeout integer	Время в секундах, по истечении которого проверка работоспособности завершается по тайм-ауту. Должно быть меньше значения delay. Обязателен, если значение state равно `present`.
http_method string	Метод HTTP, используемый монитором работоспособности для запросов. Например, значением http_method может быть `CONNECT`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT` или `TRACE`. Значение по умолчанию для http_method в Octavia — `GET`.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, извлекаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_admin_state_up псевдонимы: admin_state_up boolean	Определяет, включён или выключен монитор работоспособности. Варианты: `false` `true`
max_retries integer	Количество успешных проверок, после которого рабочее состояние участника меняется на ONLINE. Обязателен, если значение state равно `present`.
max_retries_down integer	Количество допустимых ошибок проверки, после которого рабочее состояние участника меняется на ERROR. Допустимые значения — от 1 до 10.
name string / обязательный	Имя, присваиваемое монитору работоспособности. Этот атрибут нельзя обновить.
pool string	Имя или идентификатор пула, который должен отслеживать монитор работоспособности. Обязателен, если значение state равно `present`. Этот атрибут нельзя обновить.
region_name string	Название региона.
sdk_log_level string	Уровень журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго Ansible должен ждать запрошенный ресурс. По умолчанию: `180`
type string	Тип монитора работоспособности. Например, значением type может быть `HTTP`, `HTTPS`, `PING`, `SCTP`, `TCP`, `TLS-HELLO` или `UDP-CONNECT`. Этот атрибут нельзя обновить. По умолчанию: `"HTTP"`
url_path string	Путь URL HTTP-запроса, отправляемого монитором для проверки работоспособности серверного участника. Значение должно быть строкой, начинающейся с косой черты (`/`). Путь URL в Octavia по умолчанию — `/`.
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 health monitor
  openstack.cloud.lb_health_monitor:
    cloud: devstack
    delay: 10
    expected_codes: '200'
    health_monitor_timeout: 5
    http_method: GET
    is_admin_state_up: true
    max_retries: 3
    max_retries_down: 4
    name: healthmonitor01
    pool: lb_pool
    state: present
    url_path: '/status'

- name: Delete a load-balancer health monitor
  openstack.cloud.lb_health_monitor:
    cloud: devstack
    name: healthmonitor01
    state: absent

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

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

Ключ	Описание
health_monitor dictionary	Словарь с описанием монитора работоспособности балансировщика нагрузки. Возвращается: при успешном выполнении, если значение state равно `present`.
created_at string	Дата и время в формате UTC, когда был создан ресурс. Возвращается: при успешном выполнении
delay integer	Интервал в секундах между отправкой проверочных запросов участникам. Возвращается: при успешном выполнении
expected_codes string	Список кодов состояния HTTP, ожидаемых в ответе от участника, чтобы считать его работоспособным. Возвращается: при успешном выполнении
http_method string	Метод HTTP, используемый монитором работоспособности для запросов. Возвращается: при успешном выполнении
id string	UUID монитора работоспособности. Возвращается: при успешном выполнении
is_admin_state_up boolean	Административное состояние ресурса. Возвращается: при успешном выполнении
max_retries integer	Количество успешных проверок, после которого рабочее состояние участника меняется на ONLINE. Возвращается: при успешном выполнении
max_retries_down integer	Количество допустимых ошибок проверки, после которого рабочее состояние участника меняется на ERROR. Возвращается: при успешном выполнении
name string	Понятное для человека имя ресурса. Возвращается: при успешном выполнении
operating_status string	Рабочее состояние ресурса. Возвращается: при успешном выполнении
pool_id string	Идентификатор пула. Возвращается: при успешном выполнении
pools list / элементы=string	Список идентификаторов связанных пулов. Возвращается: при успешном выполнении
project_id string	Идентификатор проекта, которому принадлежит этот ресурс. Возвращается: при успешном выполнении
provisioning_status string	Состояние подготовки ресурса. Возвращается: при успешном выполнении
tags list / элементы=string	Список связанных тегов. Возвращается: при успешном выполнении
timeout integer	Максимальное время в секундах, в течение которого монитор ожидает подключения до истечения времени ожидания. Возвращается: при успешном выполнении
type string	Тип монитора работоспособности. Возвращается: при успешном выполнении
updated_at string	Дата и время в формате UTC последнего обновления ресурса. Возвращается: при успешном выполнении
url_path string	Путь URL HTTP-запроса, отправляемого монитором для проверки работоспособности серверного участника. Возвращается: при успешном выполнении

Авторы

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_health_monitor_module.html