fortinet.fortimanager.fmgr_antivirus_profile_imap 模块 – 配置IMAP反病毒选项。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问FortiManager的令牌。
adom 字符串 / 必需	请求URL中的参数 (adom)。
antivirus_profile_imap 字典	设置的顶级参数。
archive_block 别名：archive-block 列表 / 元素=字符串	选择要阻止的存档类型。 选项 "加密" "损坏" "多部分" "嵌套" "邮件炸弹" "未处理" "部分损坏" "文件限制" "超时"
archive_log 别名：archive-log 列表 / 元素=字符串	选择要记录的存档类型。 选项 "加密" "损坏" "多部分" "嵌套" "邮件炸弹" "未处理" "部分损坏" "文件限制" "超时"
av_scan 别名：av-scan 字符串	启用反病毒扫描服务。 选项 "禁用" "监控" "阻止"
content_disarm 别名：content-disarm 字符串	为此协议启用内容清除和重建。 选项 "禁用" "启用"
emulator 字符串	启用/禁用病毒模拟器。 选项 "禁用" "启用"
executables 字符串	将Windows可执行文件视为病毒，以进行阻止或监控。 选项 "默认" "病毒"
external_blocklist 别名：external-blocklist 字符串	启用外部黑名单。 选项 "禁用" "监控" "阻止"
fortiai 字符串	启用/禁用FortiAI对文件的扫描。 选项 "禁用" "监控" "阻止"
fortindr 字符串	启用FortiNDR对文件的扫描。 选项 "禁用" "阻止" "监控"
fortisandbox 字符串	启用FortiSandbox对文件的扫描。 选项 "禁用" "阻止" "监控"
options 列表 / 元素=字符串	启用/禁用IMAP反病毒扫描、监控和隔离。 选项 "扫描" "文件过滤器" "隔离" "avquery" "avmonitor"
outbreak_prevention 别名：outbreak-prevention 字符串	启用FortiGuard病毒爆发防护服务。 选项 "禁用" "文件" "完整存档" "禁用" "阻止" "监控"
quarantine 字符串	启用/禁用对感染文件的隔离。 选项 "禁用" "启用"
bypass_validation 布尔值	仅当模块模式与FortiManager API结构不同时才设置为True，模块将继续执行而不验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用FortiCloud API访问令牌验证Ansible客户端。
profile 字符串 / 必需	请求URL中的参数 (profile)。
proposed_method 字符串	底层Json RPC请求的覆盖方法。 选项 "更新" "设置" "添加"
rc_failed 列表 / 元素=整数	将被覆盖的失败条件的rc代码列表。
rc_succeeded 列表 / 元素=整数	将被覆盖的成功条件的rc代码列表。
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的adom，该值可以是全局的和其他值，包括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 IMAP AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_imap:
        # 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_imap:
          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]>

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
元数据 (meta) 字典	请求的结果。 返回值：始终
请求URL (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版本支持，则会发出警告。 返回值：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑林 (@chillancezen)

• 沈峰 (@fshen01)

• 卢洪滨 (@fgtdev-hblu)

相关链接

• 问题追踪器
• 主页
• 代码仓库