fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway 模块 – 设置 API 网关。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway。
fortinet.fortimanager 2.1.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
已弃用，请使用“access_proxy” |
|
请求 URL 中的参数 (access-proxy)。 |
|
无需用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
(列表) 此访问代理控制的 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 真实服务器主机密钥验证。 选项
|
|
将真实服务器的状态设置为活动状态，以便它可以接受流量，或者设置为备用或禁用状态，以便没有流量…… 选项
|
|
启用/禁用将主机名/IP 从虚拟服务器转换到真实服务器。 选项
|
|
隧道加密。 选项
|
|
TCP转发服务器类型。 选项
|
|
真实服务器的权重。 |
|
启用/禁用成功身份验证后的 SAML 重定向。 选项
|
|
用于 VIP 身份验证的 SAML 服务提供商配置。 |
|
服务。 选项
|
|
根据加密强度，允许用于 SSL 全模式会话服务器端的加密算法。 选项
|
|
SSL 密码套件。 |
|
密码套件名称。 选项
|
|
SSL/TLS 密码套件优先级。 |
|
密码套件可以使用的 SSL/TLS 版本。 选项
|
|
在用于 RSA 加密的 SSL 会话的 Diffie-Hellman 交换中使用的位数。 选项
|
|
从服务器接受的最高 SSL/TLS 版本。 选项
|
|
从服务器接受的最低 SSL/TLS 版本。 选项
|
|
启用/禁用安全重新协商以符合 RFC 5746。 选项
|
|
SSL-VPN 网页门户。 |
|
要匹配的 URL 模式。 |
|
url-map 的类型。 选项
|
|
虚拟主机。 |
|
使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是全局和其他值，包括 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: Set API Gateway.
fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway:
# 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>
access_proxy: <your own value>
state: present # <value in [present, absent]>
firewall_accessproxy_apigateway:
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:
-
address: <string>
health_check: <value in [disable, enable]>
health_check_proto: <value in [ping, http, tcp-connect]>
http_host: <string>
id: <integer>
ip: <string>
mappedport: <list or string>
port: <integer>
status: <value in [active, standby, disable]>
weight: <integer>
addr_type: <value in [fqdn, ip]>
domain: <string>
holddown_interval: <value in [disable, enable]>
ssh_client_cert: <string>
ssh_host_key: <list or string>
ssh_host_key_validation: <value in [disable, enable]>
type: <value in [tcp-forwarding, ssh]>
translate_host: <value in [disable, enable]>
external_auth: <value in [disable, enable]>
tunnel_encryption: <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, ...]>
url_map: <string>
url_map_type: <value in [sub-string, wildcard, regex]>
virtual_host: <string>
saml_redirect: <value in [disable, enable]>
ssl_vpn_web_portal: <string>
application: <list or 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>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂 |