Модуль fortinet.fortios.fortios_system_netflow — настройка NetFlow в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация с помощью токена. Токен создаётся в графическом интерфейсе Fortigate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Допустимые значения: `"present"` `"absent"`
system_netflow dictionary	Настройка NetFlow.
active_flow_timeout integer	Интервал между отправкой сведений об активных потоках (60–3600 с).
collector_ip string	IP-адрес коллектора.
collector_port integer	Номер порта коллектора NetFlow.
collectors list / elements=dictionary	Коллекторы NetFlow.
collector_ip string	IP-адрес коллектора.
collector_port integer	Номер порта коллектора NetFlow.
id integer / обязательный	Идентификатор. См. <a href=’#notes’>Примечания</a>.
interface string	Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name.
interface_select_method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Допустимые значения: `"auto"` `"sdwan"` `"specify"`
source_ip string	Исходный IP-адрес для связи с агентом NetFlow.
source_ip_interface string	Имя интерфейса, используемого для определения исходного IP-адреса при экспорте пакетов. Источник: system.interface.name.
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
exclusion_filters list / elements=dictionary	Фильтры исключения
destination_ip string	Адрес назначения сеанса.
destination_port string	Номер порта назначения сеанса или диапазон портов.
id integer / обязательный	Идентификатор фильтра. См. <a href=’#notes’>Примечания</a>.
protocol integer	IP-протокол сеанса (0–255).
source_ip string	Адрес источника сеанса.
source_port string	Номер порта источника сеанса или диапазон портов.
inactive_flow_timeout integer	Интервал периодической отправки сведений о завершённых потоках (10–600 с).
interface string	Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name.
interface_select_method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Допустимые значения: `"auto"` `"sdwan"` `"specify"`
session_cache_size string	Максимальный объём оперативной памяти, выделяемый для кэша сеансов NetFlow. Допустимые значения: `"min"` `"default"` `"max"`
source_ip string	Исходный IP-адрес для связи с агентом NetFlow.
template_tx_counter integer	Счётчик записей flowset перед повторной отправкой записи шаблона flowset.
template_tx_timeout integer	Интервал периодической передачи шаблона flowset (60–86400 с).
vdom string	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure NetFlow.
  fortinet.fortios.fortios_system_netflow:
      vdom: "{{ vdom }}"
      system_netflow:
          active_flow_timeout: "1800"
          collector_ip: "<your_own_value>"
          collector_port: "2055"
          collectors:
              -
                  collector_ip: "<your_own_value>"
                  collector_port: "2055"
                  id: "9"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  source_ip: "84.230.14.43"
                  source_ip_interface: "<your_own_value> (source system.interface.name)"
                  vrf_select: "0"
          exclusion_filters:
              -
                  destination_ip: "<your_own_value>"
                  destination_port: "<your_own_value>"
                  id: "18"
                  protocol: "255"
                  source_ip: "84.230.14.43"
                  source_port: "<your_own_value>"
          inactive_flow_timeout: "15"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          session_cache_size: "min"
          source_ip: "84.230.14.43"
          template_tx_counter: "20"
          template_tx_timeout: "1800"

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

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

Ключ	Описание
build string	Номер сборки образа Fortigate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Результат последней операции, возвращённый FortiGate Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (id), использованный при последнем вызове 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_system_netflow_module.html