vr_firewall_rule — Управление правилами брандмауэра на Vultr.
Новая версия 2.5.
Обзор
- Создание и удаление правил брандмауэра.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account | По умолчанию: "default" | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена. |
| api_endpoint | По умолчанию: "https://api.vultr.com" | URL конечной точки API (без конечного слеша). Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена. |
| api_key | Ключ API Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries | По умолчанию: 5 | Количество попыток повторной отправки запроса в случае, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена. |
| api_timeout | По умолчанию: 60 | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена. |
| cidr | По умолчанию: "0.0.0.0/0 или ::/0 в зависимости от ip_version" | Сеть в формате CIDR Формат CIDR должен соответствовать значению ip_type.Обязательно, если state=present. |
| end_port | Конечный порт для правила брандмауэра. Рассматривается только если protocol это tcp или udp и state=present. | |
| group обязательно | Имя группы брандмауэра. | |
| ip_version |
| Версия IP-адреса алиасы: ip_type |
| protocol |
| Протокол правила брандмауэра. |
| start_port | Начальный порт для правила брандмауэра. Требуется, если protocol это tcp или udp и state=present.алиасы: порт | |
| state |
| Состояние правила брандмауэра. |
| validate_certs bool |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: ensure a firewall rule is present
local_action:
module: vr_firewall_rule
group: application
protocol: tcp
start_port: 8000
end_port: 9000
cidr: 17.17.17.0/24
- name: open DNS port for all ipv4 and ipv6
local_action:
module: vr_firewall_rule
group: dns
protocol: udp
port: 53
ip_version: "{{ item }}"
with_items: [ v4, v6 ]
- name: allow ping
local_action:
module: vr_firewall_rule
group: web
protocol: icmp
- name: ensure a firewall rule is absent
local_action:
module: vr_firewall_rule
group: application
protocol: tcp
start_port: 8000
end_port: 9000
cidr: 17.17.17.0/24
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложное | success | Ответ от Vultr API с несколькими дополнениями/изменениями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | success | Максимальное количество попыток повторной отправки запросов API Пример: 5 | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| vultr_firewall_rule сложное | success | Ответ от Vultr API | |
| rule_number целое число | success | Номер правила брандмауэра Пример: 2 | |
| action строка | success | Действие правила брандмауэра Пример: accept | |
| protocol строка | success | Протокол правила брандмауэра Пример: tcp | |
| start_port целое число | success и protocol tcp или udp | Начальный порт правила брандмауэра Пример: 80 | |
| end_port целое число | success и когда диапазон портов и protocol tcp или udp | Конечный порт правила брандмауэра Пример: 8080 | |
| cidr строка | success и когда диапазон портов | CIDR правила брандмауэра (IPv4 или IPv6) Пример: 0.0.0.0/0 | |
| group строка | success | Группа брандмауэра, к которой относится правило. Пример: web | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- René Moser (@resmo)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vr_firewall_rule_module.html
