fortinet.fortimanager.fmgr_waf_profile_method 模块 – 方法限制。

注意

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

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

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

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

fortinet.fortimanager 2.0.0中的新增功能

概要

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

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

参数

参数	注释
access_token 字符串	无需用户名和密码即可访问FortiManager的令牌。
adom 字符串 / 必需	请求URL中的参数（adom）。
bypass_validation 布尔值	仅当模块模式与FortiManager API结构不同时设置为True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用FortiCloud API访问令牌验证Ansible客户端。
profile 字符串 / 必需	请求URL中的参数（profile）。
proposed_method 字符串	底层Json RPC请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将被覆盖的失败条件的RC代码列表。
rc_succeeded 列表 / 元素=整数	将被覆盖的成功条件的RC代码列表。
waf_profile_method 字典	设置的顶级参数。
default_allowed_methods 别名：default-allowed-methods 列表 / 元素=字符串	方法。 选项 "delete" "get" "head" "options" "post" "put" "trace" "others" "connect"
log 字符串	启用/禁用日志记录。 选项 "disable" "enable"
method_policy 别名：method-policy 列表 / 元素=字典	方法策略。
address 字符串	主机地址。
allowed_methods 别名：allowed-methods 列表 / 元素=字符串	允许的方法。 选项 "delete" "get" "head" "options" "post" "put" "trace" "others" "connect"
id 整数	HTTP方法策略ID。
pattern 字符串	URL模式。
regex 字符串	启用/禁用基于正则表达式的模式匹配。 选项 "disable" "enable"
severity 字符串	严重性。 选项 "low" "medium" "high"
status 字符串	状态。 选项 "disable" "enable"
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的ADOM，该值可以是全局的和其他值，包括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有助于完成这项工作。

• 通常，当返回非零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: Method restriction.
      fortinet.fortimanager.fmgr_waf_profile_method:
        # 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_method:
          default_allowed_methods:
            - "delete"
            - "get"
            - "head"
            - "options"
            - "post"
            - "put"
            - "trace"
            - "others"
            - "connect"
          log: <value in [disable, enable]>
          method_policy:
            -
              address: <string>
              allowed_methods:
                - "delete"
                - "get"
                - "head"
                - "options"
                - "post"
                - "put"
                - "trace"
                - "others"
                - "connect"
              id: <integer>
              pattern: <string>
              regex: <value in [disable, enable]>
          severity: <value in [low, medium, high]>
          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 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回： complex

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑琳 (@chillancezen)

• 沈芳 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

资源链接

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