fortinet.fortimanager.fmgr_dlp_profile 模块 – 配置 DLP 配置文件。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
dlp_profile 字典	设置的顶级参数。
comment 字符串	注释。
dlp_log 别名：dlp-log 字符串	启用/禁用 DLP 日志记录。 选项 "disable" "enable"
extended_log 别名：extended-log 字符串	启用/禁用数据泄露防护的扩展日志记录。 选项 "disable" "enable"
feature_set 别名：feature-set 字符串	流/代理功能集。 选项 "flow" "proxy"
full_archive_proto 别名：full-archive-proto 列表 / 元素=字符串	始终内容归档的协议。 选项 "smtp" "pop3" "imap" "http-post" "http-get" "ftp" "nntp" "mapi" "ssh" "cifs"
nac_quar_log 别名：nac-quar-log 字符串	启用/禁用 NAC 隔离日志记录。 选项 "disable" "enable"
name 字符串 / 必需	DLP 配置文件的名称。
replacemsg_group 别名：replacemsg-group 字符串	此 DLP 配置文件使用的替换消息组。
rule 列表 / 元素=字典	规则。
action 字符串	对与该 DLP 配置文件匹配的内容采取的操作。 选项 "log-only" "block" "quarantine-ip" "allow"
archive 字符串	启用/禁用 DLP 归档。 选项 "disable" "enable"
expiry 字符串	隔离持续时间（以天、小时、分钟为单位）
file_size 别名：file-size 整数	匹配此大小或更大的文件
file_type 别名：file-type 字符串	选择要匹配的 DLP 文件模式表的编号。
filter_by 别名：filter-by 字符串	选择要匹配的内容类型。 选项 "fingerprint" "sensor" "encrypted" "none" "mip"
id 整数	ID。
label 字符串	MIP 标签字典。
match_percentage 别名：match-percentage 整数	与所选敏感度指定的指纹数据库中的指纹百分比匹配。
name 字符串	过滤器名称。
proto 列表 / 元素=字符串	检查一个或多个这些协议的消息或文件。 选项 "smtp" "pop3" "imap" "http-post" "http-get" "ftp" "nntp" "mapi" "ssh" "cifs"
sensitivity any	(列表) 选择要匹配的 DLP 文件模式敏感度。
sensor any	(列表) 选择 DLP 传感器。
severity 字符串	选择与该过滤器匹配的严重性或威胁级别。 选项 "info" "low" "medium" "high" "critical"
type 字符串	选择是否检查消息的内容 选项 "file" "message"
summary_proto 别名：summary-proto 列表 / 元素=字符串	始终记录摘要的协议。 选项 "smtp" "pop3" "imap" "http-post" "http-get" "ftp" "nntp" "mapi" "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 profiles.
      fortinet.fortimanager.fmgr_dlp_profile:
        # 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_profile:
          comment: <string>
          dlp_log: <value in [disable, enable]>
          extended_log: <value in [disable, enable]>
          feature_set: <value in [flow, proxy]>
          full_archive_proto:
            - "smtp"
            - "pop3"
            - "imap"
            - "http-post"
            - "http-get"
            - "ftp"
            - "nntp"
            - "mapi"
            - "ssh"
            - "cifs"
          nac_quar_log: <value in [disable, enable]>
          name: <string>
          replacemsg_group: <string>
          rule:
            -
              action: <value in [log-only, block, quarantine-ip, ...]>
              archive: <value in [disable, enable]>
              expiry: <string>
              file_size: <integer>
              file_type: <string>
              filter_by: <value in [fingerprint, sensor, encrypted, ...]>
              id: <integer>
              label: <string>
              match_percentage: <integer>
              name: <string>
              proto:
                - "smtp"
                - "pop3"
                - "imap"
                - "http-post"
                - "http-get"
                - "ftp"
                - "nntp"
                - "mapi"
                - "ssh"
                - "cifs"
              sensitivity: <list or string>
              sensor: <list or string>
              severity: <value in [info, low, medium, ...]>
              type: <value in [file, message]>
          summary_proto:
            - "smtp"
            - "pop3"
            - "imap"
            - "http-post"
            - "http-get"
            - "ftp"
            - "nntp"
            - "mapi"
            - "ssh"
            - "cifs"

返回值

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

键	描述
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 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂类型

作者

• 杜欣蔚 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑琳 (@chillancezen)

• 沈芳 (@fshen01)

• 卢洪斌 (@fgtdev-hblu)

收藏链接

• 问题跟踪器
• 主页
• 代码库（源代码）