Модуль hetzner.hcloud.load_balancer_info — сбор информации о балансировщиках нагрузки Hetzner Cloud.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

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

Чтобы использовать его в сценарии, укажите: hetzner.hcloud.load_balancer_info.

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

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

Сбор информации о балансировщиках нагрузки Hetzner Cloud..

Псевдонимы: hcloud_load_balancer_info

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Эту настройку также можно задать с помощью переменной среды `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Эту настройку также можно задать с помощью переменной среды `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен для API Hetzner Cloud. Эту настройку также можно задать с помощью переменной среды `HCLOUD_TOKEN`.
id целое число	Идентификатор балансировщиков нагрузки, которые требуется получить. Модуль завершится с ошибкой, если указанный идентификатор недействителен.
label_selector строка	Селектор меток для балансировщиков нагрузки, которые требуется получить.
name строка	Имя балансировщиков нагрузки, которые требуется получить.

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Gather hcloud load_balancer infos
  hetzner.hcloud.load_balancer_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

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

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

Ключ	Описание
hcloud_load_balancer_info list / elements=string	Сведения о балансировщиках нагрузки в виде списка Возвращается: всегда
delete_protection boolean	True, если балансировщик нагрузки защищён от удаления Возвращается: всегда Пример: `false`
disable_public_interface boolean	True, если общедоступный интерфейс балансировщика нагрузки отключён Возвращается: всегда Пример: `false`
id integer	Числовой идентификатор балансировщика нагрузки Возвращается: всегда Пример: `1937415`
ipv4_address string	Общедоступный IPv4-адрес балансировщика нагрузки Возвращается: всегда Пример: `"116.203.104.109"`
ipv6_address string	Общедоступный IPv6-адрес балансировщика нагрузки Возвращается: всегда Пример: `"2a01:4f8:1c1c:c140::1"`
labels dictionary	Метки, заданные пользователем (пары «ключ — значение») Возвращается: всегда
load_balancer_type string	Название типа балансировщика нагрузки Возвращается: всегда Пример: `"lb11"`
location string	Название расположения балансировщика нагрузки Возвращается: всегда Пример: `"fsn1"`
name string	Название балансировщика нагрузки Возвращается: всегда Пример: `"my-Load-Balancer"`
services list / elements=string	Все службы этого балансировщика нагрузки Возвращается: всегда
destination_port integer	Порт, на который перенаправляется трафик, то есть порт, на котором целевые объекты принимают подключения. Возвращается: всегда Пример: `80`
health_check dictionary	Конфигурация проверок работоспособности Возвращается: всегда
http dictionary	Дополнительная конфигурация проверок работоспособности с протоколом http/https Возвращается: всегда
domain string	Домен, который будет указан в заголовке HTTP HOST Возвращается: всегда Пример: `"example.com"`
path string	Путь, к которому будет выполнена попытка доступа Возвращается: всегда Пример: `"/"`
response string	Ожидаемый ответ; если ответ не соответствует ответу проверки работоспособности, целевой объект считается неисправным Возвращается: всегда
status_codes list / elements=string	Список кодов состояния HTTP, которые ожидаются при выполнении проверки работоспособности. Возвращается: всегда Пример: `["2??", "3??"]`
tls boolean	Проверять сертификат TLS; доступно только при использовании протокола https для проверки работоспособности Возвращается: всегда Пример: `false`
interval integer	Интервал между проверками работоспособности в секундах Возвращается: всегда Пример: `15`
port integer	Порт, на котором будет выполняться проверка работоспособности Возвращается: всегда Пример: `80`
protocol string	Протокол, по которому будут выполняться проверки работоспособности Возвращается: всегда Пример: `"http"`
retries integer	Количество повторных попыток, после которого целевой объект помечается как неисправный Возвращается: всегда Пример: `3`
timeout integer	Тайм-аут проверок работоспособности в секундах Возвращается: всегда Пример: `10`
http dictionary	Конфигурация служб HTTP и HTTPS Возвращается: всегда
certificates list / elements=string	Список названий или идентификаторов сертификатов Возвращается: всегда
cookie_lifetime integer	Срок действия cookie, устанавливаемой при включении привязки сессий, в секундах Возвращается: всегда Пример: `3600`
cookie_name string	Название cookie, которая устанавливается при включении привязки сессий Возвращается: всегда Пример: `"HCLBSTICKY"`
redirect_http boolean	Перенаправлять трафик с порта 80 на порт 443; доступно только при использовании протокола https Возвращается: всегда Пример: `false`
sticky_sessions boolean	Включить или отключить привязку сессий Возвращается: всегда Пример: `true`
listen_port integer	Порт, на котором прослушивает служба, то есть порт, к которому могут подключаться пользователи. Возвращается: всегда Пример: `443`
protocol string	Протокол службы Возвращается: всегда Пример: `"http"`
proxyprotocol boolean	Включить протокол PROXY. Возвращается: всегда Пример: `false`
targets list / elements=string	Целевые объекты балансировщика нагрузки Возвращается: всегда
health_status list / elements=string	Список состояний работоспособности служб на этом целевом объекте. Присутствует только для целевых объектов типов «server» и «ip». Возвращается: если type равен server или ip
listen_port integer	Порт прослушивания целевого объекта балансировщика нагрузки Возвращается: всегда Пример: `80`
status string	Состояние целевого объекта балансировщика нагрузки Возвращается: всегда Возможные значения: `"healthy"` `"unhealthy"` `"unknown"` Пример: `"healthy"`
ip string	IP-адрес выделенного сервера Возвращается: если type равен ip Пример: `"127.0.0.1"`
label_selector string	Селектор меток Возвращается: если type равен label_selector Пример: `"application=backend"`
load_balancer string	Название балансировщика нагрузки Возвращается: всегда Пример: `"my-LoadBalancer"`
server string	Название сервера Возвращается: если type равен server Пример: `"my-server"`
type string	Тип целевого объекта балансировщика нагрузки Возвращается: всегда Пример: `"server"`
use_private_ip boolean	Направлять трафик через частный IP-адрес балансировщика нагрузки по сети Hetzner Cloud. Балансировщик нагрузки должен быть подключён к сети. См. hetzner.hcloud.load_balancer_network Возвращается: всегда Пример: `true`

Авторы

Lukas Kaemmerling (@LKaemmerling)

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

© 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/hetzner/hcloud/load_balancer_info_module.html