Модуль fortinet.fortimanager.fmgr_system_npu_backgroundssescan — настройка фонового сканирования SSE драйвером.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
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 / элементы — integer	Список кодов rc, которыми будут переопределены условия сбоя.
rc_succeeded list / элементы — integer	Список кодов rc, которыми будут переопределены условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
system_npu_backgroundssescan dictionary	Набор параметров верхнего уровня.
scan string	Включить/отключить фоновое сканирование SSE потоком драйвера Варианты: `"disable"` `"enable"`
scan_stale псевдонимы: scan-stale integer	Настройка сканирования активных или устаревших сеансов
scan_vt псевдонимы: scan-vt integer	Выбор версии/типа для сканирования
stats_qual_access псевдонимы: stats-qual-access integer	Квалификационный период доступа для обновления статистики, в секундах
stats_qual_duration псевдонимы: stats-qual-duration integer	Квалификационная длительность обновления статистики, в секундах
stats_update_interval псевдонимы: stats-update-interval integer	Интервал обновления статистики
udp_keepalive_interval псевдонимы: udp-keepalive-interval integer	Интервал keepalive для UDP
udp_qual_access псевдонимы: udp-qual-access integer	Квалификационный период доступа для keepalive UDP, в секундах
udp_qual_duration псевдонимы: udp-qual-duration integer	Квалификационная длительность keepalive UDP, в секундах
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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure driver background scan for SSE.
      fortinet.fortimanager.fmgr_system_npu_backgroundssescan:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        system_npu_backgroundssescan:
          # scan: <value in [disable, enable]>
          # stats_update_interval: <integer>
          # udp_keepalive_interval: <integer>
          # scan_stale: <integer>
          # scan_vt: <integer>
          # stats_qual_access: <integer>
          # stats_qual_duration: <integer>
          # udp_qual_access: <integer>
          # udp_qual_duration: <integer>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы — string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы — 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_npu_backgroundssescan_module.html