fortinet.fortimanager.fmgr_antivirus_profile_mapi 模块 – 配置 MAPI 反病毒选项。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_antivirus_profile_mapi。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
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 字符串	启用反病毒扫描服务。 选项 "disable" "monitor" "block"
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"
options 列表 / 元素=字符串	启用/禁用 MAPI 反病毒扫描、监控和隔离。 选项 "scan" "quarantine" "avquery" "avmonitor"
outbreak_prevention 别名：outbreak-prevention 字符串	启用 FortiGuard 病毒爆发防护服务。 选项 "disabled" "files" "full-archive" "disable" "block" "monitor"
quarantine 字符串	启用/禁用对受感染文件的隔离。 选项 "disable" "enable"
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
profile 字符串 / 必需	请求 URL 中的参数 (profile)。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 adom，值可以是 global 和其他值，包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁的最大时间（秒）。 默认： 300

备注

注意

• 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

• 此 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 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑凌 (@chillancezen)

• 沈峰 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 代码库 (源代码)