Модуль fortinet.fortimanager.fmgr_system_sniffer — Сниффер интерфейса.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_sniffer.

Добавлено в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, которыми будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, которыми будут переопределены условия успешного выполнения.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_sniffer dictionary	Параметры верхнего уровня.
host string	Узлы для фильтрации трафика сниффера
id integer / обязательный	Идентификатор сниффера.
interface string	Интерфейс.
ipv6 string	Включить или отключить перехват пакетов IPv6. disable — отключить сниффер для пакетов IPv6. enable — включить сниффер для пакетов IPv6. Варианты: `"disable"` `"enable"`
max_packet_count псевдонимы: max-packet-count integer	Максимальное количество пакетов
non_ip псевдонимы: non-ip string	Включить или отключить перехват пакетов, не являющихся IP-пакетами. disable — отключить сниффер для пакетов, не являющихся IP-пакетами. enable — включить сниффер для пакетов, не являющихся IP-пакетами. Варианты: `"disable"` `"enable"`
port string	Порты для перехвата
protocol string	Целочисленное значение типа протокола согласно определению IANA
vlan string	Список VLAN для перехвата.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие варианты, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиваниями (snake_case). Замените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но для них будут выдаваться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Interface sniffer.
      fortinet.fortimanager.fmgr_system_sniffer:
        # workspace_locking_adom: <global or your adom name>
        state: present # <value in [present, absent]>
        system_sniffer:
          id: 0 # Required variable, integer
          # host: <string>
          # interface: <string>
          # ipv6: <value in [disable, enable]>
          # max_packet_count: <integer>
          # non_ip: <value in [disable, enable]>
          # port: <string>
          # protocol: <string>
          # vlan: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_system_sniffer_module.html