fortinet.fortios.fortios_dlp_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 DLP 配置文件。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

需求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

dlp_profile

字典

配置 DLP 配置文件。

comment

字符串

注释。

dlp_log

字符串

启用/禁用 DLP 日志记录。

选项

  • "enable"

  • "disable"

extended_log

字符串

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

选项

  • "enable"

  • "disable"

feature_set

字符串

流/代理功能集。

选项

  • "flow"

  • "proxy"

full_archive_proto

列表 / 元素=字符串

始终内容归档的协议。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

nac_quar_log

字符串

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

选项

  • "enable"

  • "disable"

name

字符串 / 必需

DLP 配置文件的名称。

replacemsg_group

字符串

此 DLP 配置文件使用的替换消息组。源系统.replacemsg-group.name。

rule

列表 / 元素=字典

为此配置文件设置 DLP 规则。

action

字符串

对与该 DLP 配置文件匹配的内容采取的操作。

选项

  • "allow"

  • "log-only"

  • "block"

  • "quarantine-ip"

archive

字符串

启用/禁用 DLP 归档。

选项

  • "disable"

  • "enable"

expiry

字符串

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

file_size

整数

匹配大于或等于此大小（KB）的文件。

file_type

整数

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

filter_by

字符串

选择要匹配的内容类型。

选项

  • "sensor"

  • "mip"

  • "fingerprint"

  • "encrypted"

  • "none"

id

整数 / 必需

ID。参见 注释。

label

字符串

MIP 标签字典。源 dlp.dictionary.name。

match_percentage

整数

使用选定的灵敏度匹配指纹数据库中指纹的百分比。

name

字符串

过滤器名称。

proto

列表 / 元素=字符串

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

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

sensitivity

列表 / 元素=字典

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

name

字符串 / 必需

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

sensor

列表 / 元素=字典

选择 DLP 传感器。

name

字符串 / 必需

地址名称。源 dlp.sensor.name。

severity

字符串

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

选项

  • "info"

  • "low"

  • "medium"

  • "high"

  • "critical"

type

字符串

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

选项

  • "file"

  • "fos_message"

summary_proto

列表 / 元素=字符串

始终记录摘要的协议。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-get"

  • "http-post"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注释

注意

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

示例

- name: Configure DLP profiles.
  fortinet.fortios.fortios_dlp_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_profile:
          comment: "Comment."
          dlp_log: "enable"
          extended_log: "enable"
          feature_set: "flow"
          full_archive_proto: "smtp"
          nac_quar_log: "enable"
          name: "default_name_9"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          rule:
              -
                  action: "allow"
                  archive: "disable"
                  expiry: "<your_own_value>"
                  file_size: "0"
                  file_type: "0"
                  filter_by: "sensor"
                  id: "18"
                  label: "<your_own_value> (source dlp.dictionary.name)"
                  match_percentage: "10"
                  name: "default_name_21"
                  proto: "smtp"
                  sensitivity:
                      -
                          name: "default_name_24 (source dlp.sensitivity.name)"
                  sensor:
                      -
                          name: "default_name_26 (source dlp.sensor.name)"
                  severity: "info"
                  type: "file"
          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)