fortinet.fortimanager.fmgr_ztna_webportal module – Configure ztna web-portal.
Note
This module is part of the fortinet.fortimanager collection (version 2.14.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_ztna_webportal.
New in fortinet.fortimanager 2.12.0
Synopsis
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter | Comments |
|---|---|
access_token string | The token to access FortiManager without using username and password. |
adom string / required | The parameter (adom) in requested url. |
bypass_validation boolean | Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
enable_log boolean | Enable/Disable logging for task. Choices:
|
forticloud_access_token string | Authenticate Ansible client with forticloud API access token. |
proposed_method string | The overridden method for the underlying Json RPC request. Choices:
|
rc_failed list / elements=integer | The rc codes list with which the conditions to fail will be overriden. |
rc_succeeded list / elements=integer | The rc codes list with which the conditions to succeed will be overriden. |
revision_note string | The change note that can be specified when an object is created or updated. |
state string / required | The directive to create, update or delete an object. Choices:
|
workspace_locking_adom string | The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
workspace_locking_timeout integer | The maximum time in seconds to wait for other user to release the workspace lock. Default: |
ztna_webportal dictionary | The top level parameters set. |
|
auth_portal aliases: auth-portal string |
Enable/disable authentication portal. Choices:
|
|
auth_rule aliases: auth-rule list / elements=string |
Authentication Rule. |
|
auth_virtual_host aliases: auth-virtual-host list / elements=string |
Virtual host for authentication portal. |
|
bookmarks list / elements=string |
Bookmarks. |
|
clipboard string |
Enable to support RDP/VPC clipboard functionality. Choices:
|
|
cookie_age aliases: cookie-age integer |
Time in minutes that client web browsers should keep a cookie. |
|
customize_forticlient_download_url aliases: customize-forticlient-download-url string |
Enable support of customized download URL for FortiClient. Choices:
|
|
decrypted_traffic_mirror aliases: decrypted-traffic-mirror list / elements=string |
Decrypted traffic mirror. |
|
default_window_height aliases: default-window-height integer |
Screen height |
|
default_window_width aliases: default-window-width integer |
Screen width |
|
display_bookmark aliases: display-bookmark string |
Enable to display the web portal bookmark widget. Choices:
|
|
display_history aliases: display-history string |
Enable to display the web portal user login history widget. Choices:
|
|
display_status aliases: display-status string |
Enable to display the web portal status widget. Choices:
|
|
focus_bookmark aliases: focus-bookmark string |
Enable to prioritize the placement of the bookmark section over the quick-connection section in the ztna web-portal. Choices:
|
|
forticlient_download aliases: forticlient-download string |
Enable/disable download option for FortiClient. Choices:
|
|
forticlient_download_method aliases: forticlient-download-method string |
Forticlient download method. Choices:
|
|
heading string |
Web portal heading message. |
|
host list / elements=string |
Virtual or real host name. |
|
llm_profile aliases: llm-profile list / elements=string |
Llm profile. |
|
llm_proxy aliases: llm-proxy string |
Llm proxy. Choices:
|
|
log_blocked_traffic aliases: log-blocked-traffic string |
Enable/disable logging of blocked traffic. Choices:
|
|
macos_forticlient_download_url aliases: macos-forticlient-download-url string |
Download URL for Mac FortiClient. |
|
name string / required |
ZTNA proxy name. |
|
policy_auth_sso aliases: policy-auth-sso string |
Enable policy sso authentication. Choices:
|
|
theme string |
Web portal color scheme. Choices:
|
|
vip list / elements=string |
Virtual IP name. |
|
vip6 list / elements=string |
Virtual IPv6 name. |
|
windows_forticlient_download_url aliases: windows-forticlient-download-url string |
Download URL for Windows FortiClient. |
Notes
Note
- Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
- 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.
- 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
- To create or update an object, use state present directive.
- To delete an object, use state absent directive.
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure ztna web-portal.
fortinet.fortimanager.fmgr_ztna_webportal:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
ztna_webportal:
name: "your value" # Required variable, string
# auth_portal: <value in [disable, enable]>
# auth_rule: <list or string>
# auth_virtual_host: <list or string>
# bookmarks: <list or string>
# clipboard: <value in [disable, enable]>
# cookie_age: <integer>
# customize_forticlient_download_url: <value in [disable, enable]>
# decrypted_traffic_mirror: <list or string>
# default_window_height: <integer>
# default_window_width: <integer>
# display_bookmark: <value in [disable, enable]>
# display_history: <value in [disable, enable]>
# display_status: <value in [disable, enable]>
# focus_bookmark: <value in [disable, enable]>
# forticlient_download: <value in [disable, enable]>
# forticlient_download_method: <value in [direct, ssl-vpn]>
# heading: <string>
# host: <list or string>
# log_blocked_traffic: <value in [disable, enable]>
# macos_forticlient_download_url: <string>
# policy_auth_sso: <value in [disable, enable]>
# theme: <value in [melongene, mariner, neutrino, ...]>
# vip: <list or string>
# windows_forticlient_download_url: <string>
# vip6: <list or string>
# llm_profile: <list or string>
# llm_proxy: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
meta dictionary | The result of the request. Returned: always |
|
request_url string |
The full url requested. Returned: always Sample: |
|
response_code integer |
The status of api request. Returned: always Sample: |
|
response_data list / elements=string |
The api response. Returned: always |
|
response_message string |
The descriptive message of the api response. Returned: always Sample: |
|
system_information dictionary |
The information of the target system. Returned: always |
rc integer | The status the request. Returned: always Sample: |
version_check_warning list / elements=string | Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_ztna_webportal_module.html
