Модуль fortinet.fortios.fortios_switch_controller_traffic_sniffer — настройка параметров перехвата трафика RSPAN/ERSPAN на FortiSwitch в 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_traffic_sniffer.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций switch_controller и категории traffic_sniffer. Примеры содержат все параметры и значения, которые перед использованием необходимо скорректировать в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
switch_controller_traffic_sniffer dictionary | Настройка параметров перехвата трафика RSPAN/ERSPAN на FortiSwitch. |
|
erspan_ip string |
Настройка IP-адреса сборщика ERSPAN. |
|
mode string |
Настройка режима перехвата трафика. Варианты:
|
|
target_ip list / элементы=dictionary |
IP-адреса для фильтрации перехватываемого трафика. |
|
description string |
Описание IP-адреса для перехвата. |
|
dst_entry_id integer |
ID записи назначения FortiSwitch для IP-адреса перехвата. |
|
ip string / обязательный |
IP-адрес для перехвата. |
|
src_entry_id integer |
ID исходной записи FortiSwitch для IP-адреса перехвата. |
|
target_mac list / элементы=dictionary |
MAC-адреса для фильтрации перехватываемого трафика. |
|
description string |
Описание MAC-адреса для перехвата. |
|
dst_entry_id integer |
ID записи назначения FortiSwitch для MAC-адреса перехвата. |
|
mac string / обязательный |
MAC-адрес для перехвата. |
|
src_entry_id integer |
ID исходной записи FortiSwitch для MAC-адреса перехвата. |
|
target_port list / элементы=dictionary |
Порты для фильтрации перехватываемого трафика. |
|
description string |
Описание записи порта для перехвата. |
|
in_ports list / элементы=dictionary |
Настройка интерфейсов исходных входящих портов. |
|
name string / обязательный |
Имя интерфейса. |
|
out_ports list / элементы=dictionary |
Настройка интерфейсов исходных исходящих портов. |
|
name string / обязательный |
Имя интерфейса. |
|
switch_id string / обязательный |
ID управляемого коммутатора. Источник: switch-controller.managed-switch.switch-id. |
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
fortinet.fortios.fortios_switch_controller_traffic_sniffer:
vdom: "{{ vdom }}"
switch_controller_traffic_sniffer:
erspan_ip: "<your_own_value>"
mode: "erspan-auto"
target_ip:
-
description: "<your_own_value>"
dst_entry_id: "2147483647"
ip: "<your_own_value>"
src_entry_id: "2147483647"
target_mac:
-
description: "<your_own_value>"
dst_entry_id: "2147483647"
mac: "<your_own_value>"
src_entry_id: "2147483647"
target_port:
-
description: "<your_own_value>"
in_ports:
-
name: "default_name_18"
out_ports:
-
name: "default_name_20"
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_traffic_sniffer_module.html
