fortinet.fortimanager.fmgr_waf_profile_signature 模块 – WAF 签名。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定: fortinet.fortimanager.fmgr_waf_profile_signature
。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括需要在使用前调整为数据源的所有参数和值。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True,模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
请求 URL 中的参数 (profile)。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶级参数。 |
|
检测违规的信用卡最小数量。 |
|
自定义签名。 |
|
动作。 选项
|
|
模式中的大小写敏感性。 选项
|
|
流量方向。 选项
|
|
启用/禁用日志记录。 选项
|
|
签名名称。 |
|
匹配模式。 |
|
严重性。 选项
|
|
状态。 选项
|
|
匹配 HTTP 目标。 选项
|
|
(列表或字符串) 禁用的签名 |
|
(列表或字符串) 禁用的签名子类。 |
|
主类。 |
|
动作。 选项
|
|
主签名类 ID。 |
|
启用/禁用日志记录。 选项
|
|
严重性。 选项
|
|
状态。 选项
|
|
在工作区模式下运行 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` 用于实现此功能。
通常情况下,如果返回非零 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: WAF signatures.
fortinet.fortimanager.fmgr_waf_profile_signature:
# 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>
waf_profile_signature:
credit_card_detection_threshold: <integer>
custom_signature:
-
action: <value in [allow, block, erase]>
case_sensitivity: <value in [disable, enable]>
direction: <value in [request, response]>
log: <value in [disable, enable]>
name: <string>
pattern: <string>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
target:
- "arg"
- "arg-name"
- "req-body"
- "req-cookie"
- "req-cookie-name"
- "req-filename"
- "req-header"
- "req-header-name"
- "req-raw-uri"
- "req-uri"
- "resp-body"
- "resp-hdr"
- "resp-status"
disabled_signature: <list or string>
disabled_sub_class: <list or string>
main_class:
action: <value in [allow, block, erase]>
id: <integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段:
键 |
描述 |
---|---|
请求的结果。 返回值: 始终返回 |
|
请求的完整 URL。 返回值: 始终返回 示例: |
|
API 请求的状态。 返回值: 始终返回 示例: |
|
API 响应。 返回值: 始终返回 |
|
API 响应的描述性消息。 返回值: 始终返回 示例: |
|
目标系统的信息。 返回值: 始终返回 |
|
请求的状态。 返回值: 始终返回 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回值: 复杂类型 |