Модуль vultr.cloud.load_balancer_info — получение информации о балансировщиках нагрузки Vultr

Примечание

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

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

Для установки используйте: ansible-galaxy collection install vultr.cloud.

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

Добавлено в vultr.cloud 1.14.0

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

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

Получение сведений о балансировщиках нагрузки Vultr.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API для API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов следует возвращать за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учётом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает ошибку HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка между повторными попытками увеличивается экспоненциально и ограничена этим максимальным значением в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять SSL-сертификаты API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API: https://www.vultr.com/api/.

Примеры

---
- name: Get Vultr load balancer information
  vultr.cloud.load_balancer_info:
  register: result

- name: Print the information
  ansible.builtin.debug:
  var: result.vultr_load_balancer_info

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

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

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с дополнительными сведениями. Возвращается: success
auto_ssl dictionary	Конфигурация автоматического SSL для балансировщика нагрузки. Возвращается: success
date_created string	Дата и время создания балансировщика нагрузки. Возвращается: success Пример: `"2020-10-10T01:56:20+00:00"`
firewall_rules list / элементы=dictionary	Правила брандмауэра, применённые к балансировщику нагрузки. Возвращается: success
forwarding_rules list / элементы=dictionary	Список правил перенаправления для балансировщика нагрузки. Возвращается: success
generic_info dictionary	Общие сведения о балансировщике нагрузки. Возвращается: success
global_regions list / элементы=string	Конфигурация глобальных регионов для балансировщика нагрузки. Возвращается: success
has_ssl boolean	Включён ли SSL для балансировщика нагрузки. Возвращается: success Пример: `false`
health_check dictionary	Конфигурация проверки работоспособности балансировщика нагрузки. Возвращается: success
http2 boolean	Включён ли HTTP/2. Возвращается: success Пример: `false`
http3 boolean	Включён ли HTTP/3. Возвращается: success Пример: `false`
id string	Уникальный идентификатор балансировщика нагрузки. Возвращается: success Пример: `"cb67a646-66fd-4dfb-b839-443f2e6c0b60"`
instances list / элементы=string	Список экземпляров, подключённых к балансировщику нагрузки. Возвращается: success
ipv4 string	IPv4-адрес балансировщика нагрузки. Возвращается: success Пример: `"192.0.2.1"`
ipv6 string	IPv6-адрес балансировщика нагрузки. Возвращается: success Пример: `"2001:db8::1"`
label string	Метка балансировщика нагрузки. Возвращается: success Пример: `"Example Load Balancer"`
node_ips list / элементы=string	Список IP-адресов узлов балансировщика нагрузки. Возвращается: success
nodes integer	Количество узлов в балансировщике нагрузки. Возвращается: success Пример: `1`
region string	Регион балансировщика нагрузки. Возвращается: success Пример: `"ewr"`
status string	Статус балансировщика нагрузки. Возвращается: success Пример: `"pending"`

Авторы

Garrett Haughawout (@ghaughawout)

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

© 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/vultr/cloud/load_balancer_info_module.html