модуль fortinet.fortimanager.fmgr_antivirus_profile_pop3 — настройка параметров антивируса POP3.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрашиваемом URL.
antivirus_profile_pop3 словарь	Набор параметров верхнего уровня.
archive_block псевдонимы: archive-block список / элементы=строка	Выберите типы архивов, которые нужно блокировать. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
archive_log псевдонимы: archive-log список / элементы=строка	Выберите типы архивов, которые нужно регистрировать в журнале. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
av_scan псевдонимы: av-scan строка	Включить службу антивирусного сканирования. Варианты: `"disable"` `"monitor"` `"block"`
content_disarm псевдонимы: content-disarm строка	Включить очистку и восстановление содержимого для этого протокола. Варианты: `"disable"` `"enable"`
emulator строка	Включить/отключить эмулятор вирусов. Варианты: `"disable"` `"enable"`
executables строка	Рассматривать исполняемые файлы Windows как вирусы для их блокировки или мониторинга. Варианты: `"default"` `"virus"`
external_blocklist псевдонимы: external-blocklist строка	Включить внешний список блокировки. Варианты: `"disable"` `"monitor"` `"block"`
fortiai строка	Включить/отключить сканирование файлов с помощью FortiAI. Варианты: `"disable"` `"monitor"` `"block"`
fortindr строка	Включить сканирование файлов с помощью FortiNDR. Варианты: `"disable"` `"block"` `"monitor"`
fortisandbox строка	Включить сканирование файлов с помощью FortiSandbox. Варианты: `"disable"` `"block"` `"monitor"`
malware_stream псевдонимы: malware-stream строка	Включить потоковое сканирование на вредоносное ПО нулевого дня. Варианты: `"disable"` `"monitor"` `"block"`
options список / элементы=строка	Включить/отключить антивирусное сканирование POP3, мониторинг и помещение в карантин. Варианты: `"scan"` `"file-filter"` `"quarantine"` `"avquery"` `"avmonitor"`
outbreak_prevention псевдонимы: outbreak-prevention строка	Включить службу FortiGuard для предотвращения вспышек вирусов. Варианты: `"disabled"` `"files"` `"full-archive"` `"disable"` `"block"` `"monitor"`
quarantine строка	Включить/отключить помещение заражённых файлов в карантин. Варианты: `"disable"` `"enable"`
bypass_validation логическое значение	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile строка / обязательный	Параметр (profile) в запрашиваемом URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, которыми будут переопределены условия сбоя.
rc_succeeded список / элементы=целое число	Список кодов rc, которыми будут переопределены условия успешного выполнения.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom строка	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global и другие ADOM, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `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 POP3 AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_pop3:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        antivirus_profile_pop3:
          # archive_block: ["encrypted", "corrupted", "multipart", "nested", "mailbomb",
          #                 "unhandled", "partiallycorrupted", "fileslimit", "timeout"]
          # archive_log: ["encrypted", "corrupted", "multipart", "nested", "mailbomb",
          #               "unhandled", "partiallycorrupted", "fileslimit", "timeout"]
          # content_disarm: <value in [disable, enable]>
          # emulator: <value in [disable, enable]>
          # executables: <value in [default, virus]>
          # options: ["scan", "file-filter", "quarantine", "avquery", "avmonitor"]
          # 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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Сведения о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_pop3_module.html