fortinet.fortimanager.fmgr_ztna_webportal module – Configure ztna web-portal.
Note
This module is part of the fortinet.fortimanager collection (version 2.12.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The change note that can be specified when an object is created or updated. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
|
The top level parameters set. |
|
Enable/disable authentication portal. Choices:
|
|
Authentication Rule. |
|
Virtual host for authentication portal. |
|
Bookmarks. |
|
Enable to support RDP/VPC clipboard functionality. Choices:
|
|
Time in minutes that client web browsers should keep a cookie. |
|
Enable support of customized download URL for FortiClient. Choices:
|
|
Decrypted traffic mirror. |
|
Screen height |
|
Screen width |
|
Enable to display the web portal bookmark widget. Choices:
|
|
Enable to display the web portal user login history widget. Choices:
|
|
Enable to display the web portal status widget. Choices:
|
|
Enable to prioritize the placement of the bookmark section over the quick-connection section in the ztna web-portal. Choices:
|
|
Enable/disable download option for FortiClient. Choices:
|
|
Forticlient download method. Choices:
|
|
Web portal heading message. |
|
Virtual or real host name. |
|
Enable/disable logging of blocked traffic. Choices:
|
|
Download URL for Mac FortiClient. |
|
ZTNA proxy name. |
|
Enable policy sso authentication. Choices:
|
|
Web portal color scheme. Choices:
|
|
Virtual IP name. |
|
Virtual IPv6 name. |
|
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.
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
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure ztna web-portal.
fortinet.fortimanager.fmgr_ztna_webportal:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |