fortinet.fortimanager.fmgr_firewall_explicitproxyaddress 模块 – 显式 Web 代理地址配置。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 url 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ← (默认)

  • true

firewall_explicitproxyaddress

字典

设置的顶级参数。

case_sensitivity

别名: case-sensitivity

字符串

模式中的区分大小写。

选择

  • "disable"

  • "enable"

category

字符串

FortiGuard 类别 ID。

color

整数

GUI 图标颜色。

comment

字符串

注释。

header

字符串

HTTP 标头正则表达式。

header_group

别名: header-group

列表 / 元素=字典

标头组。

case_sensitivity

别名: case-sensitivity

字符串

模式中的区分大小写。

选择

  • "disable"

  • "enable"

header

字符串

HTTP 标头正则表达式。

header_name

别名: header-name

字符串

HTTP 标头。

id

整数

ID。

header_name

别名: header-name

字符串

HTTP 标头。

host

字符串

主机地址

host_regex

别名: host-regex

字符串

主机正则表达式。

method

列表 / 元素=字符串

HTTP 方法。

选择

  • "delete"

  • "get"

  • "head"

  • "options"

  • "post"

  • "put"

  • "trace"

  • "connect"

name

字符串 / 必需

地址名称。

path

字符串

URL 路径正则表达式。

tags

字符串

应用的对象标签。

type

字符串

地址类型。

选择

  • "host-regex"

  • "url"

  • "category"

  • "method"

  • "ua"

  • "header"

  • "src-advanced"

  • "dst-advanced"

ua

列表 / 元素=字符串

用户代理。

选择

  • "chrome"

  • "ms"

  • "firefox"

  • "safari"

  • "other"

uuid

字符串

通用唯一标识符。

visibility

字符串

启用/禁用地址可见性。

选择

  • "disable"

  • "enable"

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，该值可以是全局的，也可以是其他值，包括 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: Explicit web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_explicitproxyaddress:
        # 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]>
        firewall_explicitproxyaddress:
          case_sensitivity: <value in [disable, enable]>
          category: <string>
          color: <integer>
          comment: <string>
          header: <string>
          header_group:
            -
              case_sensitivity: <value in [disable, enable]>
              header: <string>
              header_name: <string>
              id: <integer>
          header_name: <string>
          host: <string>
          host_regex: <string>
          method:
            - "delete"
            - "get"
            - "head"
            - "options"
            - "post"
            - "put"
            - "trace"
            - "connect"
          name: <string>
          path: <string>
          tags: <string>
          type: <value in [host-regex, url, category, ...]>
          ua:
            - "chrome"
            - "ms"
            - "firefox"
            - "safari"
            - "other"
          uuid: <string>
          visibility: <value in [disable, enable]>

返回值

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

键

描述

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)