fortinet.fortimanager.fmgr_casb_useractivity 模块 – 配置 CASB 用户活动。

注意

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

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

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

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

fortinet.fortimanager 2.3.0 中的新增功能

概要

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

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

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
casb_useractivity 字典	设置的顶级参数。
application 字符串	CASB SaaS 应用名称。
casb_name 别名：casb-name 字符串	CASB 用户活动签名名称。
category 字符串	CASB 用户活动类别。 选项 "activity-control" "tenant-control" "domain-control" "safe-search-control" "other"
control_options 别名：control-options 列表 / 元素=字典	控制选项。
name 字符串	CASB 控制选项名称。
operations 列表 / 元素=字典	操作。
action 字符串	CASB 操作动作。 选项 "append" "prepend" "replace" "new" "new-on-not-found" "delete"
case_sensitive 别名：case-sensitive 字符串	CASB 操作搜索区分大小写。 选项 "disable" "enable"
direction 字符串	CASB 操作方向。 选项 "request"
header_name 别名：header-name 字符串	要搜索的 CASB 操作头名称。
name 字符串	CASB 控制选项操作名称。
search_key 别名：search-key 字符串	要搜索的 CASB 操作键。
search_pattern 别名：search-pattern 字符串	CASB 操作搜索模式。 选项 "simple" "substr" "regexp"
target 字符串	CASB 操作目标。 选项 "header" "path"
value_from_input 别名：value-from-input 字符串	启用/禁用来自用户输入的值。 选项 "disable" "enable"
values 列表 / 元素=字符串	CASB 操作新值。
status 字符串	CASB 控制选项状态。 选项 "disable" "enable"
description 字符串	CASB 用户活动描述。
match 列表 / 元素=字典	匹配。
id 整数	CASB 用户活动匹配规则 ID。
rules 列表 / 元素=字典	规则。
case_sensitive 别名：case-sensitive 字符串	CASB 用户活动匹配区分大小写。 选项 "disable" "enable"
domains 列表 / 元素=字符串	CASB 用户活动域名列表。
header_name 别名：header-name 字符串	CASB 用户活动规则头名称。
id 整数	CASB 用户活动规则 ID。
match_pattern 别名：match-pattern 字符串	CASB 用户活动规则匹配模式。 选项 "simple" "substr" "regexp"
match_value 别名：match-value 字符串	CASB 用户活动规则匹配值。
methods 列表 / 元素=字符串	CASB 用户活动方法列表。
negate 字符串	启用/禁用匹配策略不应该是什么。 选项 "disable" "enable"
type 字符串	CASB 用户活动规则类型。 选项 "domains" "host" "path" "header" "header-value" "method"
strategy 字符串	CASB 用户活动规则策略。 选项 "or" "and"
match_strategy 别名：match-strategy 字符串	CASB 用户活动匹配策略。 选项 "or" "and"
name 字符串 / 必需	CASB 用户活动名称。
status 字符串	CASB 用户活动状态。 选项 "disable" "enable"
type 字符串	CASB 用户活动类型。 选项 "built-in" "customized"
uuid 字符串	通用唯一标识符
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 CASB user activity.
      fortinet.fortimanager.fmgr_casb_useractivity:
        # 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]>
        casb_useractivity:
          application: <string>
          casb_name: <string>
          category: <value in [activity-control, tenant-control, domain-control, ...]>
          control_options:
            -
              name: <string>
              operations:
                -
                  action: <value in [append, prepend, replace, ...]>
                  case_sensitive: <value in [disable, enable]>
                  direction: <value in [request]>
                  header_name: <string>
                  name: <string>
                  search_key: <string>
                  search_pattern: <value in [simple, substr, regexp]>
                  target: <value in [header, path]>
                  value_from_input: <value in [disable, enable]>
                  values: <list or string>
              status: <value in [disable, enable]>
          description: <string>
          match:
            -
              id: <integer>
              rules:
                -
                  case_sensitive: <value in [disable, enable]>
                  domains: <list or string>
                  header_name: <string>
                  id: <integer>
                  match_pattern: <value in [simple, substr, regexp]>
                  match_value: <string>
                  methods: <list or string>
                  negate: <value in [disable, enable]>
                  type: <value in [domains, host, path, ...]>
              strategy: <value in [or, and]>
          match_strategy: <value in [or, and]>
          name: <string>
          type: <value in [built-in, customized]>
          uuid: <string>
          status: <value in [disable, enable]>

返回值

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

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

收藏链接

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