Модуль fortinet.fortios.fortios_firewall_on_demand_sniffer — настройка пакетного анализатора по запросу в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

Добавлено в fortinet.fortios 2.0.0

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

Обзор

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_on_demand_sniffer dictionary	Настройка пакетного анализатора по запросу.
advanced_filter string	Расширенный фильтр произвольного формата, который при задании применяется поверх существующих настроек фильтра. Доступен только супер-администратору.
hosts list / elements=dictionary	Узлы IPv4 или IPv6 для фильтрации в этом анализаторе трафика.
host string / обязательный	Узел IPv4 или IPv6.
interface string	Имя интерфейса, на котором будет выполняться пакетный анализатор по запросу. Источник: system.interface.name.
max_packet_count integer	Максимальное количество пакетов для захвата одним пакетным анализатором по запросу.
name string / обязательный	Имя пакетного анализатора по запросу.
non_ip_packet string	Включать пакеты, не относящиеся к IP. Варианты: `"enable"` `"disable"`
ports list / elements=dictionary	Порты для фильтрации в этом анализаторе трафика.
port integer / обязательный	Порт для фильтрации в этом анализаторе трафика. См. <a href=’#notes’>Примечания</a>.
protocols list / elements=dictionary	Протоколы для фильтрации в этом анализаторе трафика.
protocol integer / обязательный	Целочисленное значение типа протокола согласно определению IANA (0–255). См. <a href=’#notes’>Примечания</a>.
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 on-demand packet sniffer.
  fortinet.fortios.fortios_firewall_on_demand_sniffer:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_on_demand_sniffer:
          advanced_filter: "<your_own_value>"
          hosts:
              -
                  host: "myhostname"
          interface: "<your_own_value> (source system.interface.name)"
          max_packet_count: "0"
          name: "default_name_8"
          non_ip_packet: "enable"
          ports:
              -
                  port: "<you_own_value>"
          protocols:
              -
                  protocol: "<you_own_value>"

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

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

Ключ	Описание
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_firewall_on_demand_sniffer_module.html