Модуль hetzner.hcloud.load_balancer_service — создание служб облачных балансировщиков нагрузки и управление ими в Hetzner Cloud.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.load_balancer_service.

Добавлено в hetzner.hcloud 0.1.0

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

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

Создание служб облачных балансировщиков нагрузки и управление ими в Hetzner Cloud.

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

Требования

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

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`.
destination_port целое число	Порт, на который перенаправляется трафик, то есть порт, на котором целевые объекты ожидают и принимают подключения. Обязателен, если служба не существует и протокол — tcp.
health_check словарь	Конфигурация проверок работоспособности
http словарь	Дополнительная конфигурация проверок работоспособности для протоколов http/https
domain строка	Домен, который будет указан в заголовке HTTP HOST
path строка	Путь, к которому будет выполнена попытка обращения
response строка	Ожидаемый ответ. Если ответ не соответствует ожидаемому в проверке работоспособности, целевой объект считается неработоспособным
status_codes список / элементы=строка	Список кодов состояния HTTP, которые ожидаются при выполнении проверки работоспособности.
tls логическое значение	Проверять сертификат TLS; доступно только для протокола проверки работоспособности https Варианты: `false` ← (по умолчанию) `true`
interval целое число	Интервал между проверками работоспособности, в секундах
port целое число	Порт, на котором будет выполняться проверка работоспособности
protocol строка	Протокол, по которому будут выполняться проверки работоспособности Варианты: `"http"` `"https"` `"tcp"`
retries целое число	Количество повторных попыток до того, как целевой объект будет помечен как неработоспособный
timeout целое число	Тайм-аут проверок работоспособности, в секундах
http словарь	Конфигурация служб HTTP и HTTPS
certificates список / элементы=строка	Список имён или идентификаторов сертификатов
cookie_lifetime целое число	Время жизни файла cookie, который устанавливается при включении привязки сеансов, в секундах
cookie_name строка	Имя файла cookie, который устанавливается при включении привязки сеансов
redirect_http логическое значение	Перенаправлять трафик с порта 80 на порт 443; доступно только для протокола https Варианты: `false` ← (по умолчанию) `true`
sticky_sessions логическое значение	Включить или отключить привязку сеансов (sticky_sessions) Варианты: `false` ← (по умолчанию) `true`
listen_port целое число / обязательный	Порт, на котором принимает подключения служба, то есть порт, к которому могут подключаться пользователи.
load_balancer строка / обязательный	Имя или идентификатор балансировщика нагрузки Hetzner Cloud, которому принадлежит служба
protocol строка	Протокол службы. Обязателен, если балансировщик нагрузки не существует. Варианты: `"http"` `"https"` `"tcp"`
proxyprotocol логическое значение	Включить протокол PROXY. Варианты: `false` ← (по умолчанию) `true`
state строка	Состояние балансировщика нагрузки. Варианты: `"absent"` `"present"` ← (по умолчанию)

См. также

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

Примеры

- name: Create a basic Load Balancer service with Port 80
  hetzner.hcloud.load_balancer_service:
    load_balancer: my-load-balancer
    protocol: http
    listen_port: 80
    state: present

- name: Ensure the Load Balancer is absent (remove if needed)
  hetzner.hcloud.load_balancer_service:
    load_balancer: my-Load Balancer
    protocol: http
    listen_port: 80
    state: absent

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

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

Ключ	Описание
hcloud_load_balancer_service dictionary	Экземпляр службы балансировщика нагрузки Возвращается: всегда
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`
load_balancer string	Имя балансировщика нагрузки, которому принадлежит служба Возвращается: всегда Пример: `"my-load-balancer"`
protocol string	Протокол службы Возвращается: всегда Пример: `"http"`
proxyprotocol boolean	Включить протокол PROXY. Возвращается: всегда Пример: `false`

Авторы

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