fortinet.fortimanager.fmgr_firewall_accessproxy6 模块 – 配置 IPv6 访问代理。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定: fortinet.fortimanager.fmgr_firewall_accessproxy6
。
fortinet.fortimanager 2.2.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,这些参数和值需要在使用前调整为数据源。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构不同时设置为 True,模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
启用/禁用为 ztna dox 隧道将 vhost/域添加到 dnsdb。 选项
|
|
API 网关。 |
|
(列表) 由此访问代理控制的 SaaS 应用程序。 |
|
HTTP2 支持,默认=启用。 选项
|
|
HTTP3/QUIC 支持,默认=禁用。 选项
|
|
客户端 Web 浏览器应保留 cookie 的分钟数。 |
|
HTTP cookie 持久性应应用于的域。 |
|
启用/禁用使用 HTTP 中主机字段的 HTTP cookie 域。 选项
|
|
要接受的 HTTP cookie 的生成。 |
|
将 HTTP cookie 持久性限制为指定的路径。 |
|
控制跨 API 网关共享 cookie。 选项
|
|
启用/禁用对插入的 HTTPS cookie 是否安全的验证。 选项
|
|
API 网关 ID。 |
|
用于将会话分配到真实服务器的方法。 选项
|
|
配置如何确保客户端每次发出属于 … 的请求时都连接到同一服务器 选项
|
|
Quic。 |
|
ACK 延迟指数 |
|
活动连接 ID 限制 |
|
启用/禁用活动迁移 选项
|
|
启用/禁用 grease QUIC 位 选项
|
|
最大 ACK 延迟(毫秒) |
|
最大数据报帧大小(字节) |
|
最大空闲超时时间(毫秒) |
|
最大 UDP 有效负载大小(字节) |
|
真实服务器。 |
|
地址类型。 选项
|
|
真实服务器的地址或地址组。 |
|
真实服务器的通配符域名。 |
|
启用/禁用使用外部浏览器作为 SAML 用户身份验证的用户代理。 选项
|
|
启用此项可在转发流量之前检查真实服务器的响应能力。 选项
|
|
在轮询以确定服务器连接状态时要使用的运行状况检查监视器的协议。 选项
|
|
启用/禁用保持计时器。 选项
|
|
HTTP 标头中的 HTTP 服务器域名。 |
|
真实服务器 ID。 |
|
真实服务器的 IP 地址。 |
|
(列表或字符串)用于与真实服务器通信的端口。 |
|
用于与真实服务器通信的端口。 |
|
设置访问代理 SSH 客户端证书配置文件。 |
|
(列表)一个或多个服务器主机密钥。 |
|
启用/禁用 SSH 真实服务器主机密钥验证。 选项
|
|
将真实服务器的状态设置为 active 以便它可以接受流量,或者设置为 standby 或 disabled 以便不接受流量... 选项
|
|
启用/禁用将主机名/IP 从虚拟服务器转换为真实服务器。 选项
|
|
隧道加密。 选项
|
|
TCP 转发服务器类型。 选项
|
|
真实服务器的权重。 |
|
启用/禁用身份验证成功后的 SAML 重定向。 选项
|
|
用于 VIP 身份验证的 SAML 服务提供商配置。 |
|
服务。 选项
|
|
根据加密强度,允许用于 SSL 全模式会话服务器端的加密算法。 选项
|
|
SSL 密码套件。 |
|
密码套件名称。 选项
|
|
SSL/TLS 密码套件优先级。 |
|
该密码套件可使用的 SSL/TLS 版本。 选项
|
|
在 SSL 会话的 RSA 加密中,用于 Diffie-Hellman 交换的位数。 选项
|
|
服务器可接受的最高 SSL/TLS 版本。 选项
|
|
服务器可接受的最低 SSL/TLS 版本。 选项
|
|
启用/禁用安全重新协商以符合 RFC 5746。 选项
|
|
SSL-VPN Web 门户。 |
|
要匹配的 URL 模式。 |
|
url-map 的类型。 选项
|
|
虚拟主机。 |
|
Api gateway6。 |
|
(列表) 由此访问代理控制的 SaaS 应用程序。 |
|
HTTP2 支持,默认=启用。 选项
|
|
HTTP3/QUIC 支持,默认=禁用。 选项
|
|
客户端 Web 浏览器应保留 cookie 的分钟数。 |
|
HTTP cookie 持久性应应用于的域。 |
|
启用/禁用使用 HTTP 中主机字段的 HTTP cookie 域。 选项
|
|
要接受的 HTTP cookie 的生成。 |
|
将 HTTP cookie 持久性限制为指定的路径。 |
|
控制跨 API 网关共享 cookie。 选项
|
|
启用/禁用对插入的 HTTPS cookie 是否安全的验证。 选项
|
|
API 网关 ID。 |
|
用于将会话分配到真实服务器的方法。 选项
|
|
配置如何确保客户端每次发出属于 … 的请求时都连接到同一服务器 选项
|
|
Quic。 |
|
ACK 延迟指数 |
|
活动连接 ID 限制 |
|
启用/禁用活动迁移 选项
|
|
启用/禁用 grease QUIC 位 选项
|
|
最大 ACK 延迟(毫秒) |
|
最大数据报帧大小(字节) |
|
最大空闲超时时间(毫秒) |
|
最大 UDP 有效负载大小(字节) |
|
真实服务器。 |
|
地址类型。 选项
|
|
真实服务器的地址或地址组。 |
|
真实服务器的通配符域名。 |
|
启用/禁用使用外部浏览器作为 SAML 用户身份验证的用户代理。 选项
|
|
启用此项可在转发流量之前检查真实服务器的响应能力。 选项
|
|
在轮询以确定服务器连接状态时要使用的运行状况检查监视器的协议。 选项
|
|
启用/禁用保持计时器。 选项
|
|
HTTP 标头中的 HTTP 服务器域名。 |
|
真实服务器 ID。 |
|
真实服务器的 IPv6 地址。 |
|
(列表或字符串)用于与真实服务器通信的端口。 |
|
用于与真实服务器通信的端口。 |
|
设置访问代理 SSH 客户端证书配置文件。 |
|
(列表)一个或多个服务器主机密钥。 |
|
启用/禁用 SSH 真实服务器主机密钥验证。 选项
|
|
将真实服务器的状态设置为 active 以便它可以接受流量,或者设置为 standby 或 disabled 以便不接受流量... 选项
|
|
启用/禁用将主机名/IP 从虚拟服务器转换为真实服务器。 选项
|
|
隧道加密。 选项
|
|
TCP 转发服务器类型。 选项
|
|
真实服务器的权重。 |
|
启用/禁用身份验证成功后的 SAML 重定向。 选项
|
|
用于 VIP 身份验证的 SAML 服务提供商配置。 |
|
服务。 选项
|
|
根据加密强度,允许用于 SSL 全模式会话服务器端的加密算法。 选项
|
|
SSL 密码套件。 |
|
密码套件名称。 选项
|
|
SSL/TLS 密码套件优先级。 |
|
该密码套件可使用的 SSL/TLS 版本。 选项
|
|
在 SSL 会话的 RSA 加密中,用于 Diffie-Hellman 交换的位数。 选项
|
|
服务器可接受的最高 SSL/TLS 版本。 选项
|
|
服务器可接受的最低 SSL/TLS 版本。 选项
|
|
启用/禁用安全重新协商以符合 RFC 5746。 选项
|
|
SSL-VPN Web 门户。 |
|
要匹配的 URL 模式。 |
|
url-map 的类型。 选项
|
|
虚拟主机。 |
|
启用/禁用身份验证门户。 选项
|
|
身份验证门户的虚拟主机。 |
|
启用/禁用请求客户端证书。 选项
|
|
解密流量镜像。 |
|
空客户端证书的操作。 选项
|
|
最大支持的 HTTP 版本。 选项
|
|
启用/禁用阻止流量的日志记录。 选项
|
|
访问代理名称。 |
|
启用/禁用服务器池多路复用。 选项
|
|
服务器池中服务器可以处理的最大并发请求数 |
|
服务器池中的服务器在断开连接之前处理的最大请求数 |
|
服务器池中与服务器的空闲连接的生存时间。 |
|
启用/禁用通过 HTTP user-agent 检测设备类型(如果没有提供客户端证书)。 选项
|
|
虚拟 IP 名称。 |
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的重写方法。 选项
|
|
用于覆盖失败条件的返回码列表。 |
|
用于覆盖成功条件的返回码列表。 |
|
用于创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM,该值可以是 global 和其他值,包括 root。 |
|
等待其他用户释放工作区锁定的最长时间(秒)。 默认值: |
注释
注意
从 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: Configure IPv6 access proxy.
fortinet.fortimanager.fmgr_firewall_accessproxy6:
# 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_accessproxy6:
add_vhost_domain_to_dnsdb: <value in [disable, enable]>
api_gateway:
-
application: <list or string>
http_cookie_age: <integer>
http_cookie_domain: <string>
http_cookie_domain_from_host: <value in [disable, enable]>
http_cookie_generation: <integer>
http_cookie_path: <string>
http_cookie_share: <value in [disable, same-ip]>
https_cookie_secure: <value in [disable, enable]>
id: <integer>
ldb_method: <value in [static, round-robin, weighted, ...]>
persistence: <value in [none, http-cookie]>
realservers:
-
addr_type: <value in [fqdn, ip]>
address: <string>
domain: <string>
health_check: <value in [disable, enable]>
health_check_proto: <value in [ping, http, tcp-connect]>
holddown_interval: <value in [disable, enable]>
http_host: <string>
id: <integer>
ip: <string>
mappedport: <list or string>
port: <integer>
ssh_client_cert: <string>
ssh_host_key: <list or string>
ssh_host_key_validation: <value in [disable, enable]>
status: <value in [active, standby, disable]>
type: <value in [tcp-forwarding, ssh]>
weight: <integer>
translate_host: <value in [disable, enable]>
external_auth: <value in [disable, enable]>
tunnel_encryption: <value in [disable, enable]>
saml_redirect: <value in [disable, enable]>
saml_server: <string>
service: <value in [http, https, tcp-forwarding, ...]>
ssl_algorithm: <value in [high, medium, low]>
ssl_cipher_suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
priority: <integer>
versions:
- "tls-1.0"
- "tls-1.1"
- "tls-1.2"
- "tls-1.3"
ssl_dh_bits: <value in [768, 1024, 1536, ...]>
ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl_vpn_web_portal: <string>
url_map: <string>
url_map_type: <value in [sub-string, wildcard, regex]>
virtual_host: <string>
ssl_renegotiation: <value in [disable, enable]>
h2_support: <value in [disable, enable]>
h3_support: <value in [disable, enable]>
quic:
ack_delay_exponent: <integer>
active_connection_id_limit: <integer>
active_migration: <value in [disable, enable]>
grease_quic_bit: <value in [disable, enable]>
max_ack_delay: <integer>
max_datagram_frame_size: <integer>
max_idle_timeout: <integer>
max_udp_payload_size: <integer>
api_gateway6:
-
application: <list or string>
http_cookie_age: <integer>
http_cookie_domain: <string>
http_cookie_domain_from_host: <value in [disable, enable]>
http_cookie_generation: <integer>
http_cookie_path: <string>
http_cookie_share: <value in [disable, same-ip]>
https_cookie_secure: <value in [disable, enable]>
id: <integer>
ldb_method: <value in [static, round-robin, weighted, ...]>
persistence: <value in [none, http-cookie]>
realservers:
-
addr_type: <value in [fqdn, ip]>
address: <string>
domain: <string>
health_check: <value in [disable, enable]>
health_check_proto: <value in [ping, http, tcp-connect]>
holddown_interval: <value in [disable, enable]>
http_host: <string>
id: <integer>
ip: <string>
mappedport: <list or string>
port: <integer>
ssh_client_cert: <string>
ssh_host_key: <list or string>
ssh_host_key_validation: <value in [disable, enable]>
status: <value in [active, standby, disable]>
type: <value in [tcp-forwarding, ssh]>
weight: <integer>
translate_host: <value in [disable, enable]>
external_auth: <value in [disable, enable]>
tunnel_encryption: <value in [disable, enable]>
saml_redirect: <value in [disable, enable]>
saml_server: <string>
service: <value in [http, https, tcp-forwarding, ...]>
ssl_algorithm: <value in [high, medium, low]>
ssl_cipher_suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
priority: <integer>
versions:
- "tls-1.0"
- "tls-1.1"
- "tls-1.2"
- "tls-1.3"
ssl_dh_bits: <value in [768, 1024, 1536, ...]>
ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
ssl_vpn_web_portal: <string>
url_map: <string>
url_map_type: <value in [sub-string, wildcard, regex]>
virtual_host: <string>
ssl_renegotiation: <value in [disable, enable]>
h2_support: <value in [disable, enable]>
h3_support: <value in [disable, enable]>
quic:
ack_delay_exponent: <integer>
active_connection_id_limit: <integer>
active_migration: <value in [disable, enable]>
grease_quic_bit: <value in [disable, enable]>
max_ack_delay: <integer>
max_datagram_frame_size: <integer>
max_idle_timeout: <integer>
max_udp_payload_size: <integer>
auth_portal: <value in [disable, enable]>
auth_virtual_host: <string>
client_cert: <value in [disable, enable]>
decrypted_traffic_mirror: <string>
empty_cert_action: <value in [block, accept, accept-unmanageable]>
log_blocked_traffic: <value in [disable, enable]>
name: <string>
user_agent_detect: <value in [disable, enable]>
vip: <string>
http_supported_max_version: <value in [http1, http2]>
svr_pool_multiplex: <value in [disable, enable]>
svr_pool_server_max_request: <integer>
svr_pool_ttl: <integer>
svr_pool_server_max_concurrent_request: <integer>
返回值
常见返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。 返回: 复杂 |