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 设备。
示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选项
|
|
设置的顶级参数。 |
|
CASB SaaS 应用程序名称。 |
|
CASB 用户活动签名名称。 |
|
CASB 用户活动类别。 选项
|
|
控制选项。 |
|
CASB 控制选项名称。 |
|
操作。 |
|
CASB 操作动作。 选项
|
|
CASB 操作搜索是否区分大小写。 选项
|
|
CASB 操作方向。 选项
|
|
要搜索的 CASB 操作标头名称。 |
|
CASB 控制选项操作名称。 |
|
要搜索的 CASB 操作键。 |
|
CASB 操作搜索模式。 选项
|
|
CASB 操作目标。 选项
|
|
启用/禁用来自用户输入的值。 选项
|
|
CASB 操作新值。 |
|
CASB 控制选项状态。 选项
|
|
CASB 用户活动描述。 |
|
匹配。 |
|
CASB 用户活动匹配规则 ID。 |
|
规则。 |
|
CASB 用户活动匹配是否区分大小写。 选项
|
|
CASB 用户活动域列表。 |
|
CASB 用户活动规则标头名称。 |
|
CASB 用户活动规则 ID。 |
|
CASB 用户活动规则匹配模式。 选项
|
|
CASB 用户活动规则匹配值。 |
|
CASB 用户活动方法列表。 |
|
启用/禁用匹配策略不得为何值。 选项
|
|
CASB 用户活动规则类型。 选项
|
|
CASB 用户活动规则策略。 选项
|
|
CASB 用户活动匹配策略。 选项
|
|
CASB 用户活动名称。 |
|
CASB 用户活动状态。 选项
|
|
CASB 用户活动类型。 选项
|
|
通用唯一标识符。 |
|
启用/禁用任务日志记录。 选项
|
|
使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的重写方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
用于创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 root。 |
|
等待其他用户释放工作区锁定的最长时间（秒）。 默认值: |
说明
注意
从 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]>
返回值
常见返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果当前 FortiManager 版本不支持 playbook 中使用的参数，则发出警告。 返回: 复杂 |