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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
antivirus_profile_ssh dictionary	Набор параметров верхнего уровня.
archive-block list / elements=string	Устарело, переименуйте в archive_block. Выберите типы архивов для блокировки. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
archive-log list / elements=string	Устарело, переименуйте в archive_log. Выберите типы архивов для логирования. Варианты: `"encrypted"` `"corrupted"` `"multipart"` `"nested"` `"mailbomb"` `"unhandled"` `"partiallycorrupted"` `"fileslimit"` `"timeout"`
av-scan string	Устарело, переименуйте в av_scan. Включить службу антивирусного сканирования. Варианты: `"disable"` `"monitor"` `"block"`
emulator string	Включить/выключить эмулятор вирусов. Варианты: `"disable"` `"enable"`
external-blocklist string	Устарело, переименуйте в external_blocklist. Включить внешний черный список. Варианты: `"disable"` `"monitor"` `"block"`
fortiai string	Включить/выключить сканирование файлов с помощью FortiAI. Варианты: `"disable"` `"monitor"` `"block"`
fortindr string	Включить сканирование файлов с помощью FortiNDR. Варианты: `"disable"` `"block"` `"monitor"`
fortisandbox string	Включить сканирование файлов с помощью FortiSandbox. Варианты: `"disable"` `"block"` `"monitor"`
options list / elements=string	Включить/выключить антивирусное сканирование, мониторинг и карантин SFTP и SCP. Варианты: `"avmonitor"` `"quarantine"` `"scan"`
outbreak-prevention string	Устарело, переименуйте в outbreak_prevention. Включить службу предотвращения вирусных вспышек. Варианты: `"disabled"` `"files"` `"full-archive"` `"disable"` `"block"` `"monitor"`
quarantine string	Включить/выключить карантин для зараженных файлов. Варианты: `"disable"` `"enable"`
bypass_validation boolean	Устанавливать в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбор: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успеха.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure SFTP and SCP AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_ssh:
        # 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_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]>

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

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

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