Модуль community.general.apache2_mod_proxy — установка и/или получение атрибутов участников балансировочного пула mod_proxy Apache httpd 2.4

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать его в плейбуке, укажите: community.general.apache2_mod_proxy.

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

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

Установка и/или получение атрибутов участников балансировочного пула mod_proxy Apache httpd 2.4 с помощью HTTP-запросов POST и GET. Страница состояния участников балансировщика httpd mod_proxy должна быть включена и доступна, поскольку модуль получает данные, анализируя эту страницу.

Требования

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

Пакет Python beautifulsoup4

Параметры

Параметр	Комментарии
balancer_url_suffix string	Суффикс URL балансировочного пула, необходимый для доступа к странице состояния пула (например, `balancer_vhost[:port]/balancer_url_suffix`). По умолчанию: `"/balancer-manager/"`
balancer_vhost string / обязательный	(IPv4\|IPv6\|FQDN):port балансировочного пула mod_proxy Apache httpd 2.4.
member_host string	(IPv4\|IPv6\|FQDN) участника балансировщика, атрибуты которого нужно получить или задать. Номер порта определяется автоматически, поэтому указывать его здесь не следует. Если параметр не задан, модуль community.general.apache2_mod_proxy возвращает список словарей с атрибутами всех текущих участников балансировочного пула.
state list / элементы=string	Требуемое состояние хоста-участника. Состояния можно применять одновременно, перечислив их через запятую (например, `state=drained,ignore_errors`), однако рекомендуется указывать их в виде корректного списка YAML. Состояния `present` и `absent` необходимо использовать отдельно, без других состояний. Варианты: `"present"` `"absent"` `"enabled"` `"disabled"` `"drained"` `"hot_standby"` `"ignore_errors"`
tls boolean	Использовать HTTPS для доступа к странице управления балансировщиком. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять сертификаты SSL/TLS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Get all current balancer pool members attributes
  community.general.apache2_mod_proxy:
    balancer_vhost: 10.0.0.2

- name: Get a specific member attributes
  community.general.apache2_mod_proxy:
    balancer_vhost: myws.mydomain.org
    balancer_suffix: /lb/
    member_host: node1.myws.mydomain.org

# Enable all balancer pool members:
- name: Get attributes
  community.general.apache2_mod_proxy:
    balancer_vhost: '{{ myloadbalancer_host }}'
  register: result

- name: Enable all balancer pool members
  community.general.apache2_mod_proxy:
    balancer_vhost: '{{ myloadbalancer_host }}'
    member_host: '{{ item.host }}'
    state: present
  with_items: '{{ result.members }}'

# Gracefully disable a member from a loadbalancer node:
- name: Step 1
  community.general.apache2_mod_proxy:
    balancer_vhost: '{{ vhost_host }}'
    member_host: '{{ member.host }}'
    state: drained
  delegate_to: myloadbalancernode

- name: Step 2
  ansible.builtin.wait_for:
    host: '{{ member.host }}'
    port: '{{ member.port }}'
    state: drained
  delegate_to: myloadbalancernode

- name: Step 3
  community.general.apache2_mod_proxy:
    balancer_vhost: '{{ vhost_host }}'
    member_host: '{{ member.host }}'
    state: absent
  delegate_to: myloadbalancernode

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

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

Ключ	Описание
member dictionary	Словарь с информацией об указанном участнике балансировщика. Возвращается, если модуль вызван с параметром `member_host`. Возвращается: при успешном выполнении Пример: {"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.20", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.20:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}
members list / элементы=string	Список словарей с данными об участниках (описанных выше). Возвращается, если модуль вызван без аргументов `member_host` и `state`. Возвращается: при успешном выполнении Пример: [{"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.20", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.20:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}, {"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.21", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.21:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}]

Ключ

Описание

member

dictionary

Словарь с информацией об указанном участнике балансировщика. Возвращается, если модуль вызван с параметром member_host.

Возвращается: при успешном выполнении

Пример: {"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.20", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.20:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}

members

list / элементы=string

Список словарей с данными об участниках (описанных выше). Возвращается, если модуль вызван без аргументов member_host и state.

Возвращается: при успешном выполнении

Пример: [{"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.20", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.20:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}, {"attributes": {"Busy": "0", "Elected": "42", "Factor": "1", "From": "136K", "Load": "0", "Route": null, "RouteRedir": null, "Set": "0", "Status": "Init Ok ", "To": " 47K", "Worker URL": null}, "balancer_url": "http://10.10.0.2/balancer-manager/", "host": "10.10.0.21", "management_url": "http://10.10.0.2/lb/?b=mywsbalancer&w=http://10.10.0.21:8080/ws&nonce=8925436c-79c6-4841-8936-e7d13b79239b", "path": "/ws", "port": 8080, "protocol": "http", "status": {"disabled": false, "drained": false, "hot_standby": false, "ignore_errors": false}}]

Авторы

Olivier Boukili (@oboukili)

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

© 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/community/general/apache2_mod_proxy_module.html