Spec-Zone.ru › Ansible 2.5

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 в зависимости от C(ip_version)
Сеть в формате CIDR
Формат CIDR должен совпадать со значением ip_type.
Обязательно, если state=present.
end_port
Конечный порт для правила брандмауэра.
Учитывается только если protocol tcp или udp и state=present.
group
обязательно
Имя группы брандмауэра.
ip_version
    Варианты:
  • v4 ←
  • v6
Версия IP-адреса

псевдонимы: ip_type
protocol
    Варианты:
  • icmp
  • tcp ←
  • udp
  • gre
Протокол правила брандмауэра.
start_port
Начальный порт для правила брандмауэра.
Требуется, если protocol tcp или udp и state=present.

псевдонимы: port
state
    Варианты:
  • present ←
  • absent
Состояние правила брандмауэра.
validate_certs
    Варианты:
  • no
  • yes ←
Проверять 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_endpoint
строка
success
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_timeout
целое число
success
Таймаут, используемый для запросов API

Пример:
60
api_retries
целое число
success
Максимальное количество попыток повторного подключения для запросов API

Пример:
5
api_account
строка
success
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default
vultr_firewall_rule
сложный
success
Ответ от Vultr API

start_port
целое число
success и protocol tcp или udp
Начальный порт правила брандмауэра

Пример:
80
action
строка
success
Действие правила брандмауэра

Пример:
accept
group
строка
success
Группа брандмауэра, в которой находится правило.

Пример:
web
cidr
строка
success и когда диапазон портов
CIDR правила брандмауэра (IPv4 или IPv6)

Пример:
0.0.0.0/0
end_port
целое число
success и когда диапазон портов и protocol tcp или udp
Конечный порт правила брандмауэра

Пример:
8080
rule_number
целое число
success
Номер правила брандмауэра

Пример:
2
protocol
строка
success
Протокол правила брандмауэра

Пример:
tcp


Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.

Автор

  • 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.5/modules/vr_firewall_rule_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API