fortinet.fortios.fortios_ztna_web_portal module – Configure ztna web-portal in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.4.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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_ztna_web_portal.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ztna feature and web_portal category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
|
Configure ztna web-portal. |
|
Enable/disable authentication portal. Choices:
|
|
Authentication Rule. Source authentication.rule.name. |
|
Virtual host for authentication portal. Source firewall.access-proxy-virtual-host.name. |
|
Enable to support RDP/VPC clipboard functionality. Choices:
|
|
Time in minutes that client web browsers should keep a cookie. Default is 60 minutes. 0 = no time limit. |
|
Enable support of customized download URL for FortiClient. Choices:
|
|
Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. |
|
Screen height (range from 0 - 65535). |
|
Screen width (range from 0 - 65535). |
|
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. Source firewall.access-proxy-virtual-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. Source firewall.vip.name. |
|
Virtual IPv6 name. Source firewall.vip6.name. |
|
Download URL for Windows FortiClient. |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure ztna web-portal.
fortinet.fortios.fortios_ztna_web_portal:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ztna_web_portal:
auth_portal: "disable"
auth_rule: "<your_own_value> (source authentication.rule.name)"
auth_virtual_host: "myhostname (source firewall.access-proxy-virtual-host.name)"
clipboard: "enable"
cookie_age: "60"
customize_forticlient_download_url: "enable"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
default_window_height: "768"
default_window_width: "1024"
display_bookmark: "enable"
display_history: "enable"
display_status: "enable"
focus_bookmark: "enable"
forticlient_download: "enable"
forticlient_download_method: "direct"
heading: "<your_own_value>"
host: "myhostname (source firewall.access-proxy-virtual-host.name)"
log_blocked_traffic: "disable"
macos_forticlient_download_url: "<your_own_value>"
name: "default_name_22"
policy_auth_sso: "enable"
theme: "jade"
vip: "<your_own_value> (source firewall.vip.name)"
vip6: "<your_own_value> (source firewall.vip6.name)"
windows_forticlient_download_url: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |