fortinet.fortimanager.fmgr_waf_profile_urlaccess 模块 – URL 访问列表

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_waf_profile_urlaccess。

在 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 代码列表。

state

字符串 / 必填

用于创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

waf_profile_urlaccess

字典

设置的顶层参数。

access_pattern

别名：access-pattern

列表 / 元素=字典

访问模式。

id

整数

URL 访问模式 ID。

negate

字符串

启用/禁用匹配否定。

选项

  • "disable"

  • "enable"

pattern

字符串

URL 模式。

regex

字符串

启用/禁用基于正则表达式的模式匹配。

选项

  • "disable"

  • "enable"

srcaddr

字符串

源地址。

action

字符串

操作。

选项

  • "bypass"

  • "permit"

  • "block"

address

字符串

主机地址。

id

整数 / 必填

URL 访问 ID。

log

字符串

启用/禁用日志记录。

选项

  • "disable"

  • "enable"

severity

字符串

严重性。

选项

  • "low"

  • "medium"

  • "high"

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 有助于完成工作。

  • 要创建或更新对象，请使用状态 present 指令。

  • 要删除对象，请使用状态 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: URL access list
      fortinet.fortimanager.fmgr_waf_profile_urlaccess:
        # 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>
        state: present # <value in [present, absent]>
        waf_profile_urlaccess:
          access_pattern:
            -
              id: <integer>
              negate: <value in [disable, enable]>
              pattern: <string>
              regex: <value in [disable, enable]>
              srcaddr: <string>
          action: <value in [bypass, permit, block]>
          address: <string>
          id: <integer>
          log: <value in [disable, enable]>
          severity: <value in [low, medium, high]>

返回值

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

键

描述

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 版本支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)