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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: vultr.cloud.firewall_rule_info.

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

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

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

Собирает информацию о доступных правилах брандмауэра.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API для Vultr API. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы с учетом других фильтров. Максимальное значение для Vultr API — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если Vultr API возвращает код ошибки 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-запросов к Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
group string / обязательный	Имя группы брандмауэра.
validate_certs boolean	Проверять SSL-сертификаты Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Gather Vultr firewall rule information
  vultr.cloud.firewall_rule_info:
    group: my group
  register: result

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

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

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

Ключ	Описание
vultr_api dictionary	Ответ Vultr API с некоторыми дополнениями и изменениями. Возвращается: 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_rule_info list / elements=string	Ответ Vultr API в виде списка. Возвращается: success
action string	Действие правила брандмауэра. Возвращается: success Пример: `"accept"`
id integer	Идентификатор правила брандмауэра. Возвращается: success Пример: `1`
ip_type string	Тип IP-адреса в правиле брандмауэра. Возвращается: success Пример: `"v4"`
notes string	Указанное описание правила брандмауэра. Возвращается: success Пример: `"my rule"`
port string	Порт или диапазон портов в правиле брандмауэра. Возвращается: success Пример: `"80"`
protocol string	Протокол правила брандмауэра. Возвращается: success Пример: `"tcp"`
source string	Строка источника правила брандмауэра. Возвращается: success Пример: `"cloudflare"`
subnet string	Подсеть правила брандмауэра. Возвращается: success Пример: `"0.0.0.0"`
subnet_size integer	Размер подсети правила брандмауэра. Возвращается: success Пример: `0`

Авторы

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