fortinet.fortios.fortios_web_proxy_global 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 Web 代理全局设置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在剧本中使用它，请指定：fortinet.fortios.fortios_web_proxy_global。

fortinet.fortios 2.0.0 中的新功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 Fortigate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
member_path 字符串	要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
vdom 字符串	虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： "root"
web_proxy_global 字典	配置 Web 代理全局设置。
always_learn_client_ip 字符串	启用/禁用从每个请求的标头中学习客户端的 IP 地址。 选项 "enable" "disable"
fast_policy_match 字符串	启用/禁用显式和透明代理策略的快速匹配算法。 选项 "enable" "disable"
forward_proxy_auth 字符串	启用/禁用转发代理身份验证标头。 选项 "enable" "disable"
forward_server_affinity_timeout 整数	源 IP 的流量不再分配给转发服务器的时间段（6 - 60 分钟）。
ldap_user_cache 字符串	启用/禁用显式和透明代理用户的 LDAP 用户缓存。 选项 "enable" "disable"
learn_client_ip 字符串	启用/禁用从标头中学习客户端的 IP 地址。 选项 "enable" "disable"
learn_client_ip_from_header 列表 / 元素=字符串	从指定的标头中学习客户端 IP 地址。 选项 "true-client-ip" "x-real-ip" "x-forwarded-for"
learn_client_ip_srcaddr 列表 / 元素=字典	源地址名称（必须设置 srcaddr 或 srcaddr6）。
name 字符串 / 必需	地址名称。源 firewall.address.name firewall.addrgrp.name。
learn_client_ip_srcaddr6 列表 / 元素=字典	IPv6 源地址名称（必须设置 srcaddr 或 srcaddr6）。
name 字符串 / 必需	地址名称。源 firewall.address6.name firewall.addrgrp6.name。
log_app_id 字符串	启用/禁用始终在流量日志中记录应用程序类型。 选项 "enable" "disable"
log_forward_server 字符串	启用/禁用在转发流量日志中记录转发服务器名称。 选项 "enable" "disable"
log_policy_pending 字符串	启用/禁用记录正在等待策略匹配的会话。 选项 "enable" "disable"
max_message_length 整数	HTTP 消息的最大长度，不包括正文（16 - 256 KB）。
max_request_length 整数	HTTP 请求行的最大长度（2 - 64 KB）。
max_waf_body_cache_length 整数	Web 应用程序防火墙 (WAF) 处理的 HTTP 消息的最大长度（10 - 1024 KB）。
policy_category_deep_inspect 字符串	启用/禁用应用程序级别类别策略匹配的深度检查。 选项 "enable" "disable"
proxy_fqdn 字符串	客户端连接到以连接到显式 Web 代理的完全限定域名 (FQDN)。
proxy_transparent_cert_inspection 字符串	启用/禁用透明代理证书检查。 选项 "enable" "disable"
src_affinity_exempt_addr 列表 / 元素=字符串	用于豁免代理关联的 IPv4 源地址。
src_affinity_exempt_addr6 列表 / 元素=字符串	用于豁免代理关联的 IPv6 源地址。
ssl_ca_cert 字符串	用于 SSL 拦截的 SSL CA 证书。源 vpn.certificate.local.name。
ssl_cert 字符串	用于 SSL 拦截的 SSL 证书。源 vpn.certificate.local.name。
strict_web_check 字符串	启用/禁用严格的 Web 检查，以阻止发送不符合 HTTP 1.1 的错误标头的网站。 选项 "enable" "disable"
tunnel_non_http 字符串	启用/禁用允许非 HTTP 流量。允许的非 HTTP 流量将进行隧道传输。 选项 "enable" "disable"
unknown_http_version 字符串	遇到未知版本的 HTTP 时采取的操作：拒绝、允许（隧道传输）或尽力而为。 选项 "reject" "tunnel" "best-effort"
webproxy_profile 字符串	当默认允许显式代理流量，并且接受与显式代理策略不匹配的流量时，应用的 Web 代理配置文件的名称。来源：web-proxy.profile.name。

注释

注意

• 传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Configure Web proxy global settings.
  fortinet.fortios.fortios_web_proxy_global:
      vdom: "{{ vdom }}"
      web_proxy_global:
          always_learn_client_ip: "enable"
          fast_policy_match: "enable"
          forward_proxy_auth: "enable"
          forward_server_affinity_timeout: "30"
          ldap_user_cache: "enable"
          learn_client_ip: "enable"
          learn_client_ip_from_header: "true-client-ip"
          learn_client_ip_srcaddr:
              -
                  name: "default_name_11 (source firewall.address.name firewall.addrgrp.name)"
          learn_client_ip_srcaddr6:
              -
                  name: "default_name_13 (source firewall.address6.name firewall.addrgrp6.name)"
          log_app_id: "enable"
          log_forward_server: "enable"
          log_policy_pending: "enable"
          max_message_length: "32"
          max_request_length: "8"
          max_waf_body_cache_length: "32"
          policy_category_deep_inspect: "enable"
          proxy_fqdn: "<your_own_value>"
          proxy_transparent_cert_inspection: "enable"
          src_affinity_exempt_addr: "<your_own_value>"
          src_affinity_exempt_addr6: "<your_own_value>"
          ssl_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
          ssl_cert: "<your_own_value> (source vpn.certificate.local.name)"
          strict_web_check: "enable"
          tunnel_non_http: "enable"
          unknown_http_version: "reject"
          webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"

返回值

通用返回值已在此处记录 这里，以下是此模块特有的字段

键	描述
构建 字符串	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"

作者

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）