fortinet.fortios.fortios_firewall_proxy_address 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 Web 代理地址。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_firewall_proxy_address。

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改防火墙功能和 proxy_address 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 Fortigate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
firewall_proxy_address 字典	配置 Web 代理地址。
application 列表 / 元素=字典	SaaS 应用程序。
name 字符串 / 必需	SaaS 应用程序名称。
case_sensitivity 字符串	启用以使模式区分大小写。 选项 "disable" "enable"
category 列表 / 元素=字典	FortiGuard 类别 ID。
id 整数 / 必需	FortiGuard 类别 ID。请参阅 备注。
color 整数	确定 GUI 中图标颜色的整数值 (1 - 32)。
comment 字符串	可选注释。
header 字符串	作为正则表达式的 HTTP 标头名称。
header_group 列表 / 元素=字典	HTTP 标头组。
case_sensitivity 字符串	模式中的大小写敏感性。 选项 "disable" "enable"
header 字符串	HTTP 标头正则表达式。
header_name 字符串	HTTP 标头。
id 整数 / 必需	ID。请参阅 备注。
header_name 字符串	HTTP 标头的名称。
host 字符串	主机的地址对象。来源 firewall.address.name firewall.addrgrp.name firewall.proxy-address.name。
host_regex 字符串	作为正则表达式的主机名。
method 列表 / 元素=字符串	要使用的 HTTP 请求方法。 选项 "get" "post" "put" "head" "connect" "trace" "options" "delete"
name 字符串 / 必需	地址名称。
path 字符串	作为正则表达式的 URL 路径。
query 字符串	将 URL 的查询部分与正则表达式匹配。
referrer 字符串	启用/禁用使用 HTTP 标头中的 referrer 字段来匹配地址。 选项 "enable" "disable"
tagging 列表 / 元素=字典	配置对象标记。
category 字符串	标记类别。来源 system.object-tagging.category。
name 字符串 / 必需	标记条目名称。
tags 列表 / 元素=字典	标签。
name 字符串 / 必需	标签名称。来源 system.object-tagging.tags.name。
type 字符串	代理地址类型。 选项 "host-regex" "url" "category" "method" "ua" "header" "src-advanced" "dst-advanced" "saas"
ua 列表 / 元素=字符串	要用作用户代理的浏览器名称。 选项 "chrome" "ms" "firefox" "safari" "ie" "edge" "other"
ua_max_ver 字符串	以点分十进制表示法指定的用户代理的最大版本。例如，将 ua 字段设置为“chrome”并使用 120 来要求 Google Chrome 的最大版本必须为 120。
ua_min_ver 字符串	以点分十进制表示法指定的用户代理的最小版本。例如，将 ua 字段设置为“chrome”并使用 90.0.1 来要求 Google Chrome 的最小版本必须为 90.0.1。
uuid 字符串	通用唯一标识符 (UUID；自动分配，但可以手动重置)。
visibility 字符串	启用/禁用对象在 GUI 中的可见性。 选项 "enable" "disable"
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则以斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
state 字符串 / 必需	指示是创建还是删除对象。 选项 "present" "absent"
vdom 字符串	虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

备注

注意

• 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。

• 此模块支持 check_mode。

示例

- name: Configure web proxy address.
  fortinet.fortios.fortios_firewall_proxy_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_proxy_address:
          application:
              -
                  name: "default_name_4"
          case_sensitivity: "disable"
          category:
              -
                  id: "7"
          color: "0"
          comment: "Optional comments."
          header: "<your_own_value>"
          header_group:
              -
                  case_sensitivity: "disable"
                  header: "<your_own_value>"
                  header_name: "<your_own_value>"
                  id: "15"
          header_name: "<your_own_value>"
          host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
          host_regex: "myhostname"
          method: "get"
          name: "default_name_20"
          path: "<your_own_value>"
          query: "<your_own_value>"
          referrer: "enable"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_26"
                  tags:
                      -
                          name: "default_name_28 (source system.object-tagging.tags.name)"
          type: "host-regex"
          ua: "chrome"
          ua_max_ver: "<your_own_value>"
          ua_min_ver: "<your_own_value>"
          uuid: "<your_own_value>"
          visibility: "enable"

返回值

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

键	描述
build 字符串	FortiGate 镜像的内部版本号 返回：始终 示例： "1547"
http_method 字符串	上次用于将内容配置到 FortiGate 的方法 返回：始终 示例： "PUT"
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果 返回：始终 示例： "200"
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (ID) 返回：成功 示例： "id"
name 字符串	用于完成请求的表名称 返回：始终 示例： "urlfilter"
path 字符串	用于完成请求的表路径 返回：始终 示例： "webfilter"
revision 字符串	内部修订号 返回：始终 示例： "17.0.2.10658"
serial 字符串	设备的序列号 返回：始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果指示 返回：始终 示例： "success"
vdom 字符串	使用的虚拟域 返回：始终 示例： "root"
version 字符串	FortiGate 的版本 返回：始终 示例： "v5.6.3"

作者

• 郑链 (@chillancezen)

• 薛杰 (@JieX19)

• 卢洪斌 (@fgtdev-hblu)

• 沈方 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

资源链接

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