Модуль hetzner.hcloud.load_balancer_info – Сбор информации о ваших балансировщиках нагрузки Hetzner Cloud.
Примечание
Этот модуль является частью коллекции hetzner.hcloud (версия 3.1.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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. Вы также можете задать этот параметр, используя переменную среды По умолчанию: |
api_token строка / обязательно | Токен API для Hetzner Cloud. Вы также можете задать этот параметр, используя переменную среды |
id целое число | Идентификатор балансировщиков нагрузки, которые вы хотите получить. Модуль завершится ошибкой, если предоставленный идентификатор недействителен. |
label_selector строка | Селектор меток для балансировщиков нагрузки, которые вы хотите получить. |
name строка | Имя балансировщиков нагрузки, которые вы хотите получить. |
См. также
См. также
- Документация по API Hetzner Cloud
-
Полная справка по API Hetzner Cloud.
Примеры
- 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 сложный | Информация о балансировщиках нагрузки в виде списка Возвращается: всегда |
|
delete_protection булево |
Истинно, если балансировщик нагрузки защищен от удаления Возвращается: всегда Пример: |
|
disable_public_interface булево |
Истинно, если общедоступный интерфейс балансировщика нагрузки отключен Возвращается: всегда Пример: |
|
id целое число |
Числовой идентификатор балансировщика нагрузки Возвращается: всегда Пример: |
|
ipv4_address строка |
Общедоступный IPv4-адрес балансировщика нагрузки Возвращается: всегда Пример: |
|
ipv6_address строка |
Общедоступный IPv6-адрес балансировщика нагрузки Возвращается: всегда Пример: |
|
labels словарь |
Пользовательские метки (пары ключ-значение) Возвращается: всегда |
|
load_balancer_type строка |
Имя типа балансировщика нагрузки Возвращается: всегда Пример: |
|
location строка |
Название расположения балансировщика нагрузки Возвращается: всегда Пример: |
|
name строка |
Имя балансировщика нагрузки Возвращается: всегда Пример: |
|
services сложный |
все сервисы этого балансировщика нагрузки Возвращается: Всегда |
|
destination_port целое число |
Порт, на который пересылается трафик, т.е. порт, на котором цели слушают и принимают подключения. Возвращается: всегда Пример: |
|
health_check сложный |
Настройка проверок работоспособности Возвращается: всегда |
|
http сложный |
Дополнительная настройка проверок работоспособности с протоколами http/https Возвращается: всегда |
|
domain строка |
Домен, который будет установлен в заголовке HTTP HOST Возвращается: всегда Пример: |
|
path строка |
Путь, который будет попытан для доступа Возвращается: всегда Пример: |
|
response строка |
Ожидаемый ответ; если ответ не соответствует ожидаемому результату проверки работоспособности, целевой объект считается неработоспособным Возвращается: всегда |
|
status_codes list / elements=string |
Список кодов состояния HTTP, которые мы ожидаем получить при выполнении проверки работоспособности. Возвращается: всегда Пример: |
|
tls boolean |
Проверить сертификат TLS, доступно только если протокол проверки работоспособности - https Возвращается: всегда Пример: |
|
interval integer |
Интервал проверок работоспособности, в секундах Возвращается: всегда Пример: |
|
port integer |
Порт, на котором будет выполняться проверка работоспособности Возвращается: всегда Пример: |
|
protocol string |
Протокол, по которому будут выполняться проверки работоспособности Возвращается: всегда Пример: |
|
retries integer |
Количество попыток, прежде чем целевой объект будет помечен как неработоспособный Возвращается: всегда Пример: |
|
timeout integer |
Время ожидания проверок работоспособности, в секундах Возвращается: всегда Пример: |
|
http complex |
Конфигурация для служб HTTP и HTTPS Возвращается: всегда |
|
certificates list / elements=string |
Список имен или ID сертификатов Возвращается: всегда |
|
cookie_lifetime integer |
Время жизни cookie, который будет установлен при включении sticky sessions, в секундах Возвращается: всегда Пример: |
|
cookie_name string |
Имя cookie, которое будет установлено при включении sticky sessions Возвращается: всегда Пример: |
|
redirect_http boolean |
Перенаправить трафик с порта 80 на порт 443, доступно только если протокол - https Возвращается: всегда Пример: |
|
sticky_sessions boolean |
Включить или отключить sticky_sessions Возвращается: всегда Пример: |
|
listen_port integer |
Порт, на котором работает служба, т.е. порт, к которому могут подключаться пользователи. Возвращается: всегда Пример: |
|
protocol string |
Протокол службы Возвращается: всегда Пример: |
|
proxyprotocol boolean |
Включить протокол PROXY. Возвращается: всегда Пример: |
|
status string |
Статус балансировщика нагрузки Возвращается: всегда Пример: |
|
targets complex |
Цели балансировщика нагрузки Возвращается: всегда |
|
health_status список / элементы=строка |
Список статусов работоспособности служб на данной цели. Присутствует только для типов целей «сервер» и «ip». Возвращается: если тип равен server или ip |
|
listen_port целое число |
Порт прослушивания цели балансировщика нагрузки Возвращается: всегда Пример: |
|
status строка |
Статус цели балансировщика нагрузки Возвращается: всегда Возможные значения:
Пример: |
|
ip строка |
IP выделенного сервера Возвращается: если тип равен ip Пример: |
|
label_selector строка |
Селектор меток Возвращается: если тип равен label_selector Пример: |
|
load_balancer строка |
Название балансировщика нагрузки Возвращается: всегда Пример: |
|
server строка |
Имя сервера Возвращается: если тип равен server Пример: |
|
type строка |
Тип цели балансировщика нагрузки Возвращается: всегда Пример: |
|
use_private_ip логическое |
Направить трафик через частный IP балансировщика нагрузки через сеть Hetzner Cloud. Балансировщик нагрузки должен быть подключен к сети. См. hetzner.hcloud.load_balancer_network Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/load_balancer_info_module.html
