Модуль fortinet.fortimanager.fmgr_antivirus_profile_mapi — Настройка параметров MAPI AntiVirus.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_antivirus_profile_mapi.

Новая версия в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
antivirus_profile_mapi словарь	Настройка параметров верхнего уровня.
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. Включить службу сканирования AntiVirus. Варианты: `"disable"` `"monitor"` `"block"`
emulator строка	Включить/выключить вирусный эмулятор. Варианты: `"disable"` `"enable"`
executables строка	Обрабатывать исполняемые файлы Windows как вирусы для блокировки или мониторинга. Варианты: `"default"` `"virus"`
external_blocklist строка	Устарело, пожалуйста, переименуйте на external_blocklist. Включить external-blocklist. Варианты: `"disable"` `"monitor"` `"block"`
fortiai строка	Включить/выключить сканирование файлов FortiAI. Варианты: `"disable"` `"monitor"` `"block"`
fortindr строка	Включить сканирование файлов FortiNDR. Варианты: `"disable"` `"block"` `"monitor"`
fortisandbox строка	Включить сканирование файлов FortiSandbox. Варианты: `"disable"` `"block"` `"monitor"`
options список / элементы=строка	Включить/выключить сканирование, мониторинг и карантин MAPI AntiVirus. Варианты: `"scan"` `"quarantine"` `"avquery"` `"avmonitor"`
outbreak_prevention строка	Устарело, пожалуйста, переименуйте на outbreak_prevention. Включить службу FortiGuard Virus Outbreak Prevention. Варианты: `"disabled"` `"files"` `"full-archive"` `"disable"` `"block"` `"monitor"`
quarantine строка	Включить/выключить карантин для зараженных файлов. Варианты: `"disable"` `"enable"`
bypass_validation логическое	Устанавливается в значение True только при различиях между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

enable_log boolean	Включить/отключить протоколирование для задачи. Выбоы: `false` ← (по умолчанию) `true`
forticloud_access_token string	Авторизовать клиент Ansible с помощью маркера доступа к API forticloud.
profile string / обязательный	Параметр (профиль) в запрошенном URL.
proposed_method string	Переопределённый метод для запроса Json RPC. Выбоы: `"update"` `"set"` `"add"`
rc_failed list / элементы=целое	Список кодов rc, при которых условия будут переопределены на неудачу.
rc_succeeded list / элементы=целое	Список кодов rc, при которых условия будут переопределены на успех.
workspace_locking_adom string	ADOM для блокировки при работе с FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure MAPI AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_mapi:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        profile: <your own value>
        antivirus_profile_mapi:
          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]>
          executables: <value in [default, virus]>
          options:
            - scan
            - 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]>

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_antivirus_profile_mapi_module.html