fortinet.fortios.fortios_dlp_fp_doc_source 模块 – 通过允许 FortiGate 访问包含用于在 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_fp_doc_source。

fortinet.fortios 2.0.0 中的新增功能

概要 

此模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改 dlp 功能和 fp_doc_source 类别。示例包括所有参数，使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求 

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

ansible>=2.15

参数 

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
dlp_fp_doc_source 字典	通过允许 FortiGate 访问包含用于创建指纹的文件服务器来创建 DLP 指纹数据库。
date 整数	扫描服务器的月份中的日期 (1 - 31)。
file_path 字符串	服务器上指纹文件的路径（最多 119 个字符）。
file_pattern 字符串	服务器上与该模式匹配的文件将被指纹识别。可以选择使用 * 和 ? 通配符。
keep_modified 字符串	启用此功能，以便当服务器上的文件更改时，FortiGate 保留旧指纹并在数据库中添加新的指纹。选项 `"enable"` `"disable"`
name 字符串 / 必需	DLP 指纹数据库的名称。
password 字符串	登录文件服务器所需的密码。
period 字符串	FortiGate 检查服务器是否有新文件或已更改文件的频率。选项 `"none"` `"daily"` `"weekly"` `"monthly"`
remove_deleted 字符串	启用此功能，以便在从服务器删除文件时使指纹数据库保持最新。选项 `"enable"` `"disable"`
scan_on_creation 字符串	启用此功能，以便在服务器上添加或更改文件时使指纹数据库保持最新。选项 `"enable"` `"disable"`
scan_subdirectories 字符串	启用/禁用扫描子目录以查找用于创建指纹的文件。选项 `"enable"` `"disable"`
sensitivity 字符串	为与该指纹数据库匹配的选择敏感性或威胁级别。使用 sensitivity 添加敏感性。来源 dlp .sensitivity.name。
server 字符串	服务器的 IPv4 或 IPv6 地址。
server_type 字符串	用于与文件服务器通信的协议。目前仅支持 Samba (SMB) 服务器。选项 `"samba"`
tod_hour 整数	扫描服务器的一天中的小时数 (0 - 23)。
tod_min 整数	扫描服务器的一小时中的分钟数 (0 - 59)。
username 字符串	登录文件服务器所需的用户名。
vdom 字符串	选择可以与文件服务器通信的 VDOM。选项 `"mgmt"` `"current"`
weekday 字符串	扫描服务器的星期几。选项 `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
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 的首选方式。
此模块支持 check_mode。

示例 

- name: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
  fortinet.fortios.fortios_dlp_fp_doc_source:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_fp_doc_source:
          date: "1"
          file_path: "<your_own_value>"
          file_pattern: "<your_own_value>"
          keep_modified: "enable"
          name: "default_name_7"
          password: "<your_own_value>"
          period: "none"
          remove_deleted: "enable"
          scan_on_creation: "enable"
          scan_subdirectories: "enable"
          sensitivity: "<your_own_value> (source dlp.sensitivity.name)"
          server: "192.168.100.40"
          server_type: "samba"
          tod_hour: "1"
          tod_min: "0"
          username: "<your_own_value>"
          vdom: "mgmt"
          weekday: "sunday"

返回值 

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

键	描述
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)