fortinet.fortios.fortios_antivirus_quarantine 模块 – 配置 Fortinet FortiOS 和 FortiGate 中的隔离选项。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_antivirus_quarantine。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改防病毒功能和隔离类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，并且值需要在使用前调整为数据源。使用 FOS v6.0.0 测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

antivirus_quarantine

字典

配置隔离选项。

agelimit

整数

隔离文件的年龄限制（0 - 479 小时，0 表示永久）。

destination

字符串

选择是将文件隔离到 FortiGate 磁盘还是 FortiAnalyzer，或者删除它们而不是隔离它们。

选择

  • "NULL"

  • "disk"

  • "FortiAnalyzer"

drop_blocked

列表 / 元素=字符串

不要隔离在使用选定协议的会话中发现的已丢弃的文件。丢弃的文件将被删除，而不是被隔离。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

drop_heuristic

列表 / 元素=字符串

不要隔离在使用选定协议的会话中通过启发式方法检测到的文件。丢弃的文件将被删除，而不是被隔离。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

drop_infected

列表 / 元素=字符串

不要隔离在使用选定协议的会话中发现的受感染文件。丢弃的文件将被删除，而不是被隔离。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

drop_intercepted

列表 / 元素=字符串

从协议中丢弃截获的文件

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

drop_machine_learning

列表 / 元素=字符串

不要隔离在使用选定协议的会话中通过机器学习检测到的文件。丢弃的文件将被删除，而不是被隔离。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

lowspace

字符串

当磁盘空间不足时，选择处理其他文件的方法。

选择

  • "drop-new"

  • "ovrw-old"

maxfilesize

整数

要隔离的最大文件大小（0 - 500 兆字节，0 表示无限制）。

quarantine_quota

整数

为隔离文件保留的磁盘空间量（0 - 4294967295 兆字节，0 表示无限制，并取决于磁盘空间）。

store_blocked

列表 / 元素=字符串

隔离在使用选定协议的会话中发现的已阻止文件。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

store_heuristic

列表 / 元素=字符串

隔离在使用选定协议的会话中通过启发式方法检测到的文件。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

store_infected

列表 / 元素=字符串

隔离在使用选定协议的会话中发现的受感染文件。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

store_intercepted

列表 / 元素=字符串

从协议中隔离截获的文件

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

store_machine_learning

列表 / 元素=字符串

隔离在使用选定协议的会话中通过机器学习检测到的文件。

选择

  • "imap"

  • "smtp"

  • "pop3"

  • "http"

  • "ftp"

  • "nntp"

  • "imaps"

  • "smtps"

  • "pop3s"

  • "https"

  • "ftps"

  • "mapi"

  • "cifs"

  • "ssh"

enable_log

布尔值

启用/禁用任务的日志记录。

选择

  • false ←（默认）

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性，则以斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选择

  • "present"

  • "absent"

vdom

字符串

虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Configure quarantine options.
  fortinet.fortios.fortios_antivirus_quarantine:
      vdom: "{{ vdom }}"
      antivirus_quarantine:
          agelimit: "0"
          destination: "NULL"
          drop_blocked: "imap"
          drop_heuristic: "imap"
          drop_infected: "imap"
          drop_intercepted: "imap"
          drop_machine_learning: "imap"
          lowspace: "drop-new"
          maxfilesize: "0"
          quarantine_quota: "0"
          store_blocked: "imap"
          store_heuristic: "imap"
          store_infected: "imap"
          store_intercepted: "imap"
          store_machine_learning: "imap"

返回值

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

键

描述

build

字符串

fortigate 映像的内部版本号

返回：始终

示例： "1547"

http_method

字符串

用于将内容配置到 FortiGate 中的最后一个方法

返回：始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后一个结果

返回：始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥 (id)

返回：成功

示例： "id"

name

字符串

用于满足请求的表名

返回：始终

示例： "urlfilter"

path

字符串

用于满足请求的表路径

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

指示操作结果

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

version

字符串

FortiGate 的版本

返回：始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)