Spec-Zone.ru › Ansible 2.7

vultr_firewall_rule – Управление правилами брандмауэра на Vultr.

Новая версия с 2.5.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Псевдонимы: vr_firewall_rule

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_account
-
Значение по умолчанию:
"default"
Имя раздела ini в файле vultr.ini.
Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если определена.
api_endpoint
-
URL конечной точки API (без конечной косой черты).
Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — https://api.vultr.com, если не указано.
api_key
-
Ключ API Vultr API.
Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если определена.
api_retries
-
Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503.
Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — 5 попыток, если не указано.
api_timeout
-
Таймаут HTTP для Vultr API.
Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — 60 секунд, если не указано.
cidr
-
Сеть в формате CIDR
Формат CIDR должен соответствовать значению ip_version.
Обязательно, если state=present.
По умолчанию 0.0.0.0/0 или ::/0 в зависимости от ip_version.
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
boolean
    Варианты:
  • no
  • yes ←
Проверять SSL сертификаты Vultr API.

Примечания

Примечание

  • Также обратитесь к документации API по https://www.vultr.com/api/.

Примеры

- name: ensure a firewall rule is present
  local_action:
    module: vultr_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: vultr_firewall_rule
    group: dns
    protocol: udp
    port: 53
    ip_version: "{{ item }}"
  with_items: [ v4, v6 ]

- name: allow ping
  local_action:
    module: vultr_firewall_rule
    group: web
    protocol: icmp

- name: ensure a firewall rule is absent
  local_action:
    module: vultr_firewall_rule
    group: application
    protocol: tcp
    start_port: 8000
    end_port: 9000
    cidr: 17.17.17.0/24
    state: absent

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

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

Ключ Возвращается Описание
vultr_api
сложное
успех
Ответ от Vultr API с некоторыми дополнениями/изменениями

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

Пример:
default
api_endpoint
строка
успех
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_retries
целое число
успех
Максимальное количество попыток повторного выполнения запросов API

Пример:
5
api_timeout
целое число
успех
Таймаут, используемый для запросов API

Пример:
60
vultr_firewall_rule
сложное
успех
Ответ от Vultr API

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

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

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

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

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

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

Пример:
2
start_port
целое число
успех и протокол tcp или udp
Начальный порт правила брандмауэра

Пример:
80


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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

Spec-Zone.ru

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