fortinet.fortimanager.fmgr_dlp_profile_rule 模块 – 为此配置文件设置 DLP 规则。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

dlp_profile_rule

字典

设置的顶级参数。

action

字符串

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

选项

  • "仅日志"

  • "阻止"

  • "隔离 IP"

  • "允许"

archive

字符串

启用/禁用 DLP 归档。

选项

  • "禁用"

  • "启用"

expiry

字符串

隔离持续时间（以天、小时、分钟为单位）

file_size

别名：file-size

整数

匹配此大小或更大的文件

file_type

别名：file-type

字符串

选择要匹配的 DLP 文件模式表的编号。

filter_by

别名：filter-by

字符串

选择要匹配的内容类型。

选项

  • "指纹"

  • "传感器"

  • "加密的"

  • "无"

  • "MIP"

id

整数 / 必需

ID。

label

字符串

MIP 标签字典。

match_percentage

别名：match-percentage

整数

与所选敏感性指定的指纹数据库中的指纹百分比匹配。

name

字符串

过滤器名称。

proto

列表 / 元素=字符串

检查通过以下一种或多种协议的消息或文件。

选项

  • "smtp"

  • "pop3"

  • "imap"

  • "http-post"

  • "http-get"

  • "ftp"

  • "nntp"

  • "mapi"

  • "ssh"

  • "cifs"

sensitivity

任意

(列表) 选择要匹配的 DLP 文件模式敏感性。

sensor

任意

(列表) 选择 DLP 传感器。

severity

字符串

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

选项

  • "信息"

  • "低"

  • "中"

  • "高"

  • "严重"

type

字符串

选择是否检查消息的内容

选项

  • "文件"

  • "消息"

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

profile

字符串 / 必需

请求 URL 中的参数 (profile)。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "更新"

  • "设置"

  • "添加"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "存在"

  • "不存在"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是全局值和其他值，包括 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: Set up DLP rules for this profile.
      fortinet.fortimanager.fmgr_dlp_profile_rule:
        # 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>
        profile: <your own value>
        state: present # <value in [present, absent]>
        dlp_profile_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]>

返回值

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

键

描述

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 版本支持，则会发出警告。

返回： complex

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑连 (@chillancezen)

  • 沈锋 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)