:source: fortios_vpn_ssl_web_portal.py :orphan: .. fortios_vpn_ssl_web_portal: fortios_vpn_ssl_web_portal -- Portal in Fortinet's FortiOS and FortiGate. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and 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: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Portal. fortinet.fortios.fortios_vpn_ssl_web_portal: vdom: "{{ vdom }}" state: "present" access_token: "" vpn_ssl_web_portal: allow_user_access: "web" auto_connect: "enable" bookmark_group: - bookmarks: - additional_params: "" apptype: "ftp" color_depth: "32" description: "" domain: "" folder: "" form_data: - name: "default_name_14" value: "" height: "768" host: "myhostname" keyboard_layout: "ar-101" listening_port: "0" load_balancing_info: "" logon_password: "" logon_user: "" name: "default_name_23" port: "0" preconnection_blob: "" preconnection_id: "2147483648" remote_port: "0" restricted_admin: "enable" security: "any" send_preconnection_id: "enable" server_layout: "de-de-qwertz" show_status_window: "enable" sso: "disable" sso_credential: "sslvpn-login" sso_credential_sent_once: "enable" sso_password: "" sso_username: "" url: "myurl.com" vnc_keyboard_layout: "default" width: "1024" name: "default_name_41" client_src_range: "enable" clipboard: "enable" custom_lang: " (source system.custom-language.name)" customize_forticlient_download_url: "enable" default_protocol: "web" default_window_height: "768" default_window_width: "1024" dhcp_ip_overlap: "use-new" dhcp_ra_giaddr: "" dhcp_reservation: "enable" dhcp6_ra_linkaddr: "" display_bookmark: "enable" display_connection_tools: "enable" display_history: "enable" display_status: "enable" dns_server1: "" dns_server2: "" dns_suffix: "" exclusive_routing: "enable" focus_bookmark: "enable" forticlient_download: "enable" forticlient_download_method: "direct" heading: "" hide_sso_credential: "enable" host_check: "none" host_check_interval: "0" host_check_policy: - name: "default_name_69 (source vpn.ssl.web.host-check-software.name)" ip_mode: "range" ip_pools: - name: "default_name_72 (source firewall.address.name firewall.addrgrp.name)" ipv6_dns_server1: "" ipv6_dns_server2: "" ipv6_exclusive_routing: "enable" ipv6_pools: - name: "default_name_77 (source firewall.address6.name firewall.addrgrp6.name)" ipv6_service_restriction: "enable" ipv6_split_tunneling: "enable" ipv6_split_tunneling_routing_address: - name: "default_name_81 (source firewall.address6.name firewall.addrgrp6.name)" ipv6_split_tunneling_routing_negate: "enable" ipv6_tunnel_mode: "enable" ipv6_wins_server1: "" ipv6_wins_server2: "" keep_alive: "enable" landing_page: form_data: - name: "default_name_89" value: "" logout_url: "" sso: "disable" sso_credential: "sslvpn-login" sso_password: "" sso_username: "" url: "myurl.com" landing_page_mode: "enable" limit_user_logins: "enable" mac_addr_action: "allow" mac_addr_check: "enable" mac_addr_check_rule: - mac_addr_list: - addr: "" mac_addr_mask: "48" name: "default_name_105" macos_forticlient_download_url: "" name: "default_name_107" os_check: "enable" os_check_list: - action: "deny" latest_patch_level: "" name: "default_name_112" tolerance: "0" prefer_ipv6_dns: "enable" redir_url: "" rewrite_ip_uri_ui: "enable" save_password: "enable" service_restriction: "enable" skip_check_for_browser: "enable" skip_check_for_unsupported_browser: "enable" skip_check_for_unsupported_os: "enable" smb_max_version: "smbv1" smb_min_version: "smbv1" smb_ntlmv1_auth: "enable" smbv1: "enable" split_dns: - dns_server1: "" dns_server2: "" domains: "" id: "130" ipv6_dns_server1: "" ipv6_dns_server2: "" split_tunneling: "enable" split_tunneling_routing_address: - name: "default_name_135 (source firewall.address.name firewall.addrgrp.name)" split_tunneling_routing_negate: "enable" theme: "jade" transform_backward_slashes: "enable" tunnel_mode: "enable" use_sdwan: "enable" user_bookmark: "enable" user_group_bookmark: "enable" web_mode: "enable" windows_forticlient_download_url: "" wins_server1: "" wins_server2: "" 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: .. raw:: html
  • 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. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.