- source
fmgr_vpnsslweb_portal.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- vpnsslweb_portal - Portal. type: dict
- allow_user_access (Alias name: allow-user-access) Allow user access to ssl-vpn applications. type: list choices: [web, ftp, telnet, smb, vnc, rdp, ssh, ping, citrix, portforward, sftp]
more...
Supported Version Ranges:
v6.0.0 -> latest
- auto_connect (Alias name: auto-connect) Enable/disable automatic connect by client when system is up. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- bookmark_group (Alias name: bookmark-group) Bookmark-group. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- bookmarks Bookmarks. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- additional_params (Alias name: additional-params) Additional parameters. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- apptype Application type. type: str choices: [web, telnet, ssh, ftp, smb, vnc, rdp, citrix, rdpnative, portforward, sftp]
more...
Supported Version Ranges:
v6.0.0 -> latest
- description Description. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- folder Network shared file folder parameter. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- form_data (Alias name: form-data) Form-data. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- host Host name/ip parameter. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- listening_port (Alias name: listening-port) Listening port (0 - 65535). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- load_balancing_info (Alias name: load-balancing-info) The load balancing information or cookie which should be provided to the connection broker. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- logon_password (Alias name: logon-password) Logon password. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- logon_user (Alias name: logon-user) Logon user. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Bookmark name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- port Remote port. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- preconnection_blob (Alias name: preconnection-blob) An arbitrary string which identifies the rdp source. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- preconnection_id (Alias name: preconnection-id) The numeric id of the rdp source (0-2147483648). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- remote_port (Alias name: remote-port) Remote port (0 - 65535). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- security Security mode for rdp connection. type: str choices: [rdp, nla, tls, any]
more...
Supported Version Ranges:
v6.0.0 -> latest
- server_layout (Alias name: server-layout) Server side keyboard layout. type: str choices: [en-us-qwerty, de-de-qwertz, fr-fr-azerty, it-it-qwerty, sv-se-qwerty, failsafe, en-gb-qwerty, es-es-qwerty, fr-ch-qwertz, ja-jp-qwerty, pt-br-qwerty, tr-tr-qwerty, fr-ca-qwerty]
more...
Supported Version Ranges:
v6.0.0 -> latest
- show_status_window (Alias name: show-status-window) Enable/disable showing of status window. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sso Single sign-on. type: str choices: [disable, static, auto]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sso_credential (Alias name: sso-credential) Single sign-on credentials. type: str choices: [sslvpn-login, alternative]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sso_credential_sent_once (Alias name: sso-credential-sent-once) Single sign-on credentials are only sent once to remote server. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- sso_password (Alias name: sso-password) Sso password. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- sso_username (Alias name: sso-username) Sso user name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- url Url parameter. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- domain Login domain. type: str
more...
Supported Version Ranges:
v6.4.2 -> latest
- color_depth (Alias name: color-depth) Color depth per pixel. type: str choices: [8, 16, 32]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- height Screen height (range from 0 - 65535, default = 0). type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- keyboard_layout (Alias name: keyboard-layout) Keyboard layout. type: str choices: [ar, da, de, de-ch, en-gb, en-uk, en-us, es, fi, fr, fr-be, fr-ca, fr-ch, hr, hu, it, ja, lt, lv, mk, no, pl, pt, pt-br, ru, sl, sv, tk, tr, fr-ca-m, wg, ar-101, ar-102, ar-102-azerty, can-mul, cz, cz-qwerty, cz-pr, nl, de-ibm, en-uk-ext, en-us-dvorak, es-var, fi-sami, hu-101, it-142, ko, lt-ibm, lt-std, lav-std, lav-leg, mk-std, no-sami, pol-214, pol-pr, pt-br-abnt2, ru-mne, ru-t, sv-sami, tuk, tur-f, tur-q, zh-sym-sg-us, zh-sym-us, zh-tr-hk, zh-tr-mo, zh-tr-us, fr-apple, la-am, ja-106]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- restricted_admin (Alias name: restricted-admin) Enable/disable restricted admin mode for rdp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- send_preconnection_id (Alias name: send-preconnection-id) Enable/disable sending of preconnection id. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- width Screen width (range from 0 - 65535, default = 0). type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- vnc_keyboard_layout (Alias name: vnc-keyboard-layout) Keyboard layout. type: str choices: [da, de, de-ch, en-uk, es, fi, fr, fr-be, it, no, pt, sv, nl, en-uk-ext, it-142, pt-br-abnt2, default, fr-ca-mul, gd, us-intl]
more...
Supported Version Ranges:
v7.2.2 -> latest
- additional_params (Alias name: additional-params) Additional parameters. type: str
more...
- name Bookmark group name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- bookmarks Bookmarks. type: list
more...
- custom_lang (Alias name: custom-lang) Change the web portal display language. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- customize_forticlient_download_url (Alias name: customize-forticlient-download-url) Enable support of customized download url for forticlient. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- display_bookmark (Alias name: display-bookmark) Enable to display the web portal bookmark widget. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- display_connection_tools (Alias name: display-connection-tools) Enable to display the web portal connection tools widget. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- display_history (Alias name: display-history) Enable to display the web portal user login history widget. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- display_status (Alias name: display-status) Enable to display the web portal status widget. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_server1 (Alias name: dns-server1) Ipv4 dns server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_server2 (Alias name: dns-server2) Ipv4 dns server 2. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_suffix (Alias name: dns-suffix) Dns suffix. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- exclusive_routing (Alias name: exclusive-routing) Enable/disable all traffic go through tunnel only. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- forticlient_download (Alias name: forticlient-download) Enable/disable download option for forticlient. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- forticlient_download_method (Alias name: forticlient-download-method) Forticlient download method. type: str choices: [direct, ssl-vpn]
more...
Supported Version Ranges:
v6.0.0 -> latest
- heading Web portal heading message. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- hide_sso_credential (Alias name: hide-sso-credential) Enable to prevent sso credential being sent to client. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- host_check (Alias name: host-check) Type of host checking performed on endpoints. type: str choices: [none, av, fw, av-fw, custom]
more...
Supported Version Ranges:
v6.0.0 -> latest
- host_check_interval (Alias name: host-check-interval) Periodic host check interval. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- host_check_policy (Alias name: host-check-policy) One or more policies to require the endpoint to have specific security software. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip_mode (Alias name: ip-mode) Method by which users of this ssl-vpn tunnel obtain ip addresses. type: str choices: [range, user-group, dhcp, no-ip]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip_pools (Alias name: ip-pools) Ipv4 firewall source address objects reserved for ssl-vpn tunnel mode clients. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_dns_server1 (Alias name: ipv6-dns-server1) Ipv6 dns server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_dns_server2 (Alias name: ipv6-dns-server2) Ipv6 dns server 2. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_exclusive_routing (Alias name: ipv6-exclusive-routing) Enable/disable all ipv6 traffic go through tunnel only. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_pools (Alias name: ipv6-pools) Ipv4 firewall source address objects reserved for ssl-vpn tunnel mode clients. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_service_restriction (Alias name: ipv6-service-restriction) Enable/disable ipv6 tunnel service restriction. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_split_tunneling (Alias name: ipv6-split-tunneling) Enable/disable ipv6 split tunneling. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_split_tunneling_routing_address (Alias name: ipv6-split-tunneling-routing-address) Ipv6 ssl-vpn tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneling access. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_tunnel_mode (Alias name: ipv6-tunnel-mode) Enable/disable ipv6 ssl-vpn tunnel mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_wins_server1 (Alias name: ipv6-wins-server1) Ipv6 wins server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_wins_server2 (Alias name: ipv6-wins-server2) Ipv6 wins server 2. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- keep_alive (Alias name: keep-alive) Enable/disable automatic reconnect for forticlient connections. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- limit_user_logins (Alias name: limit-user-logins) Enable to limit each user to one ssl-vpn session at a time. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_action (Alias name: mac-addr-action) Client mac address action. type: str choices: [deny, allow]
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_check (Alias name: mac-addr-check) Enable/disable mac address host checking. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_check_rule (Alias name: mac-addr-check-rule) Mac-addr-check-rule. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_list (Alias name: mac-addr-list) Client mac address list. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_mask (Alias name: mac-addr-mask) Client mac address mask. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Client mac address check rule name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- mac_addr_list (Alias name: mac-addr-list) Client mac address list. type: list
more...
- macos_forticlient_download_url (Alias name: macos-forticlient-download-url) Download url for mac forticlient. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Portal name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- os_check (Alias name: os-check) Enable to let the fortigate decide action based on client os. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- redir_url (Alias name: redir-url) Client login redirect url. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- save_password (Alias name: save-password) Enable/disable forticlient saving the users password. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- service_restriction (Alias name: service-restriction) Enable/disable tunnel service restriction. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- skip_check_for_unsupported_browser (Alias name: skip-check-for-unsupported-browser) Enable to skip host check if browser does not support it. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- skip_check_for_unsupported_os (Alias name: skip-check-for-unsupported-os) Enable to skip host check if client os does not support it. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- smb_ntlmv1_auth (Alias name: smb-ntlmv1-auth) Enable support of ntlmv1 for samba authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- smbv1 Enable/disable support of smbv1 for samba. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- split_dns (Alias name: split-dns) Split-dns. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_server1 (Alias name: dns-server1) Dns server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_server2 (Alias name: dns-server2) Dns server 2. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- domains Split dns domains used for ssl-vpn clients separated by comma(,). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- id Id. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_dns_server1 (Alias name: ipv6-dns-server1) Ipv6 dns server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ipv6_dns_server2 (Alias name: ipv6-dns-server2) Ipv6 dns server 2. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dns_server1 (Alias name: dns-server1) Dns server 1. type: str
more...
- split_tunneling (Alias name: split-tunneling) Enable/disable ipv4 split tunneling. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- split_tunneling_routing_address (Alias name: split-tunneling-routing-address) Ipv4 ssl-vpn tunnel mode firewall address objects that override firewall policy destination addresses to control split-tunneling access. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- theme Web portal color scheme. type: str choices: [gray, blue, orange, crimson, steelblue, darkgrey, green, melongene, red, mariner, neutrino, jade, graphite, dark-matter, onyx, eclipse, jet-stream, security-fabric]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tunnel_mode (Alias name: tunnel-mode) Enable/disable ipv4 ssl-vpn tunnel mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- user_bookmark (Alias name: user-bookmark) Enable to allow web portal users to create their own bookmarks. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- user_group_bookmark (Alias name: user-group-bookmark) Enable to allow web portal users to create bookmarks for all users in the same user group. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- web_mode (Alias name: web-mode) Enable/disable ssl vpn web mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- windows_forticlient_download_url (Alias name: windows-forticlient-download-url) Download url for windows forticlient. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- wins_server1 (Alias name: wins-server1) Ipv4 wins server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- wins_server2 (Alias name: wins-server2) Ipv4 wins server 1. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- skip_check_for_browser (Alias name: skip-check-for-browser) Enable to skip host check for browser support. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> latest
- smb_max_version (Alias name: smb-max-version) Smb maximum client protocol version. type: str choices: [smbv1, smbv2, smbv3]
more...
Supported Version Ranges:
v6.2.0 -> latest
- smb_min_version (Alias name: smb-min-version) Smb minimum client protocol version. type: str choices: [smbv1, smbv2, smbv3]
more...
Supported Version Ranges:
v6.2.0 -> latest
- virtual_desktop_logout_when_browser_close (Alias name: virtual-desktop-logout-when-browser-close) Enable/disable logout when browser is close in virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_clipboard_share (Alias name: virtual-desktop-clipboard-share) Enable/disable sharing of clipboard in virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_desktop_switch (Alias name: virtual-desktop-desktop-switch) Enable/disable switch to virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop (Alias name: virtual-desktop) Enable/disable ssl vpn virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_network_share_access (Alias name: virtual-desktop-network-share-access) Enable/disable network share access in virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_printing (Alias name: virtual-desktop-printing) Enable/disable printing in virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_app_list (Alias name: virtual-desktop-app-list) Virtual desktop application list. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- virtual_desktop_removable_media_access (Alias name: virtual-desktop-removable-media-access) Enable/disable access to removable media in virtual desktop. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- transform_backward_slashes (Alias name: transform-backward-slashes) Transform backward slashes to forward slashes in urls. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- ipv6_split_tunneling_routing_negate (Alias name: ipv6-split-tunneling-routing-negate) Enable to negate ipv6 split tunneling routing address. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> latest
- split_tunneling_routing_negate (Alias name: split-tunneling-routing-negate) Enable to negate split tunneling routing address. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> latest
- os_check_list (Alias name: os-check-list) type: dict
- action Os check options. type: str choices: [allow, check-up-to-date, deny]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- latest_patch_level (Alias name: latest-patch-level) Latest os patch level. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- name Name. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- tolerance Os patch level tolerance. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- action Os check options. type: str choices: [allow, check-up-to-date, deny]
more...
- use_sdwan (Alias name: use-sdwan) Use sd-wan rules to get output interface. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.7 -> v6.2.12
,v6.4.3 -> latest
- prefer_ipv6_dns (Alias name: prefer-ipv6-dns) Prefer to query ipv6 dns first if enabled. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest
- rewrite_ip_uri_ui (Alias name: rewrite-ip-uri-ui) Rewrite contents for uri contains ip and /ui/. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest
- clipboard Enable to support rdp/vpc clipboard functionality. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- default_window_height (Alias name: default-window-height) Screen height (range from 0 - 65535, default = 768). type: int
more...
Supported Version Ranges:
v7.0.4 -> latest
- default_window_width (Alias name: default-window-width) Screen width (range from 0 - 65535, default = 1024). type: int
more...
Supported Version Ranges:
v7.0.4 -> latest
- dhcp_ip_overlap (Alias name: dhcp-ip-overlap) Configure overlapping dhcp ip allocation assignment. type: str choices: [use-old, use-new]
more...
Supported Version Ranges:
v7.0.4 -> v7.0.12
,v7.2.1 -> latest
- client_src_range (Alias name: client-src-range) Allow client to add source range for the tunnel traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.2 -> latest
- dhcp_ra_giaddr (Alias name: dhcp-ra-giaddr) Relay agent gateway ip address to use in the giaddr field of dhcp requests. type: str
more...
Supported Version Ranges:
v7.2.2 -> latest
- dhcp6_ra_linkaddr (Alias name: dhcp6-ra-linkaddr) Relay agent ipv6 link address to use in dhcp6 requests. type: str
more...
Supported Version Ranges:
v7.2.2 -> latest
- landing_page (Alias name: landing-page) type: dict
- form_data (Alias name: form-data) type: list
more...
Supported Version Ranges:
v7.4.0 -> latest
- logout_url (Alias name: logout-url) Landing page log out url. type: str
more...
Supported Version Ranges:
v7.4.0 -> v7.4.1
- sso Single sign-on. type: str choices: [disable, static, auto]
more...
Supported Version Ranges:
v7.4.0 -> latest
- sso_credential (Alias name: sso-credential) Single sign-on credentials. type: str choices: [sslvpn-login, alternative]
more...
Supported Version Ranges:
v7.4.0 -> latest
- sso_password (Alias name: sso-password) type: list
more...
Supported Version Ranges:
v7.4.0 -> latest
- sso_username (Alias name: sso-username) Sso user name. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- url Landing page url. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- form_data (Alias name: form-data) type: list
more...
- landing_page_mode (Alias name: landing-page-mode) Enable/disable ssl-vpn landing page mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.0 -> latest
- default_protocol (Alias name: default-protocol) Application type that is set by default. type: str choices: [web, ftp, telnet, smb, vnc, rdp, ssh, sftp]
more...
Supported Version Ranges:
v7.4.1 -> latest
- focus_bookmark (Alias name: focus-bookmark) Enable to prioritize the placement of the bookmark section over the quick-connection section in the ssl-vpn application. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.1 -> latest
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and 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>
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]>
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)