fortinet.fortimanager.fmgr_dlp_sensor 模块 – 配置 DLP 传感器。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_dlp_sensor。

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求的 url 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选项 `false` ← (默认) `true`
dlp_sensor 字典	顶层参数集。
comment 字符串	注释。
dlp_log 别名: dlp-log 字符串	启用/禁用 DLP 日志记录。选项 `"disable"` `"enable"`
entries 列表 / 元素=字典	条目。
count 整数	触发传感器条目匹配的字典匹配计数
字典字符串	选择一个 DLP 字典。
id 整数	ID。
status 字符串	启用/禁用此条目。选项 `"disable"` `"enable"`
eval 字符串	要评估的表达式。
extended_log 别名: extended-log 字符串	启用/禁用数据泄漏防护的扩展日志记录。选项 `"disable"` `"enable"`
feature_set 别名: feature-set 字符串	流/代理功能集。选项 `"proxy"` `"flow"`
fgd_id 别名: fgd-id 整数	FortiGuard 数据库中对象的 ID。
filter 列表 / 元素=字典	过滤器。
action 字符串	对此 DLP 传感器匹配的内容执行的操作。选项 `"log-only"` `"block"` `"exempt"` `"ban"` `"ban-sender"` `"quarantine-ip"` `"quarantine-port"` `"none"` `"allow"`
archive 字符串	启用/禁用 DLP 存档。选项 `"disable"` `"enable"` `"summary-only"`
company_identifier 别名: company-identifier 字符串	输入要匹配的公司标识水印。
expiry 字符串	隔离时长，格式为天、小时、分钟
file_size 别名: file-size 整数	匹配此大小或更大的文件
file_type 别名: file-type 字符串	选择要匹配的 DLP 文件模式表的编号。
filter_by 别名: filter-by 字符串	选择要匹配的内容类型。选项 `"credit-card"` `"ssn"` `"regexp"` `"file-type"` `"file-size"` `"fingerprint"` `"watermark"` `"encrypted"` `"file-type-and-size"`
fp_sensitivity 别名: fp-sensitivity 任何	(列表或字符串) 选择要匹配的 DLP 文件模式灵敏度。
id 整数	ID。
match_percentage 别名: match-percentage 整数	指纹数据库中以选定的 fp-sensitivity 指定的要匹配的指纹百分比。
name 字符串	过滤器名称。
proto 列表 / 元素=字符串	通过一个或多个这些协议检查消息或文件。选项 `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
regexp 字符串	输入要匹配的正则表达式
sensitivity 任何	(列表或字符串) 选择要匹配的 DLP 文件模式灵敏度。
severity 字符串	选择与此过滤器匹配的严重性或威胁级别。选项 `"info"` `"low"` `"medium"` `"high"` `"critical"`
type 字符串	选择是否检查消息内容选项 `"file"` `"message"`
flow_based 别名: flow-based 字符串	启用/禁用基于流的 DLP。选项 `"disable"` `"enable"`
full_archive_proto 别名: full-archive-proto 列表 / 元素=字符串	始终进行内容存档的协议。选项 `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
match_type 别名: match-type 字符串	条目之间的逻辑关系选项 `"match-all"` `"match-any"` `"match-eval"`
nac_quar_log 别名: nac-quar-log 字符串	启用/禁用 NAC 隔离日志记录。选项 `"disable"` `"enable"`
name 字符串 / 必需	DLP 传感器的名称。
options 字符串	配置 DLP 选项。选项 `"strict-file"`
replacemsg_group 别名: replacemsg-group 字符串	此 DLP 传感器使用的替换消息组。
summary_proto 别名: summary-proto 列表 / 元素=字符串	始终记录摘要的协议。选项 `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
enable_log 布尔值	启用/禁用任务的日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	用于创建、更新或删除对象的指令。选项 `"present"` `"absent"`
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 帮助完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 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 DLP sensors.
      fortinet.fortimanager.fmgr_dlp_sensor:
        # 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>
        state: present # <value in [present, absent]>
        dlp_sensor:
          comment: <string>
          dlp_log: <value in [disable, enable]>
          extended_log: <value in [disable, enable]>
          filter:
            -
              action: <value in [log-only, block, exempt, ...]>
              archive: <value in [disable, enable, summary-only]>
              company_identifier: <string>
              expiry: <string>
              file_size: <integer>
              file_type: <string>
              filter_by: <value in [credit-card, ssn, regexp, ...]>
              fp_sensitivity: <list or string>
              id: <integer>
              match_percentage: <integer>
              name: <string>
              proto:
                - "imap"
                - "smtp"
                - "pop3"
                - "ftp"
                - "nntp"
                - "mm1"
                - "mm3"
                - "mm4"
                - "mm7"
                - "mapi"
                - "aim"
                - "icq"
                - "msn"
                - "yahoo"
                - "http-get"
                - "http-post"
                - "ssh"
                - "cifs"
              regexp: <string>
              severity: <value in [info, low, medium, ...]>
              type: <value in [file, message]>
              sensitivity: <list or string>
          flow_based: <value in [disable, enable]>
          full_archive_proto:
            - "imap"
            - "smtp"
            - "pop3"
            - "ftp"
            - "nntp"
            - "mm1"
            - "mm3"
            - "mm4"
            - "mm7"
            - "mapi"
            - "aim"
            - "icq"
            - "msn"
            - "yahoo"
            - "http-get"
            - "http-post"
            - "ssh"
            - "cifs"
          nac_quar_log: <value in [disable, enable]>
          name: <string>
          options: <value in [strict-file]>
          replacemsg_group: <string>
          summary_proto:
            - "imap"
            - "smtp"
            - "pop3"
            - "ftp"
            - "nntp"
            - "mm1"
            - "mm3"
            - "mm4"
            - "mm7"
            - "mapi"
            - "aim"
            - "icq"
            - "msn"
            - "yahoo"
            - "http-get"
            - "http-post"
            - "ssh"
            - "cifs"
          feature_set: <value in [proxy, flow]>
          entries:
            -
              count: <integer>
              dictionary: <string>
              id: <integer>
              status: <value in [disable, enable]>
          eval: <string>
          match_type: <value in [match-all, match-any, match-eval]>
          fgd_id: <integer>

返回值 

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

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