fortinet.fortios.fortios_web_proxy_explicit 模块 – 在 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_web_proxy_explicit
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 web_proxy 功能和 explicit 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整到数据源。已使用 FOS v6.0.0 进行测试
要求
执行此模块的主机上需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果存在多个属性,则使用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时,将忽略 state 选项。 选项
|
|
虚拟域,在之前定义的那些域中。vdom 是 FortiGate 的一个虚拟实例,可以配置并用作不同的单元。 默认值: |
|
配置显式 Web 代理设置。 |
|
启用/禁用以请求客户端证书。 选项
|
|
空客户端证书的操作。 选项
|
|
接受一个或多个端口上的传入 FTP over HTTP 请求 (0 - 65535)。 |
|
启用以代理从 Web 浏览器发送的 FTP over HTTP 会话。 选项
|
|
HTTP 连接模式。 选项
|
|
接受一个或多个端口上的传入 HTTP 请求 (0 - 65535)。 |
|
接受一个或多个端口上的传入 HTTPS 请求 (0 - 65535)。 |
|
启用/禁用向客户端发送 HTTPS 请求的替换消息。 选项
|
|
将显式 HTTP 代理限制为仅接受来自此 IP 地址的会话。接口必须具有此 IP 地址。 |
|
将显式 Web 代理限制为仅接受来自此 IPv6 地址的会话。接口必须具有此 IPv6 地址。 |
|
启用/禁用允许策略中的 IPv6 Web 代理目标以及此命令中的所有 IPv6 相关条目。 选项
|
|
启用/禁用在检测到服务器错误时显示替换消息。 选项
|
|
传出的 HTTP 请求将以此 IP 地址作为其源地址。接口必须具有此 IP 地址。 |
|
传出的 HTTP 请求将离开此 IPv6。可以指定多个接口。接口必须具有这些 IPv6 地址。 |
|
PAC 文件内容用引号括起来(最大 256K 字节)。 |
|
Pac 文件名。 |
|
客户端 Web 浏览器用于连接到显式 Web 代理的 PAC 流量的端口号 (0 - 65535)。 |
|
为此显式代理配置文件的用户启用/禁用代理自动配置 (PAC)。 选项
|
|
启用/禁用以通过 HTTPS 获取代理自动配置 (PAC)。 选项
|
|
PAC 文件访问 URL。 |
|
PAC 策略。 |
|
可选注释。 |
|
目标地址对象。 |
|
地址名称。源 firewall.address.name firewall.addrgrp.name。 |
|
PAC 文件内容用引号括起来(最大 256K 字节)。 |
|
Pac 文件名。 |
|
策略 ID。请参阅 <a href=’#notes’>说明</a>。 |
|
源地址对象。 |
|
地址名称。源 firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name。 |
|
源地址 6 对象。 |
|
地址名称。源 firewall.address6.name firewall.addrgrp6.name。 |
|
启用/禁用策略。 选项
|
|
首选使用配置的 IPv4 或 IPv6 DNS 服务器解析地址。 选项
|
|
用于标识显式 Web 代理的身份验证领域(最多 63 个字符)。 |
|
当不存在 Web 代理防火墙策略时,接受或拒绝显式 Web 代理会话。 选项
|
|
启用/禁用/要求 HTTP 和 HTTPS 会话的安全 Web 代理。 选项
|
|
安全 Web 代理的证书名称。 |
|
证书列表。来源 vpn.certificate.local.name。 |
|
启用/禁用 SOCKS 代理。 选项
|
|
在一个或多个端口(0 - 65535)上接受传入的 SOCKS 代理请求。 |
|
HTTPS 深度扫描中接受的加密算法的相对强度:高、中或低。 选项
|
|
在 DHE-RSA 协商中使用的 Diffie-Hellman (DH) 素数的位大小。 选项
|
|
启用/禁用 HTTP 和 HTTPS 会话的显式 Web 代理。 选项
|
|
启用/禁用显式 Web 代理的严格访客用户检查。 选项
|
|
启用/禁用记录超时的身份验证请求。 选项
|
|
如何处理不符合 HTTP 0.9、1.0 或 1.1 的 HTTP 会话。 选项
|
|
如果未提供客户端证书,则启用/禁用通过 HTTP 用户代理检测设备类型。 选项
|
注释
注意
旧的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式
示例
- name: Configure explicit Web proxy settings.
fortinet.fortios.fortios_web_proxy_explicit:
vdom: "{{ vdom }}"
web_proxy_explicit:
client_cert: "disable"
empty_cert_action: "accept"
ftp_incoming_port: "<your_own_value>"
ftp_over_http: "enable"
http_connection_mode: "static"
http_incoming_port: "<your_own_value>"
https_incoming_port: "<your_own_value>"
https_replacement_message: "enable"
incoming_ip: "<your_own_value>"
incoming_ip6: "<your_own_value>"
ipv6_status: "enable"
message_upon_server_error: "enable"
outgoing_ip: "<your_own_value>"
outgoing_ip6: "<your_own_value>"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
pac_file_server_port: "<your_own_value>"
pac_file_server_status: "enable"
pac_file_through_https: "enable"
pac_file_url: "<your_own_value>"
pac_policy:
-
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_26 (source firewall.address.name firewall.addrgrp.name)"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
policyid: "<you_own_value>"
srcaddr:
-
name: "default_name_31 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
srcaddr6:
-
name: "default_name_33 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
pref_dns_result: "ipv4"
realm: "<your_own_value>"
sec_default_action: "accept"
secure_web_proxy: "disable"
secure_web_proxy_cert:
-
name: "default_name_40 (source vpn.certificate.local.name)"
socks: "enable"
socks_incoming_port: "<your_own_value>"
ssl_algorithm: "high"
ssl_dh_bits: "768"
status: "enable"
strict_guest: "enable"
trace_auth_no_rsp: "enable"
unknown_http_version: "reject"
user_agent_detect: "disable"
返回值
常见返回值记录在此处 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
飞塔映像的构建版本号 返回:始终 示例: |
|
用于将内容配置到飞塔的最后一个方法 返回:始终 示例: |
|
飞塔在上次操作应用后给出的最后一个结果 返回:始终 示例: |
|
上次调用飞塔时使用的主键(ID) 返回:成功 示例: |
|
用于满足请求的表名称 返回:始终 示例: |
|
用于满足请求的表的路径 返回:始终 示例: |
|
内部修订号 返回:始终 示例: |
|
设备的序列号 返回:始终 示例: |
|
操作结果的指示 返回:始终 示例: |
|
使用的虚拟域 返回:始终 示例: |
|
飞塔的版本 返回:始终 示例: |