Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.0.0).

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

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

Новый в версии 0.1.0: плагина ngine_io.vultr

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

  • 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_retry_max_delay
целое число
Задержка повторной попытки в секундах, экспоненциально возрастающая до максимального значения.
Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.
Значением по умолчанию является 12 секунд, если не указано иное.
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
булево
    Варианты:
  • no
  • yes ←
Проверка SSL сертификатов Vultr API.

Примечания

Примечание

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

Примеры

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

- name: allow ping
  ngine_io.vultr.vultr_firewall_rule:
    group: web
    protocol: icmp

- name: ensure a firewall rule is absent
  ngine_io.vultr.vultr_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_endpoint
строка
success
Конечная точка, используемая для запросов API

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

Пример:
5
api_retry_max_delay
целое число
success
Задержка экспоненциального возврата в секундах между повторными попытками до максимального значения задержки.

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

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

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

Пример:
accept
cidr
строка
success and when port range
CIDR правила брандмауэра (IPv4 или IPv6)

Пример:
0.0.0.0/0
end_port
целое число
success and when port range and protocol is tcp or udp
Конечный порт правила брандмауэра

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

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

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

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

Пример:
80


Авторы

  • 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.10/collections/ngine_io/vultr/vultr_firewall_rule_module.html

Spec-Zone.ru

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