fortinet.fortios.fortios_dlp_dictionary 模块 – 在 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_dictionary

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

dlp_dictionary

字典

配置用于 DLP 阻止的字典。

comment

字符串

可选注释。

entries

列表 / 元素=字典

DLP 字典条目。

comment

字符串

可选注释。

id

整数 / 必需

ID。参见 <a href=’#notes’>备注</a>。

ignore_case

字符串

启用/禁用忽略大小写。

选择

  • "enable"

  • "disable"

pattern

字符串

要匹配的模式。

repeat

字符串

启用/禁用重复匹配。

选择

  • "enable"

  • "disable"

status

字符串

启用/禁用此模式。

选择

  • "enable"

  • "disable"

type

字符串

要匹配的模式类型。源 dlp.data-type.name。

match_around

字符串

启用/禁用匹配周围支持。

选择

  • "enable"

  • "disable"

match_type

字符串

条目之间的逻辑关系。

选择

  • "match-all"

  • "match-any"

name

字符串 / 必需

包含字典的表的名称。

uuid

字符串

通用唯一标识符(UUID;自动分配,但可以手动重置)。

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 dictionaries used by DLP blocking.
  fortinet.fortios.fortios_dlp_dictionary:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_dictionary:
          comment: "Optional comments."
          entries:
              -
                  comment: "Optional comments."
                  id: "6"
                  ignore_case: "enable"
                  pattern: "<your_own_value>"
                  repeat: "enable"
                  status: "enable"
                  type: "<your_own_value> (source dlp.data-type.name)"
          match_around: "enable"
          match_type: "match-all"
          name: "default_name_14"
          uuid: "<your_own_value>"

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

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"

版本

字符串

FortiGate 版本

已返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)