Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_application_list — настройка списков управления приложениями в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_application_list.

Новое в fortinet.fortios 2.0.0

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

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций приложений и категории списков. В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

application_list

dictionary

Настройка списков управления приложениями.

app_replacemsg

string

Включить или отключить сообщения-замены для заблокированных приложений.

Варианты:

  • "disable"
  • "enable"

comment

string

Комментарии.

control_default_network_services

string

Включить или отключить проверку протоколов на выбранных портах.

Варианты:

  • "disable"
  • "enable"

deep_app_inspection

string

Включить или отключить глубокую проверку приложений.

Варианты:

  • "disable"
  • "enable"

default_network_services

list / elements=dictionary

Записи служб сети по умолчанию.

id

integer / обязательный

Идентификатор записи. см. <a href=’#notes’>Примечания</a>.

port

integer

Номер порта.

services

list / elements=string

Сетевые протоколы.

Варианты:

  • "http"
  • "ssh"
  • "telnet"
  • "ftp"
  • "dns"
  • "smtp"
  • "pop3"
  • "imap"
  • "snmp"
  • "nntp"
  • "https"

violation_action

string

Действие для протоколов, отсутствующих в списке разрешенных для выбранного порта.

Варианты:

  • "pass"
  • "monitor"
  • "block"

enforce_default_app_port

string

Включить или отключить применение порта приложения по умолчанию для разрешенных приложений.

Варианты:

  • "disable"
  • "enable"

entries

list / elements=dictionary

Записи списка приложений.

action

string

Пропускать или блокировать трафик либо сбрасывать соединение для трафика этого приложения.

Варианты:

  • "pass"
  • "block"
  • "reset"

application

list / elements=dictionary

Идентификаторы разрешенных приложений.

id

integer / обязательный

Идентификаторы приложений. см. <a href=’#notes’>Примечания</a>.

behavior

list / elements=string

Фильтр по поведению приложения.

category

list / elements=dictionary

Список идентификаторов категорий.

id

integer / обязательный

Идентификатор категории приложения. см. <a href=’#notes’>Примечания</a>.

exclusion

list / elements=dictionary

Идентификаторы исключенных приложений.

id

integer / обязательный

Идентификаторы исключенных приложений. см. <a href=’#notes’>Примечания</a>.

id

integer / обязательный

Идентификатор записи. см. <a href=’#notes’>Примечания</a>.

log

string

Включить или отключить ведение журнала для этого списка приложений.

Варианты:

  • "disable"
  • "enable"

log_packet

string

Включить или отключить ведение журнала пакетов.

Варианты:

  • "disable"
  • "enable"

parameters

list / elements=dictionary

Параметры приложения.

id

integer / обязательный

Идентификатор кортежа параметров. см. <a href=’#notes’>Примечания</a>.

members

list / elements=dictionary

Элементы кортежа параметров.

id

integer / обязательный

Параметр. см. <a href=’#notes’>Примечания</a>.

name

string

Имя параметра.

value

string

Значение параметра.

value

string

Значение параметра.

per_ip_shaper

string

Формирователь трафика для каждого IP-адреса. Источник: firewall.shaper.per-ip-shaper.name.

popularity

list / elements=string

Фильтр по популярности приложения (от 1 до 5, от наименее популярного к наиболее популярному).

Варианты:

  • "1"
  • "2"
  • "3"
  • "4"
  • "5"

protocols

list / elements=string

Фильтр по протоколу приложения.

quarantine

string

Метод помещения в карантин.

Варианты:

  • "none"
  • "attacker"

quarantine_expiry

string

Продолжительность карантина. (Формат

quarantine_log

string

Включить или отключить ведение журнала карантина.

Варианты:

  • "disable"
  • "enable"

rate_count

integer

Количество событий для ограничения частоты.

rate_duration

integer

Длительность (с) периода ограничения частоты.

rate_mode

string

Режим ограничения частоты.

Варианты:

  • "periodical"
  • "continuous"

rate_track

string

Отслеживаемое поле протокола пакета.

Варианты:

  • "none"
  • "src-ip"
  • "dest-ip"
  • "dhcp-client-mac"
  • "dns-domain"

risk

list / elements=dictionary

Риск или последствия разрешения трафика этого приложения (от 1 до 5: низкий, повышенный, средний, высокий и критический).

level

integer / обязательный

Риск или последствия разрешения трафика этого приложения (от 1 до 5: низкий, повышенный, средний, высокий и критический). см. <a href=’#notes’>Примечания</a>.

session_ttl

integer

Время жизни сеанса (0 = значение по умолчанию).

shaper

string

Формирователь трафика. Источник: firewall.shaper.traffic-shaper.name.

shaper_reverse

string

Формирователь обратного трафика. Источник: firewall.shaper.traffic-shaper.name.

sub_category

list / elements=dictionary

Список идентификаторов подкатегорий приложений.

id

integer / обязательный

Идентификатор подкатегории приложения. см. <a href=’#notes’>Примечания</a>.

technology

list / elements=string

Фильтр по технологии приложения.

vendor

list / elements=string

Фильтр по производителю приложения.

extended_log

string

Включить или отключить расширенное ведение журнала.

Варианты:

  • "enable"
  • "disable"

force_inclusion_ssl_di_sigs

string

Включить или отключить принудительное включение сигнатур глубокой проверки SSL.

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

Имя списка.

options

list / elements=string

Базовые сигнатуры протоколов приложений, разрешенные по умолчанию.

Варианты:

  • "allow-dns"
  • "allow-icmp"
  • "allow-http"
  • "allow-ssl"
  • "allow-quic"

other_application_action

string

Действие для других приложений.

Варианты:

  • "pass"
  • "block"

other_application_log

string

Включить или отключить ведение журнала для других приложений.

Варианты:

  • "disable"
  • "enable"

p2p_black_list

list / elements=string

P2P-приложения, которые следует внести в черный список.

Варианты:

  • "skype"
  • "edonkey"
  • "bittorrent"

p2p_block_list

list / elements=string

P2P-приложения, которые нужно внести в список блокировки.

Варианты:

  • "skype"
  • "edonkey"
  • "bittorrent"

replacemsg_group

string

Группа сообщений для замены. Источник: system.replacemsg-group.name.

unknown_application_action

string

Пропускать или блокировать трафик от неизвестных приложений.

Варианты:

  • "pass"
  • "block"

unknown_application_log

string

Включить или отключить ведение журнала для неизвестных приложений.

Варианты:

  • "disable"
  • "enable"

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi больше не поддерживается; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure application control lists.
  fortinet.fortios.fortios_application_list:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      application_list:
          app_replacemsg: "disable"
          comment: "Comments."
          control_default_network_services: "disable"
          deep_app_inspection: "disable"
          default_network_services:
              -
                  id: "8"
                  port: "0"
                  services: "http"
                  violation_action: "pass"
          enforce_default_app_port: "disable"
          entries:
              -
                  action: "pass"
                  application:
                      -
                          id: "16"
                  behavior: "<your_own_value>"
                  category:
                      -
                          id: "19"
                  exclusion:
                      -
                          id: "21"
                  id: "22"
                  log: "disable"
                  log_packet: "disable"
                  parameters:
                      -
                          id: "26"
                          members:
                              -
                                  id: "28"
                                  name: "default_name_29"
                                  value: "<your_own_value>"
                          value: "<your_own_value>"
                  per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
                  popularity: "1"
                  protocols: "<your_own_value>"
                  quarantine: "none"
                  quarantine_expiry: "<your_own_value>"
                  quarantine_log: "disable"
                  rate_count: "0"
                  rate_duration: "60"
                  rate_mode: "periodical"
                  rate_track: "none"
                  risk:
                      -
                          level: "<you_own_value>"
                  session_ttl: "0"
                  shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
                  shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
                  sub_category:
                      -
                          id: "48"
                  technology: "<your_own_value>"
                  vendor: "<your_own_value>"
          extended_log: "enable"
          force_inclusion_ssl_di_sigs: "disable"
          name: "default_name_53"
          options: "allow-dns"
          other_application_action: "pass"
          other_application_log: "disable"
          p2p_black_list: "skype"
          p2p_block_list: "skype"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          unknown_application_action: "pass"
          unknown_application_log: "disable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи данных в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный в последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_application_list_module.html

Spec-Zone.ru

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