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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.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 строка	URL конечной точки API (без конечного слэша). Падающее значение переменной окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для API Vultr. Падающее значение переменной окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторной обработки в случае возвращения API Vultr кода HTTP-ошибки, например - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Падающее значение переменной окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка повторной попытки в секундах экспоненциально увеличивается до этого максимального значения. Падающее значение переменной окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP-запроса к API Vultr. Падающее значение переменной окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
group строка / обязательно	Название группы брандмауэра.
validate_certs булево	Проверка SSL-сертификатов API Vultr. Варианты: `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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с несколькими дополнениями/изменениями. Возвращается: успешно
api_endpoint строка	Точка входа, используемая для запросов API. Возвращается: успешно Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество попыток повторных запросов API. Возвращается: успешно Пример: `5`
api_retry_max_delay целое число	Экспоненциальная задержка в секундах между повторными запросами до этой максимальной задержки. Возвращается: успешно Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращается: успешно Пример: `60`
vultr_firewall_rule_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращается: успешно
action строка	Действие правила брандмауэра. Возвращается: успешно Пример: `"accept"`
id целое число	Идентификатор правила брандмауэра. Возвращается: успешно Пример: `1`
ip_type строка	Тип IP-адреса правила брандмауэра. Возвращается: успешно Пример: `"v4"`
notes строка	Предоставленное описание правила брандмауэра. Возвращается: успешно Пример: `"my rule"`
port строка	Порт или диапазон портов правила брандмауэра. Возвращается: успешно Пример: `"80"`
protocol строка	Протокол правила брандмауэра. Возвращается: успешно Пример: `"tcp"`
source строка	Строка источника правила брандмауэра. Возвращается: успешно Пример: `"cloudflare"`
subnet строка	Подсеть правила брандмауэра. Возвращается: успешно Пример: `"0.0.0.0"`
subnet_size целое число	Размер подсети правила брандмауэра. Возвращается: успешно Пример: `0`

Авторы

René Moser (@resmo)

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

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