Модуль vultr.cloud.firewall_group_info — сбор информации о группах брандмауэра Vultr

Примечание

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

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

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

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

Новое в vultr.cloud 1.0.0

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

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

Сбор информации о доступных группах брандмауэра.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательно	Ключ 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: Gather Vultr firewall groups information
  vultr.cloud.firewall_group_info:
  register: result

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

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

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

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с некоторыми дополнениями и изменениями. Возвращается: success
api_endpoint string	Конечная точка, используемая для запросов API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых за один вызов API. Возвращается: success Пример: `100`
api_retries integer	Максимальное количество повторных попыток для запросов API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах между повторными попытками с экспоненциальным увеличением интервала. Возвращается: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращается: success Пример: `60`
vultr_firewall_group_info list / элементы=string	Ответ API Vultr в виде списка. Возвращается: success
date_created string	Дата создания группы брандмауэра. Возвращается: success Пример: `"2020-10-10T01:56:20+00:00"`
date_modified string	Дата изменения группы брандмауэра. Возвращается: success Пример: `"2020-10-10T01:56:20+00:00"`
description string	Название группы брандмауэра. Возвращается: success Пример: `"my firewall group"`
id string	Идентификатор группы брандмауэра. Возвращается: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`

Авторы

Yanis Guenane (@Spredzy)
René Moser (@resmo)

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

© 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/firewall_group_info_module.html