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

Примечание

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

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

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

Для использования в playbook, укажите: vultr.cloud.firewall_rule.

Новое в vultr.cloud 1.0.0

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

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

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

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без косой черты в конце). Запасная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / required	API ключ Vultr API. Запасная переменная окружения `VULTR_API_KEY`.
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 / required	Имя группы брандмауэра.
ip_type string	Версия IP-адреса Варианты: `"v4"` ← (по умолчанию) `"v6"`
notes string	Примечания к правилу брандмауэра.
port aliases: port_range string	Один порт или диапазон портов, например `80` или `8000:8080`. Обязательно, если protocol — tcp или udp и state=present.
protocol string	Протокол правила брандмауэра. Варианты: `"icmp"` `"tcp"` ← (по умолчанию) `"udp"` `"gre"` `"esp"` `"ah"`
source string	Возможные значения — `cloudflare` или метка балансировщика нагрузки. Взаимоисключающе с subnet.
state string	Состояние правила брандмауэра. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet string	Сеть или IP-адрес, например 192.0.2.123 или 0.0.0.0. Взаимоисключающе с source.
subnet_size integer	Количество бит для маски сети в нотации CIDR, например `32`.
validate_certs boolean	Проверять 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 словарь	Ответ от 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 словарь	Ответ от 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_module.html