:source: fortios_vpn_ssl_web_user_bookmark.py :orphan: .. fortios_vpn_ssl_web_user_bookmark: fortios_vpn_ssl_web_user_bookmark -- Configure Agentless VPN user bookmark 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 user_bookmark 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: Configure Agentless VPN user bookmark. fortinet.fortios.fortios_vpn_ssl_web_user_bookmark: vdom: "{{ vdom }}" state: "present" access_token: "" vpn_ssl_web_user_bookmark: bookmarks: - additional_params: "" apptype: "ftp" color_depth: "32" description: "" domain: "" folder: "" form_data: - name: "default_name_11" value: "" height: "768" host: "myhostname" keyboard_layout: "ar-101" listening_port: "0" load_balancing_info: "" logon_password: "" logon_user: "" name: "default_name_20" 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" custom_lang: " (source system.custom-language.name)" name: "default_name_39" 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.