fortinet.fortios.fortios_casb_user_activity 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 CASB 用户活动。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_casb_user_activity。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
casb_user_activity 字典	配置 CASB 用户活动。
application 字符串	CASB SaaS 应用名称。来源 casb.saas-application.name。
casb_name 字符串	CASB 用户活动签名名称。
category 字符串	CASB 用户活动类别。 选项 "activity-control" "tenant-control" "domain-control" "safe-search-control" "other"
control_options 列表 / 元素=字典	CASB 控制选项。
name 字符串 / 必需	CASB 控制选项名称。
operations 列表 / 元素=字典	CASB 控制选项操作。
action 字符串	CASB 操作动作。 选项 "append" "prepend" "replace" "new" "new-on-not-found" "delete"
case_sensitive 字符串	CASB 操作搜索区分大小写。 选项 "enable" "disable"
direction 字符串	CASB 操作方向。 选项 "request"
header_name 字符串	要搜索的 CASB 操作头名称。
name 字符串 / 必需	CASB 控制选项操作名称。
search_key 字符串	CASB 操作搜索键。
search_pattern 字符串	CASB 操作搜索模式。 选项 "simple" "substr" "regexp"
target 字符串	CASB 操作目标。 选项 "header" "path"
value_from_input 字符串	启用/禁用来自用户输入的值。 选项 "enable" "disable"
values 列表 / 元素=字典	CASB 操作新值。
value 字符串 / 必需	操作值。
status 字符串	CASB 控制选项状态。 选项 "enable" "disable"
description 字符串	CASB 用户活动描述。
match 列表 / 元素=字典	CASB 用户活动匹配规则。
id 整数 / 必需	CASB 用户活动匹配规则 ID。请参阅 备注。
rules 列表 / 元素=字典	CASB 用户活动规则。
case_sensitive 字符串	CASB 用户活动匹配区分大小写。 选项 "enable" "disable"
domains 列表 / 元素=字典	CASB 用户活动域名列表。
domain 字符串 / 必需	以空格分隔的域名列表。
header_name 字符串	CASB 用户活动规则头名称。
id 整数 / 必需	CASB 用户活动规则 ID。请参阅 备注。
match_pattern 字符串	CASB 用户活动规则匹配模式。 选项 "simple" "substr" "regexp"
match_value 字符串	CASB 用户活动规则匹配值。
methods 列表 / 元素=字典	CASB 用户活动方法列表。
method 字符串 / 必需	用户活动方法。
negate 字符串	启用/禁用匹配策略必须不满足的条件。 选项 "enable" "disable"
type 字符串	CASB 用户活动规则类型。 选项 "domains" "host" "path" "header" "header-value" "method"
strategy 字符串	CASB 用户活动规则策略。 选项 "and" "or"
match_strategy 字符串	CASB 用户活动匹配策略。 选项 "and" "or"
name 字符串 / 必需	CASB 用户活动名称。
status 字符串	CASB 用户活动状态。 选项 "enable" "disable"
type 字符串	CASB 用户活动类型。 选项 "built-in" "customized"
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 CASB user activity.
  fortinet.fortios.fortios_casb_user_activity:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_user_activity:
          application: "<your_own_value> (source casb.saas-application.name)"
          casb_name: "<your_own_value>"
          category: "activity-control"
          control_options:
              -
                  name: "default_name_7"
                  operations:
                      -
                          action: "append"
                          case_sensitive: "enable"
                          direction: "request"
                          header_name: "<your_own_value>"
                          name: "default_name_13"
                          search_key: "<your_own_value>"
                          search_pattern: "simple"
                          target: "header"
                          value_from_input: "enable"
                          values:
                              -
                                  value: "<your_own_value>"
                  status: "enable"
          description: "<your_own_value>"
          match:
              -
                  id: "23"
                  rules:
                      -
                          case_sensitive: "enable"
                          domains:
                              -
                                  domain: "<your_own_value>"
                          header_name: "<your_own_value>"
                          id: "29"
                          match_pattern: "simple"
                          match_value: "<your_own_value>"
                          methods:
                              -
                                  method: "<your_own_value>"
                          negate: "enable"
                          type: "domains"
                  strategy: "and"
          match_strategy: "and"
          name: "default_name_38"
          status: "enable"
          type: "built-in"
          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"
version 字符串	FortiGate的版本 返回值：始终返回 示例： "v5.6.3"

作者

• 郑链 (@chillancezen)

• 薛杰 (@JieX19)

• 陆洪斌 (@fgtdev-hblu)

• 沈方 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

资源链接

• 问题追踪器
• 主页
• 代码库 (源码)