fortinet.fortios.fortios_dlp_sensor 模块 – 配置 Fortinet FortiOS 和 FortiGate 中 DLP 阻止功能使用的传感器。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_dlp_sensor。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

dlp_sensor

字典

配置 DLP 阻止功能使用的传感器。

comment

字符串

可选注释。

dlp_log

字符串

启用/禁用 DLP 日志记录。

选项

  • "enable"

  • "disable"

entries

列表 / 元素=字典

DLP 传感器条目。

count

整数

触发传感器条目匹配的字典匹配计数（基于其“重复”选项，字典可能无法触发多次，1 - 255）。

字典

字符串

选择 DLP 字典或精确数据匹配。来源 dlp.dictionary.name dlp.exact-data-match.name。

id

整数 / 必需

ID。参见 备注。

status

字符串

启用/禁用此条目。

选项

  • "enable"

  • "disable"

eval

字符串

要评估的表达式。

extended_log

字符串

启用/禁用数据泄露防护的扩展日志记录。

选项

  • "enable"

  • "disable"

feature_set

字符串

流/代理功能集。

选项

  • "flow"

  • "proxy"

filter

列表 / 元素=字典

为此传感器设置 DLP 过滤器。

action

字符串

对与此 DLP 传感器匹配的内容采取的操作。

选项

  • "allow"

  • "log-only"

  • "block"

  • "quarantine-ip"

archive

字符串

启用/禁用 DLP 归档。

选项

  • "disable"

  • "enable"

company_identifier

字符串

输入要匹配的公司标识符水印。仅匹配贵公司已放置在文件上的水印。

expiry

字符串

隔离持续时间（以天、小时、分钟为单位）（格式 = dddhhmm）。

file_size

整数

匹配此大小或更大的文件 (0 - 4294967295 KB)。

file_type

整数

选择要匹配的 DLP 文件模式表的编号。来源 dlp.filepattern.id。

filter_by

字符串

选择要匹配的内容类型。

选项

  • "credit-card"

  • "ssn"

  • "regexp"

  • "file-type"

  • "file-size"

  • "fingerprint"

  • "watermark"

  • "encrypted"

fp_sensitivity

列表 / 元素=字典

选择要匹配的 DLP 文件模式灵敏度。

name

字符串 / 必需

选择 DLP 灵敏度。来源 dlp.fp-sensitivity.name。

id

整数 / 必需

ID。参见 备注。

match_percentage

整数

与所选灵敏度指定的指纹数据库中的指纹百分比相匹配。

name

字符串

过滤器名称。

proto

列表 / 元素=字符串

检查一个或多个这些协议的消息或文件。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

regexp

字符串

输入要匹配的正则表达式（最大 255 个字符）。

sensitivity

列表 / 元素=字典

选择要匹配的 DLP 文件模式灵敏度。

name

字符串 / 必需

选择 DLP 灵敏度。来源 dlp.sensitivity.name。

severity

字符串

选择与该过滤器匹配的严重性或威胁级别。

选项

  • "info"

  • "low"

  • "medium"

  • "high"

  • "critical"

type

字符串

选择是检查消息（电子邮件消息）的内容还是文件（下载的文件或电子邮件附件）的内容。

选项

  • "file"

  • "fos_message"

flow_based

字符串

启用/禁用基于流的 DLP。

选项

  • "enable"

  • "disable"

full_archive_proto

列表 / 元素=字符串

始终内容归档的协议。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

match_type

字符串

条目之间的逻辑关系。

选项

  • "match-all"

  • "match-any"

  • "match-eval"

nac_quar_log

字符串

启用/禁用 NAC 隔离日志记录。

选项

  • "enable"

  • "disable"

name

字符串 / 必需

包含传感器的表的名称。

options

字符串

配置 DLP 选项。

replacemsg_group

字符串

此 DLP 传感器使用的替换消息组。来源 system.replacemsg-group.name。

summary_proto

列表 / 元素=字符串

始终记录摘要的协议。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。

  • 此模块支持 check_mode。

示例

- name: Configure sensors used by DLP blocking.
  fortinet.fortios.fortios_dlp_sensor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_sensor:
          comment: "Optional comments."
          dlp_log: "enable"
          entries:
              -
                  count: "1"
                  dictionary: "<your_own_value> (source dlp.dictionary.name dlp.exact-data-match.name)"
                  id: "8"
                  status: "enable"
          eval: "<your_own_value>"
          extended_log: "enable"
          feature_set: "flow"
          filter:
              -
                  action: "allow"
                  archive: "disable"
                  company_identifier: "myId_16"
                  expiry: "<your_own_value>"
                  file_size: "10"
                  file_type: "0"
                  filter_by: "credit-card"
                  fp_sensitivity:
                      -
                          name: "default_name_22 (source dlp.fp-sensitivity.name)"
                  id: "23"
                  match_percentage: "10"
                  name: "default_name_25"
                  proto: "smtp"
                  regexp: "<your_own_value>"
                  sensitivity:
                      -
                          name: "default_name_29 (source dlp.sensitivity.name)"
                  severity: "info"
                  type: "file"
          flow_based: "enable"
          full_archive_proto: "smtp"
          match_type: "match-all"
          nac_quar_log: "enable"
          name: "default_name_36"
          options: "<your_own_value>"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          summary_proto: "smtp"

返回值

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

键

描述

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"

作者

  • 郑琳 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)