fortinet.fortimanager.fmgr_antivirus_profile_ssh module – Настройка параметров антивируса для SFTP и SCP.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
antivirus_profile_ssh dictionary	Параметры верхнего уровня.
archive_block псевдонимы: archive-block list / элементы=string	Выберите типы архивов, которые нужно блокировать. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
archive_log псевдонимы: archive-log list / элементы=string	Выберите типы архивов, которые нужно регистрировать в журнале. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
av_scan псевдонимы: av-scan string	Включить службу антивирусного сканирования. Варианты: `"disable"` `"monitor"` `"block"`
emulator string	Включить или отключить эмулятор вирусов. Варианты: `"disable"` `"enable"`
external_blocklist псевдонимы: external-blocklist string	Включить внешний список блокировки. Варианты: `"disable"` `"monitor"` `"block"`
fortiai string	Включить или отключить сканирование файлов с помощью FortiAI. Варианты: `"disable"` `"monitor"` `"block"`
fortindr string	Включить сканирование файлов с помощью FortiNDR. Варианты: `"disable"` `"block"` `"monitor"`
fortisandbox string	Включить сканирование файлов с помощью FortiSandbox. Варианты: `"disable"` `"block"` `"monitor"`
malware_stream псевдонимы: malware-stream string	Включить потоковое сканирование на наличие вредоносных программ нулевого дня. Варианты: `"disable"` `"monitor"` `"block"`
options list / элементы=string	Включить или отключить антивирусное сканирование, мониторинг и карантин для SFTP и SCP. Варианты: `"avmonitor"` `"quarantine"` `"scan"`
outbreak_prevention псевдонимы: outbreak-prevention string	Включить службу предотвращения вирусных вспышек. Варианты: `"disabled"` `"files"` `"full-archive"` `"disable"` `"block"` `"monitor"`
quarantine string	Включить или отключить карантин для зараженных файлов. Варианты: `"disable"` `"enable"`
bypass_validation boolean	Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile string / обязательный	Параметр (profile) в запрошенном URL.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого можно переопределить условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого можно переопределить условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
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 SFTP and SCP AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_ssh:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        antivirus_profile_ssh:
          # archive_block: ["encrypted", "corrupted", "multipart", "nested", "mailbomb",
          #                 "unhandled", "partiallycorrupted", "fileslimit", "timeout"]
          # archive_log: ["encrypted", "corrupted", "multipart", "nested", "mailbomb",
          #               "unhandled", "partiallycorrupted", "fileslimit", "timeout"]
          # emulator: <value in [disable, enable]>
          # options: ["avmonitor", "quarantine", "scan"]
          # outbreak_prevention: <value in [disabled, files, full-archive, ...]>
          # av_scan: <value in [disable, monitor, block]>
          # external_blocklist: <value in [disable, monitor, block]>
          # quarantine: <value in [disable, enable]>
          # fortindr: <value in [disable, block, monitor]>
          # fortisandbox: <value in [disable, block, monitor]>
          # fortiai: <value in [disable, monitor, block]>
          # malware_stream: <value in [disable, monitor, block]>

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

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

Ключ	Описание
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_antivirus_profile_ssh_module.html