fortinet.fortimanager.fmgr_antivirus_profile_smtp 模块 – 配置 SMTP 防病毒选项。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager

要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_antivirus_profile_smtp

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

antivirus_profile_smtp

字典

设置的顶级参数。

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"

options

列表 / 元素=字符串

启用/禁用 SMTP 防病毒扫描、监控和隔离。

选择

  • "scan"

  • "file-filter"

  • "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 SMTP AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_smtp:
        # 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_smtp:
          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

字典

请求的结果。

返回值: 总是

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 版本支持,则发出警告。

返回值: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)