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

Примечание

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

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

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

Введено в версии 0.1.0: of 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. алиасы: порт
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 сложный тип		успех	Ответ от Vultr API с несколькими дополнениями/изменениями
	api_account строка	успех	Аккаунт, использованный в файле ini для выбора ключа Пример: default
	api_endpoint строка	успех	Конечная точка, используемая для запросов к API Пример: https://api.vultr.com
	api_retries целое число	успех	Количество максимальных попыток повторного подключения к API Пример: 5
	api_retry_max_delay целое число	успех	Экспоненциальная задержка повторного подключения в секундах между попытками до этого максимального значения. Пример: 12
	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

Авторы

René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_firewall_rule_module.html