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隧道模式防火墙地址对象。 |
|
启用此功能可否定拆分隧道路由地址。 选项
|
|
网页门户配色方案。 选项
|
|
将URL中的反斜杠转换为正斜杠。 选项
|
|
启用/禁用IPv4 SSL-VPN隧道模式。 选项
|
|
使用SD-WAN规则获取输出接口。 选项
|
|
启用此功能可允许网页门户用户创建自己的书签。 选项
|
|
启用此功能可允许网页门户用户为同一用户组中的所有用户创建书签。 选项
|
|
启用/禁用SSL VPN虚拟桌面。 选项
|
|
虚拟桌面应用程序列表。 |
|
启用/禁用在虚拟桌面中共享剪贴板。 选项
|
|
启用/禁用切换到虚拟桌面。 选项
|
|
启用/禁用在虚拟桌面中关闭浏览器时注销。 选项
|
|
启用/禁用在虚拟桌面中访问网络共享。 选项
|
|
启用/禁用在虚拟桌面中打印。 选项
|
|
启用/禁用在虚拟桌面中访问可移动介质。 选项
|
|
启用/禁用SSL VPN网页模式。 选项
|
|
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 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回: complex |