fortinet.fortimanager.fmgr_vpnsslweb_portal 模块 – 门户。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在 Playbook 中使用它,请指定:fortinet.fortimanager.fmgr_vpnsslweb_portal
。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,这些参数和值需要在使用前调整为数据源。
参数
参数 |
注释 |
---|---|
在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构不同时设置为 True,模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务的日志记录。 选择
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选择
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选择
|
|
设置的顶级参数。 |
|
允许用户访问 SSL-VPN 应用程序。 选择
|
|
当系统启动时,启用/禁用客户端的自动连接。 选择
|
|
书签组。 |
|
书签。 |
|
附加参数。 |
|
应用程序类型。 选择
|
|
每像素的颜色深度。 选择
|
|
描述。 |
|
登录域。 |
|
网络共享文件文件夹参数。 |
|
表单数据。 |
|
名称。 |
|
值。 |
|
屏幕高度 |
|
主机名/IP 参数。 |
|
键盘布局。 选择
|
|
监听端口 |
|
应提供给连接代理的负载平衡信息或 Cookie。 |
|
(列表)登录密码。 |
|
登录用户。 |
|
书签名称。 |
|
远程端口。 |
|
一个任意字符串,用于标识 RDP 源。 |
|
RDP 源的数字 ID |
|
远程端口 |
|
启用/禁用 RDP 的受限管理员模式。 选择
|
|
RDP 连接的安全模式。 选择
|
|
启用/禁用发送预连接 ID。 选择
|
|
服务器端键盘布局。 选择
|
|
启用/禁用显示状态窗口。 选择
|
|
单点登录。 选择
|
|
单点登录凭据。 选择
|
|
单点登录凭据仅发送一次到远程服务器。 选择
|
|
(列表)SSO 密码。 |
|
SSO 用户名。 |
|
URL 参数。 |
|
键盘布局。 选择
|
|
屏幕宽度 |
|
书签组名称。 |
|
允许客户端为隧道流量添加源范围。 选择
|
|
启用以支持 RDP/VPC 剪贴板功能。 选择
|
|
更改 Web 门户显示语言。 |
|
启用对 FortiClient 自定义下载 URL 的支持。 选择
|
|
默认设置的应用程序类型。 选择
|
|
屏幕高度 |
|
屏幕宽度 |
|
用于 DHCP6 请求的中继代理 IPv6 链路地址。 |
|
配置重叠的 DHCP IP 分配。 选择
|
|
用于 DHCP 请求的 giaddr 字段中的中继代理网关 IP 地址。 |
|
启用/禁用 DHCP 预留。 选择
|
|
启用以显示 Web 门户书签小部件。 选择
|
|
启用以显示 Web 门户连接工具小部件。 选择
|
|
启用以显示 Web 门户用户登录历史记录小部件。 选择
|
|
启用以显示 Web 门户状态小部件。 选择
|
|
IPv4 DNS 服务器 1。 |
|
IPv4 DNS 服务器 2。 |
|
DNS 后缀。 |
|
启用/禁用所有流量仅通过隧道。 选择
|
|
启用以在 SSL-VPN 应用程序中优先放置书签部分,而不是快速连接部分。 选择
|
|
启用/禁用 FortiClient 的下载选项。 选择
|
|
FortiClient 下载方式。 选择
|
|
Web 门户标题消息。 |
|
启用以防止 SSO 凭据发送到客户端。 选择
|
|
在端点上执行的主机检查类型。 选择
|
|
定期主机检查间隔。 |
|
(列表或字符串)一个或多个策略,要求端点具有特定的安全软件。 |
|
此 SSL-VPN 隧道的用户获取 IP 地址的方法。 选择
|
|
(列表或字符串)为 SSL-VPN 隧道模式客户端保留的 IPv4 防火墙源地址对象。 |
|
IPv6 DNS 服务器 1。 |
|
IPv6 DNS 服务器 2。 |
|
启用/禁用所有 IPv6 流量仅通过隧道。 选择
|
|
(列表或字符串)为 SSL-VPN 隧道模式客户端保留的 IPv4 防火墙源地址对象。 |
|
启用/禁用 IPv6 隧道服务限制。 选择
|
|
启用/禁用 IPv6 分割隧道。 选择
|
|
(列表或字符串)覆盖防火墙策略目标地址的 IPv6 SSL-VPN 隧道模式防火墙地址对象... |
|
启用以取反 IPv6 分割隧道路由地址。 选择
|
|
启用/禁用 IPv6 SSL-VPN 隧道模式。 选择
|
|
IPv6 WINS 服务器 1。 |
|
IPv6 WINS 服务器 2。 |
|
启用/禁用 FortiClient 连接的自动重连。 选择
|
|
登录页面。 |
|
表单数据。 |
|
名称。 |
|
值。 |
|
登录页面注销 URL。 |
|
单点登录。 选择
|
|
单点登录凭据。 选择
|
|
(列表)SSO 密码。 |
|
SSO 用户名。 |
|
登录页面 URL。 |
|
启用/禁用 SSL-VPN 登录页面模式。 选择
|
|
启用后,限制每个用户一次只能使用一个 SSL-VPN 会话。 选择
|
|
客户端 MAC 地址操作。 选择
|
|
启用/禁用 MAC 地址主机检查。 选择
|
|
MAC 地址检查规则。 |
|
(列表) 客户端 MAC 地址列表。 |
|
客户端 MAC 地址掩码。 |
|
客户端 MAC 地址检查规则名称。 |
|
Mac FortiClient 的下载 URL。 |
|
门户名称。 |
|
启用后,允许 FortiGate 根据客户端操作系统决定操作。 选择
|
|
操作系统检查列表。 |
|
操作系统检查选项。 选择
|
|
最新的操作系统补丁级别。 |
|
次版本号。 |
|
名称。 |
|
操作系统补丁级别容差。 |
|
如果启用,则优先查询 IPv6 DNS。 选择
|
|
客户端登录重定向 URL。 |
|
重写包含 IP 和 /ui/ 的 URI 的内容。 选择
|
|
启用/禁用 FortiClient 保存用户密码。 选择
|
|
启用/禁用隧道服务限制。 选择
|
|
启用后,跳过对浏览器支持的主机检查。 选择
|
|
如果浏览器不支持,则启用后跳过主机检查。 选择
|
|
如果客户端操作系统不支持,则启用后跳过主机检查。 选择
|
|
SMB 最大客户端协议版本。 选择
|
|
SMB 最小客户端协议版本。 选择
|
|
启用对 Samba 身份验证的 NTLMv1 支持。 选择
|
|
启用/禁用对 Samba 的 SMBv1 支持。 选择
|
|
拆分 DNS。 |
|
DNS 服务器 1。 |
|
DNS 服务器 2。 |
|
用于 SSL-VPN 客户端的拆分 DNS 域,以逗号分隔 |
|
ID。 |
|
IPv6 DNS 服务器 1。 |
|
IPv6 DNS 服务器 2。 |
|
启用/禁用 IPv4 拆分隧道。 选择
|
|
(列表或字符串) IPv4 SSL-VPN 隧道模式防火墙地址对象,用于覆盖防火墙策略目标地址以连接到… |
|
启用后,否定拆分隧道路由地址。 选择
|
|
Web 门户配色方案。 选择
|
|
将 URL 中的反斜杠转换为正斜杠。 选择
|
|
启用/禁用 IPv4 SSL-VPN 隧道模式。 选择
|
|
使用 SD-WAN 规则获取输出接口。 选择
|
|
启用后,允许 Web 门户用户创建自己的书签。 选择
|
|
启用后,允许 Web 门户用户为同一用户组中的所有用户创建书签。 选择
|
|
启用/禁用 SSL VPN 虚拟桌面。 选择
|
|
虚拟桌面应用程序列表。 |
|
启用/禁用虚拟桌面中的剪贴板共享。 选择
|
|
启用/禁用切换到虚拟桌面。 选择
|
|
启用/禁用在虚拟桌面中关闭浏览器时注销。 选择
|
|
启用/禁用虚拟桌面中的网络共享访问。 选择
|
|
启用/禁用虚拟桌面中的打印功能。 选择
|
|
启用/禁用虚拟桌面中对可移动媒体的访问。 选择
|
|
启用/禁用 SSL VPN Web 模式。 选择
|
|
Windows FortiClient 的下载 URL。 |
|
IPv4 WINS 服务器 1。 |
|
IPv4 WINS 服务器 1。 |
|
在工作区模式下运行的 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: Portal.
fortinet.fortimanager.fmgr_vpnsslweb_portal:
# 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]>
vpnsslweb_portal:
allow_user_access:
- "web"
- "ftp"
- "telnet"
- "smb"
- "vnc"
- "rdp"
- "ssh"
- "ping"
- "citrix"
- "portforward"
- "sftp"
auto_connect: <value in [disable, enable]>
bookmark_group:
-
bookmarks:
-
additional_params: <string>
apptype: <value in [web, telnet, ssh, ...]>
description: <string>
folder: <string>
form_data:
-
name: <string>
value: <string>
host: <string>
listening_port: <integer>
load_balancing_info: <string>
logon_password: <list or string>
logon_user: <string>
name: <string>
port: <integer>
preconnection_blob: <string>
preconnection_id: <integer>
remote_port: <integer>
security: <value in [rdp, nla, tls, ...]>
server_layout: <value in [en-us-qwerty, de-de-qwertz, fr-fr-azerty, ...]>
show_status_window: <value in [disable, enable]>
sso: <value in [disable, static, auto]>
sso_credential: <value in [sslvpn-login, alternative]>
sso_credential_sent_once: <value in [disable, enable]>
sso_password: <list or string>
sso_username: <string>
url: <string>
domain: <string>
color_depth: <value in [8, 16, 32]>
height: <integer>
keyboard_layout: <value in [ar, da, de, ...]>
restricted_admin: <value in [disable, enable]>
send_preconnection_id: <value in [disable, enable]>
width: <integer>
vnc_keyboard_layout: <value in [da, de, de-ch, ...]>
name: <string>
custom_lang: <string>
customize_forticlient_download_url: <value in [disable, enable]>
display_bookmark: <value in [disable, enable]>
display_connection_tools: <value in [disable, enable]>
display_history: <value in [disable, enable]>
display_status: <value in [disable, enable]>
dns_server1: <string>
dns_server2: <string>
dns_suffix: <string>
exclusive_routing: <value in [disable, enable]>
forticlient_download: <value in [disable, enable]>
forticlient_download_method: <value in [direct, ssl-vpn]>
heading: <string>
hide_sso_credential: <value in [disable, enable]>
host_check: <value in [none, av, fw, ...]>
host_check_interval: <integer>
host_check_policy: <list or string>
ip_mode: <value in [range, user-group, dhcp, ...]>
ip_pools: <list or string>
ipv6_dns_server1: <string>
ipv6_dns_server2: <string>
ipv6_exclusive_routing: <value in [disable, enable]>
ipv6_pools: <list or string>
ipv6_service_restriction: <value in [disable, enable]>
ipv6_split_tunneling: <value in [disable, enable]>
ipv6_split_tunneling_routing_address: <list or string>
ipv6_tunnel_mode: <value in [disable, enable]>
ipv6_wins_server1: <string>
ipv6_wins_server2: <string>
keep_alive: <value in [disable, enable]>
limit_user_logins: <value in [disable, enable]>
mac_addr_action: <value in [deny, allow]>
mac_addr_check: <value in [disable, enable]>
mac_addr_check_rule:
-
mac_addr_list: <list or string>
mac_addr_mask: <integer>
name: <string>
macos_forticlient_download_url: <string>
name: <string>
os_check: <value in [disable, enable]>
redir_url: <string>
save_password: <value in [disable, enable]>
service_restriction: <value in [disable, enable]>
skip_check_for_unsupported_browser: <value in [disable, enable]>
skip_check_for_unsupported_os: <value in [disable, enable]>
smb_ntlmv1_auth: <value in [disable, enable]>
smbv1: <value in [disable, enable]>
split_dns:
-
dns_server1: <string>
dns_server2: <string>
domains: <string>
id: <integer>
ipv6_dns_server1: <string>
ipv6_dns_server2: <string>
split_tunneling: <value in [disable, enable]>
split_tunneling_routing_address: <list or string>
theme: <value in [gray, blue, orange, ...]>
tunnel_mode: <value in [disable, enable]>
user_bookmark: <value in [disable, enable]>
user_group_bookmark: <value in [disable, enable]>
web_mode: <value in [disable, enable]>
windows_forticlient_download_url: <string>
wins_server1: <string>
wins_server2: <string>
skip_check_for_browser: <value in [disable, enable]>
smb_max_version: <value in [smbv1, smbv2, smbv3]>
smb_min_version: <value in [smbv1, smbv2, smbv3]>
virtual_desktop_logout_when_browser_close: <value in [disable, enable]>
virtual_desktop_clipboard_share: <value in [disable, enable]>
virtual_desktop_desktop_switch: <value in [disable, enable]>
virtual_desktop: <value in [disable, enable]>
virtual_desktop_network_share_access: <value in [disable, enable]>
virtual_desktop_printing: <value in [disable, enable]>
virtual_desktop_app_list: <string>
virtual_desktop_removable_media_access: <value in [disable, enable]>
transform_backward_slashes: <value in [disable, enable]>
ipv6_split_tunneling_routing_negate: <value in [disable, enable]>
split_tunneling_routing_negate: <value in [disable, enable]>
os_check_list:
action: <value in [allow, check-up-to-date, deny]>
latest_patch_level: <string>
name: <string>
tolerance: <integer>
minor_version: <integer>
use_sdwan: <value in [disable, enable]>
prefer_ipv6_dns: <value in [disable, enable]>
rewrite_ip_uri_ui: <value in [disable, enable]>
clipboard: <value in [disable, enable]>
default_window_height: <integer>
default_window_width: <integer>
dhcp_ip_overlap: <value in [use-old, use-new]>
client_src_range: <value in [disable, enable]>
dhcp_ra_giaddr: <string>
dhcp6_ra_linkaddr: <string>
landing_page:
form_data:
-
name: <string>
value: <string>
logout_url: <string>
sso: <value in [disable, static, auto]>
sso_credential: <value in [sslvpn-login, alternative]>
sso_password: <list or string>
sso_username: <string>
url: <string>
landing_page_mode: <value in [disable, enable]>
default_protocol: <value in [web, ftp, telnet, ...]>
focus_bookmark: <value in [disable, enable]>
dhcp_reservation: <value in [disable, enable]>
返回值
常见返回值已在此处记录 这里,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回值: 始终 |
|
请求的完整 URL。 返回值: 始终 示例: |
|
API 请求的状态。 返回值: 始终 示例: |
|
API 响应。 返回值: 始终 |
|
API 响应的描述性消息。 返回值: 始终 示例: |
|
目标系统的信息。 返回值: 始终 |
|
请求的状态。 返回值: 始终 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。 返回值: 复杂 |