Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_switch_controller_flow_tracking — настройка отслеживания потоков FortiSwitch и их экспорта через ipfix/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_switch_controller_flow_tracking.

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции switch_controller и категории flow_tracking. В примерах приведены все параметры и значения; перед использованием их необходимо адаптировать к источникам данных. Проверено на 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"

switch_controller_flow_tracking

dictionary

Настройка отслеживания потоков FortiSwitch и их экспорта через ipfix/netflow.

aggregates

list / элементы=dictionary

Настройка агрегатов, в которых все сеансы трафика, соответствующие IP-адресу, будут объединены в один поток.

id

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

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

ip

string

IP-адрес для объединения всех соответствующих сеансов трафика в один поток.

collector_ip

string

Настройка IP-адреса коллектора.

collector_port

integer

Настройка номера порта коллектора (0–65535).

collectors

list / элементы=dictionary

Настройка коллекторов для потока.

ip

string

IP-адрес коллектора.

name

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

Имя коллектора.

port

integer

Номер порта коллектора (0–65535).

transport

string

Транспортный протокол уровня L4 для экспорта пакетов на коллектор.

Варианты:

  • "udp"
  • "tcp"
  • "sctp"

format

string

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

Варианты:

  • "netflow1"
  • "netflow5"
  • "netflow9"
  • "ipfix"

level

string

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

Варианты:

  • "vlan"
  • "ip"
  • "port"
  • "proto"
  • "mac"

max_export_pkt_size

integer

Настройка максимального размера экспортируемого пакета потока (512–9216).

sample_mode

string

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

Варианты:

  • "local"
  • "perimeter"
  • "device-ingress"

sample_rate

integer

Настройка частоты выборки для периметра и входящего трафика устройства (0–99999).

template_export_period

integer

Настройка периода экспорта шаблонов (1–60).

timeout_general

integer

Настройка общего времени ожидания сеанса потока (60–604800).

timeout_icmp

integer

Настройка времени ожидания сеанса потока ICMP (60–604800).

timeout_max

integer

Настройка максимального времени ожидания сеанса потока (60–604800).

timeout_tcp

integer

Настройка времени ожидания сеанса потока TCP (60–604800).

timeout_tcp_fin

integer

Настройка времени ожидания сеанса потока TCP FIN (60–604800).

timeout_tcp_rst

integer

Настройка времени ожидания сеанса потока TCP RST (60–604800).

timeout_udp

integer

Настройка времени ожидания сеанса потока UDP (60–604800).

transport

string

Настройка транспортного протокола уровня L4 для экспорта пакетов.

Варианты:

  • "udp"
  • "tcp"
  • "sctp"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure FortiSwitch flow tracking and export via ipfix/netflow.
  fortinet.fortios.fortios_switch_controller_flow_tracking:
      vdom: "{{ vdom }}"
      switch_controller_flow_tracking:
          aggregates:
              -
                  id: "4"
                  ip: "<your_own_value>"
          collector_ip: "<your_own_value>"
          collector_port: "0"
          collectors:
              -
                  ip: "<your_own_value>"
                  name: "default_name_10"
                  port: "0"
                  transport: "udp"
          format: "netflow1"
          level: "vlan"
          max_export_pkt_size: "512"
          sample_mode: "local"
          sample_rate: "512"
          template_export_period: "5"
          timeout_general: "3600"
          timeout_icmp: "300"
          timeout_max: "604800"
          timeout_tcp: "3600"
          timeout_tcp_fin: "300"
          timeout_tcp_rst: "120"
          timeout_udp: "300"
          transport: "udp"

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

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

Ключ

Описание

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_switch_controller_flow_tracking_module.html

Spec-Zone.ru

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