fortios_ztna_web_portal – Configure ztna web-portal in Fortinet’s FortiOS and FortiGate.
Added in version 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.16
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v7.6.1 -> v7.6.6
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- ztna_web_portal - Configure ztna web-portal. type: dict more...
- auth_portal - Enable/disable authentication portal. type: str choices: disable, enable more...
- auth_rule - Authentication Rule. Source authentication.rule.name. type: str more...
- auth_virtual_host - Virtual host for authentication portal. Source firewall.access-proxy-virtual-host.name. type: str more...
- clipboard - Enable to support RDP/VPC clipboard functionality. type: str choices: enable, disable more...
- cookie_age - Time in minutes that client web browsers should keep a cookie. Default is 60 minutes. 0 = no time limit. type: int more...
- customize_forticlient_download_url - Enable support of customized download URL for FortiClient. type: str choices: enable, disable more...
- decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str more...
- default_window_height - Screen height (range from 0 - 65535). type: int more...
- default_window_width - Screen width (range from 0 - 65535). type: int more...
- display_bookmark - Enable to display the web portal bookmark widget. type: str choices: enable, disable more...
- display_history - Enable to display the web portal user login history widget. type: str choices: enable, disable more...
- display_status - Enable to display the web portal status widget. type: str choices: enable, disable more...
- focus_bookmark - Enable to prioritize the placement of the bookmark section over the quick-connection section in the ztna web-portal. type: str choices: enable, disable more...
- forticlient_download - Enable/disable download option for FortiClient. type: str choices: enable, disable more...
- forticlient_download_method - FortiClient download method. type: str choices: direct, ssl-vpn more...
- heading - Web portal heading message. type: str more...
- host - Virtual or real host name. Source firewall.access-proxy-virtual-host.name. type: str more...
- log_blocked_traffic - Enable/disable logging of blocked traffic. type: str choices: disable, enable more...
- macos_forticlient_download_url - Download URL for Mac FortiClient. type: str more...
- name - ZTNA proxy name. type: str required: true more...
- policy_auth_sso - Enable policy sso authentication. type: str choices: enable, disable more...
- theme - Web portal color scheme. type: str choices: jade, neutrino, mariner, graphite, melongene, jet-stream, security-fabric, dark-matter, onyx, eclipse more...
- vip - Virtual IP name. Source firewall.vip.name. type: str more...
- vip6 - Virtual IPv6 name. Source firewall.vip6.name. type: str more...
- windows_forticlient_download_url - Download URL for Windows FortiClient. type: str more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.