Модуль vultr.cloud.firewall_rule — управление правилами брандмауэра на Vultr

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

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

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

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

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

Создание и удаление правил брандмауэра.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательный	Ключ API Vultr API. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page целое число добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов возвращать при каждом обращении к API. Это не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учётом других фильтров. Максимальное значение для Vultr API — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries целое число	Количество повторных попыток в случае, если Vultr API возвращает код ошибки 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-запроса к Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
group строка / обязательный	Имя группы брандмауэра.
ip_type строка	Версия IP-адреса Варианты: `"v4"` ← (по умолчанию) `"v6"`
notes строка	Примечания к правилу брандмауэра.
port псевдонимы: port_range строка	Один порт или диапазон портов, например `80` или `8000:8080`. Обязателен, если protocol имеет значение tcp или udp, а state=present.
protocol строка	Протокол правила брандмауэра. Варианты: `"icmp"` `"tcp"` ← (по умолчанию) `"udp"` `"gre"` `"esp"` `"ah"`
source строка	Допустимые значения: `cloudflare` или метка балансировщика нагрузки. Не может использоваться одновременно с subnet.
state строка	Состояние правила брандмауэра. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet строка	Сеть или IP-адрес, например 192.0.2.123 или 0.0.0.0. Не может использоваться одновременно с source.
subnet_size целое число	Количество бит маски подсети в нотации CIDR, например `32`.
validate_certs логическое значение	Проверять сертификаты SSL для Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Ensure a firewall rule is present
  vultr.cloud.firewall_rule:
    group: web
    port: 80
    protocol: tcp
    ip_type: v4
    subnet: "0.0.0.0"
    subnet_size: 0
    notes: "open HTTP to the world"

- name: Ensure a firewall rule with port range is present
  vultr.cloud.firewall_rule:
    group: apps
    port: "8000:8999"
    protocol: tcp
    ip_type: v4
    subnet: "10.10.10.0"
    subnet_size: 24

- name: Ensure a firewall rule is absent
  vultr.cloud.firewall_rule:
    group: apps
    port: "443"
    protocol: tcp
    ip_type: v6
    subnet: "::"
    subnet_size: 0
    state: absent

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

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

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