Try SpotterPortal.
| "added in version" 2.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Portal.
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: <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: <value of string>
apptype: <value in [web, telnet, ssh, ...]>
description: <value of string>
folder: <value of string>
form-data:
-
name: <value of string>
value: <value of string>
host: <value of string>
listening-port: <value of integer>
load-balancing-info: <value of string>
logon-password: <value of string>
logon-user: <value of string>
name: <value of string>
port: <value of integer>
preconnection-blob: <value of string>
preconnection-id: <value of integer>
remote-port: <value of 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: <value of string>
sso-username: <value of string>
url: <value of string>
domain: <value of string>
color-depth: <value in [8, 16, 32]>
height: <value of integer>
keyboard-layout: <value in [ar, da, de, ...]>
restricted-admin: <value in [disable, enable]>
send-preconnection-id: <value in [disable, enable]>
width: <value of integer>
vnc-keyboard-layout: <value in [da, de, de-ch, ...]>
name: <value of string>
custom-lang: <value of 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: <value of string>
dns-server2: <value of string>
dns-suffix: <value of string>
exclusive-routing: <value in [disable, enable]>
forticlient-download: <value in [disable, enable]>
forticlient-download-method: <value in [direct, ssl-vpn]>
heading: <value of string>
hide-sso-credential: <value in [disable, enable]>
host-check: <value in [none, av, fw, ...]>
host-check-interval: <value of integer>
host-check-policy: <value of string>
ip-mode: <value in [range, user-group, dhcp, ...]>
ip-pools: <value of string>
ipv6-dns-server1: <value of string>
ipv6-dns-server2: <value of string>
ipv6-exclusive-routing: <value in [disable, enable]>
ipv6-pools: <value of string>
ipv6-service-restriction: <value in [disable, enable]>
ipv6-split-tunneling: <value in [disable, enable]>
ipv6-split-tunneling-routing-address: <value of string>
ipv6-tunnel-mode: <value in [disable, enable]>
ipv6-wins-server1: <value of string>
ipv6-wins-server2: <value of 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: <value of string>
mac-addr-mask: <value of integer>
name: <value of string>
macos-forticlient-download-url: <value of string>
name: <value of string>
os-check: <value in [disable, enable]>
redir-url: <value of 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: <value of string>
dns-server2: <value of string>
domains: <value of string>
id: <value of integer>
ipv6-dns-server1: <value of string>
ipv6-dns-server2: <value of string>
split-tunneling: <value in [disable, enable]>
split-tunneling-routing-address: <value of 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: <value of string>
wins-server1: <value of string>
wins-server2: <value of 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: <value of 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: <value of string>
name: <value of string>
tolerance: <value of 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: <value of integer>
default-window-width: <value of integer>
dhcp-ip-overlap: <value in [use-old, use-new]>
client-src-range: <value in [disable, enable]>
dhcp-ra-giaddr: <value of string>
dhcp6-ra-linkaddr: <value of string>
landing-page:
form-data:
-
name: <value of string>
value: <value of string>
logout-url: <value of string>
sso: <value in [disable, static, auto]>
sso-credential: <value in [sslvpn-login, alternative]>
sso-password: <value of string>
sso-username: <value of string>
url: <value of string>
landing-page-mode: <value in [disable, enable]>
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
vpnsslweb_portal:
description: the top level parameters set
required: false
suboptions:
allow-user-access:
choices:
- web
- ftp
- telnet
- smb
- vnc
- rdp
- ssh
- ping
- citrix
- portforward
- sftp
description: Allow user access to SSL-VPN applications.
elements: str
type: list
auto-connect:
choices:
- disable
- enable
description: Enable/disable automatic connect by client when system is up.
type: str
bookmark-group:
description: Bookmark-Group.
elements: dict
suboptions:
bookmarks:
description: Bookmarks.
elements: dict
suboptions:
additional-params:
description: Additional parameters.
type: str
apptype:
choices:
- web
- telnet
- ssh
- ftp
- smb
- vnc
- rdp
- citrix
- rdpnative
- portforward
- sftp
description: Application type.
type: str
color-depth:
choices:
- '8'
- '16'
- '32'
description: Color depth per pixel.
type: str
description:
description: Description.
type: str
domain:
description: Login domain.
type: str
folder:
description: Network shared file folder parameter.
type: str
form-data:
description: Form-Data.
elements: dict
suboptions:
name:
description: Name.
type: str
value:
description: Value.
type: str
type: list
height:
description: Screen height
type: int
host:
description: Host name/IP parameter.
type: str
keyboard-layout:
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
description: Keyboard layout.
type: str
listening-port:
description: Listening port
type: int
load-balancing-info:
description: The load balancing information or cookie which should be
provided to the connection broker.
type: str
logon-password:
description: Logon password.
type: str
logon-user:
description: Logon user.
type: str
name:
description: Bookmark name.
type: str
port:
description: Remote port.
type: int
preconnection-blob:
description: An arbitrary string which identifies the RDP source.
type: str
preconnection-id:
description: The numeric ID of the RDP source
type: int
remote-port:
description: Remote port
type: int
restricted-admin:
choices:
- disable
- enable
description: Enable/disable restricted admin mode for RDP.
type: str
security:
choices:
- rdp
- nla
- tls
- any
description: Security mode for RDP connection.
type: str
send-preconnection-id:
choices:
- disable
- enable
description: Enable/disable sending of preconnection ID.
type: str
server-layout:
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
description: Server side keyboard layout.
type: str
show-status-window:
choices:
- disable
- enable
description: Enable/disable showing of status window.
type: str
sso:
choices:
- disable
- static
- auto
description: Single Sign-On.
type: str
sso-credential:
choices:
- sslvpn-login
- alternative
description: Single sign-on credentials.
type: str
sso-credential-sent-once:
choices:
- disable
- enable
description: Single sign-on credentials are only sent once to remote server.
type: str
sso-password:
description: SSO password.
type: str
sso-username:
description: SSO user name.
type: str
url:
description: URL parameter.
type: str
vnc-keyboard-layout:
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
description: Keyboard layout.
type: str
width:
description: Screen width
type: int
type: list
name:
description: Bookmark group name.
type: str
type: list
client-src-range:
choices:
- disable
- enable
description: Allow client to add source range for the tunnel traffic.
type: str
clipboard:
choices:
- disable
- enable
description: Enable to support RDP/VPC clipboard functionality.
type: str
custom-lang:
description: Change the web portal display language.
type: str
customize-forticlient-download-url:
choices:
- disable
- enable
description: Enable support of customized download URL for FortiClient.
type: str
default-window-height:
description: Screen height
type: int
default-window-width:
description: Screen width
type: int
dhcp-ip-overlap:
choices:
- use-old
- use-new
description: Configure overlapping DHCP IP allocation assignment.
type: str
dhcp-ra-giaddr:
description: Relay agent gateway IP address to use in the giaddr field of DHCP
requests.
type: str
dhcp6-ra-linkaddr:
description: Relay agent IPv6 link address to use in DHCP6 requests.
type: str
display-bookmark:
choices:
- disable
- enable
description: Enable to display the web portal bookmark widget.
type: str
display-connection-tools:
choices:
- disable
- enable
description: Enable to display the web portal connection tools widget.
type: str
display-history:
choices:
- disable
- enable
description: Enable to display the web portal user login history widget.
type: str
display-status:
choices:
- disable
- enable
description: Enable to display the web portal status widget.
type: str
dns-server1:
description: IPv4 DNS server 1.
type: str
dns-server2:
description: IPv4 DNS server 2.
type: str
dns-suffix:
description: DNS suffix.
type: str
exclusive-routing:
choices:
- disable
- enable
description: Enable/disable all traffic go through tunnel only.
type: str
forticlient-download:
choices:
- disable
- enable
description: Enable/disable download option for FortiClient.
type: str
forticlient-download-method:
choices:
- direct
- ssl-vpn
description: FortiClient download method.
type: str
heading:
description: Web portal heading message.
type: str
hide-sso-credential:
choices:
- disable
- enable
description: Enable to prevent SSO credential being sent to client.
type: str
host-check:
choices:
- none
- av
- fw
- av-fw
- custom
description: Type of host checking performed on endpoints.
type: str
host-check-interval:
description: Periodic host check interval.
type: int
host-check-policy:
description: One or more policies to require the endpoint to have specific security
software.
type: str
ip-mode:
choices:
- range
- user-group
- dhcp
- no-ip
description: Method by which users of this SSL-VPN tunnel obtain IP addresses.
type: str
ip-pools:
description: IPv4 firewall source address objects reserved for SSL-VPN tunnel
mode clients.
type: str
ipv6-dns-server1:
description: IPv6 DNS server 1.
type: str
ipv6-dns-server2:
description: IPv6 DNS server 2.
type: str
ipv6-exclusive-routing:
choices:
- disable
- enable
description: Enable/disable all IPv6 traffic go through tunnel only.
type: str
ipv6-pools:
description: IPv4 firewall source address objects reserved for SSL-VPN tunnel
mode clients.
type: str
ipv6-service-restriction:
choices:
- disable
- enable
description: Enable/disable IPv6 tunnel service restriction.
type: str
ipv6-split-tunneling:
choices:
- disable
- enable
description: Enable/disable IPv6 split tunneling.
type: str
ipv6-split-tunneling-routing-address:
description: IPv6 SSL-VPN tunnel mode firewall address objects that override firewall
policy destination addresses to control split-tunnelin...
type: str
ipv6-split-tunneling-routing-negate:
choices:
- disable
- enable
description: Enable to negate IPv6 split tunneling routing address.
type: str
ipv6-tunnel-mode:
choices:
- disable
- enable
description: Enable/disable IPv6 SSL-VPN tunnel mode.
type: str
ipv6-wins-server1:
description: IPv6 WINS server 1.
type: str
ipv6-wins-server2:
description: IPv6 WINS server 2.
type: str
keep-alive:
choices:
- disable
- enable
description: Enable/disable automatic reconnect for FortiClient connections.
type: str
landing-page:
description: no description
required: false
suboptions:
form-data:
description: description
elements: dict
suboptions:
name:
description: Name.
type: str
value:
description: Value.
type: str
type: list
logout-url:
description: Landing page log out URL.
type: str
sso:
choices:
- disable
- static
- auto
description: Single sign-on.
type: str
sso-credential:
choices:
- sslvpn-login
- alternative
description: Single sign-on credentials.
type: str
sso-password:
description: description
type: str
sso-username:
description: SSO user name.
type: str
url:
description: Landing page URL.
type: str
type: dict
landing-page-mode:
choices:
- disable
- enable
description: Enable/disable SSL-VPN landing page mode.
type: str
limit-user-logins:
choices:
- disable
- enable
description: Enable to limit each user to one SSL-VPN session at a time.
type: str
mac-addr-action:
choices:
- deny
- allow
description: Client MAC address action.
type: str
mac-addr-check:
choices:
- disable
- enable
description: Enable/disable MAC address host checking.
type: str
mac-addr-check-rule:
description: Mac-Addr-Check-Rule.
elements: dict
suboptions:
mac-addr-list:
description: Client MAC address list.
type: str
mac-addr-mask:
description: Client MAC address mask.
type: int
name:
description: Client MAC address check rule name.
type: str
type: list
macos-forticlient-download-url:
description: Download URL for Mac FortiClient.
type: str
name:
description: Portal name.
type: str
os-check:
choices:
- disable
- enable
description: Enable to let the FortiGate decide action based on client OS.
type: str
os-check-list:
description: no description
required: false
suboptions:
action:
choices:
- allow
- check-up-to-date
- deny
description: OS check options.
type: str
latest-patch-level:
description: Latest OS patch level.
type: str
name:
description: Name.
type: str
tolerance:
description: OS patch level tolerance.
type: int
type: dict
prefer-ipv6-dns:
choices:
- disable
- enable
description: prefer to query IPv6 dns first if enabled.
type: str
redir-url:
description: Client login redirect URL.
type: str
rewrite-ip-uri-ui:
choices:
- disable
- enable
description: Rewrite contents for URI contains IP and /ui/.
type: str
save-password:
choices:
- disable
- enable
description: Enable/disable FortiClient saving the users password.
type: str
service-restriction:
choices:
- disable
- enable
description: Enable/disable tunnel service restriction.
type: str
skip-check-for-browser:
choices:
- disable
- enable
description: Enable to skip host check for browser support.
type: str
skip-check-for-unsupported-browser:
choices:
- disable
- enable
description: Enable to skip host check if browser does not support it.
type: str
skip-check-for-unsupported-os:
choices:
- disable
- enable
description: Enable to skip host check if client OS does not support it.
type: str
smb-max-version:
choices:
- smbv1
- smbv2
- smbv3
description: SMB maximum client protocol version.
type: str
smb-min-version:
choices:
- smbv1
- smbv2
- smbv3
description: SMB minimum client protocol version.
type: str
smb-ntlmv1-auth:
choices:
- disable
- enable
description: Enable support of NTLMv1 for Samba authentication.
type: str
smbv1:
choices:
- disable
- enable
description: Enable/disable support of SMBv1 for Samba.
type: str
split-dns:
description: Split-Dns.
elements: dict
suboptions:
dns-server1:
description: DNS server 1.
type: str
dns-server2:
description: DNS server 2.
type: str
domains:
description: Split DNS domains used for SSL-VPN clients separated by comma
type: str
id:
description: ID.
type: int
ipv6-dns-server1:
description: IPv6 DNS server 1.
type: str
ipv6-dns-server2:
description: IPv6 DNS server 2.
type: str
type: list
split-tunneling:
choices:
- disable
- enable
description: Enable/disable IPv4 split tunneling.
type: str
split-tunneling-routing-address:
description: IPv4 SSL-VPN tunnel mode firewall address objects that override firewall
policy destination addresses to control split-tunnelin...
type: str
split-tunneling-routing-negate:
choices:
- disable
- enable
description: Enable to negate split tunneling routing address.
type: str
theme:
choices:
- gray
- blue
- orange
- crimson
- steelblue
- darkgrey
- green
- melongene
- red
- mariner
- neutrino
- jade
- graphite
- dark-matter
- onyx
- eclipse
- jet-stream
- security-fabric
description: Web portal color scheme.
type: str
transform-backward-slashes:
choices:
- disable
- enable
description: Transform backward slashes to forward slashes in URLs.
type: str
tunnel-mode:
choices:
- disable
- enable
description: Enable/disable IPv4 SSL-VPN tunnel mode.
type: str
use-sdwan:
choices:
- disable
- enable
description: Use SD-WAN rules to get output interface.
type: str
user-bookmark:
choices:
- disable
- enable
description: Enable to allow web portal users to create their own bookmarks.
type: str
user-group-bookmark:
choices:
- disable
- enable
description: Enable to allow web portal users to create bookmarks for all users
in the same user group.
type: str
virtual-desktop:
choices:
- disable
- enable
description: Enable/disable SSL VPN virtual desktop.
type: str
virtual-desktop-app-list:
description: Virtual desktop application list.
type: str
virtual-desktop-clipboard-share:
choices:
- disable
- enable
description: Enable/disable sharing of clipboard in virtual desktop.
type: str
virtual-desktop-desktop-switch:
choices:
- disable
- enable
description: Enable/disable switch to virtual desktop.
type: str
virtual-desktop-logout-when-browser-close:
choices:
- disable
- enable
description: Enable/disable logout when browser is close in virtual desktop.
type: str
virtual-desktop-network-share-access:
choices:
- disable
- enable
description: Enable/disable network share access in virtual desktop.
type: str
virtual-desktop-printing:
choices:
- disable
- enable
description: Enable/disable printing in virtual desktop.
type: str
virtual-desktop-removable-media-access:
choices:
- disable
- enable
description: Enable/disable access to removable media in virtual desktop.
type: str
web-mode:
choices:
- disable
- enable
description: Enable/disable SSL VPN web mode.
type: str
windows-forticlient-download-url:
description: Download URL for Windows FortiClient.
type: str
wins-server1:
description: IPv4 WINS server 1.
type: str
wins-server2:
description: IPv4 WINS server 1.
type: str
type: dict
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list