fortios_vpn_ssl_web_user_bookmark – Configure SSL-VPN user bookmark in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • 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


The below requirements are needed on the host that executes this module.

  • ansible>=2.14


Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges
fortios_vpn_ssl_web_user_bookmark v6.0.0 -> latest


  • 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
  • vpn_ssl_web_user_bookmark - Configure SSL-VPN user bookmark. type: dict more...
    • bookmarks - Bookmark table. type: list member_path: bookmarks:name more...
      • additional_params - Additional parameters. type: str more...
      • apptype - Application type. type: str choices: ftp, rdp, sftp, smb, ssh, telnet, vnc, web, citrix, portforward more...
      • color_depth - Color depth per pixel. type: str choices: 32, 16, 8 more...
      • description - Description. type: str more...
      • domain - Login domain. type: str more...
      • folder - Network shared file folder parameter. type: str more...
      • form_data - Form data. type: list member_path: bookmarks:name/form_data:name more...
        • name - Name. type: str required: true more...
        • value - Value. type: str more...
      • height - Screen height (range from 0 - 65535). type: int more...
      • host - Host name/IP parameter. type: str more...
      • keyboard_layout - Keyboard layout. type: str choices: ar-101, ar-102, ar-102-azerty, can-mul, cz, cz-qwerty, cz-pr, da, nl, de, de-ch, de-ibm, en-uk, en-uk-ext, en-us, en-us-dvorak, es, es-var, fi, fi-sami, fr, fr-apple, fr-ca, fr-ch, fr-be, hr, hu, hu-101, it, it-142, ja, ko, la-am, lt, lt-ibm, lt-std, lav-std, lav-leg, mk, mk-std, no, no-sami, pol-214, pol-pr, pt, pt-br, pt-br-abnt2, ru, ru-mne, ru-t, sl, sv, sv-sami, tuk, tur-f, tur-q, zh-sym-sg-us, zh-sym-us, zh-tr-hk, zh-tr-mo, zh-tr-us more...
      • listening_port - Listening port (0 - 65535). type: int more...
      • load_balancing_info - The load balancing information or cookie which should be provided to the connection broker. type: str more...
      • logon_password - Logon password. type: str more...
      • logon_user - Logon user. type: str more...
      • name - Bookmark name. type: str required: true more...
      • port - Remote port. type: int more...
      • preconnection_blob - An arbitrary string which identifies the RDP source. type: str more...
      • preconnection_id - The numeric ID of the RDP source (0-4294967295). type: int more...
      • remote_port - Remote port (0 - 65535). type: int more...
      • restricted_admin - Enable/disable restricted admin mode for RDP. type: str choices: enable, disable more...
      • security - Security mode for RDP connection . type: str choices: any, rdp, nla, tls more...
      • send_preconnection_id - Enable/disable sending of preconnection ID. type: str choices: enable, disable more...
      • server_layout - Server side keyboard layout. type: str choices: de-de-qwertz, en-gb-qwerty, en-us-qwerty, es-es-qwerty, fr-ca-qwerty, fr-fr-azerty, fr-ch-qwertz, it-it-qwerty, ja-jp-qwerty, pt-br-qwerty, sv-se-qwerty, tr-tr-qwerty, failsafe more...
      • show_status_window - Enable/disable showing of status window. type: str choices: enable, disable more...
      • sso - Single sign-on. type: str choices: disable, static, auto more...
      • sso_credential - Single sign-on credentials. type: str choices: sslvpn-login, alternative more...
      • sso_credential_sent_once - Single sign-on credentials are only sent once to remote server. type: str choices: enable, disable more...
      • sso_password - SSO password. type: str more...
      • sso_username - SSO user name. type: str more...
      • url - URL parameter. type: str more...
      • vnc_keyboard_layout - Keyboard layout. type: str choices: default, da, nl, en-uk, en-uk-ext, fi, fr, fr-be, fr-ca-mul, de, de-ch, it, it-142, pt, pt-br-abnt2, no, gd, es, sv, us-intl more...
      • width - Screen width (range from 0 - 65535). type: int more...
    • custom_lang - Personal language. Source type: str more...
    • name - User and group name. type: str required: true more...



  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks


- name: Configure SSL-VPN user bookmark.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
                  additional_params: "<your_own_value>"
                  apptype: "ftp"
                  color_depth: "32"
                  description: "<your_own_value>"
                  domain: "<your_own_value>"
                  folder: "<your_own_value>"
                          name: "default_name_11"
                          value: "<your_own_value>"
                  height: "768"
                  host: "myhostname"
                  keyboard_layout: "ar-101"
                  listening_port: "0"
                  load_balancing_info: "<your_own_value>"
                  logon_password: "<your_own_value>"
                  logon_user: "<your_own_value>"
                  name: "default_name_20"
                  port: "0"
                  preconnection_blob: "<your_own_value>"
                  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: "<your_own_value>"
                  sso_username: "<your_own_value>"
                  url: ""
                  vnc_keyboard_layout: "default"
                  width: "1024"
          custom_lang: "<your_own_value> (source"
          name: "default_name_39"

Return Values

Common return values are documented:, 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:
  • 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


  • This module is not guaranteed to have a backwards compatible interface.


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


If you notice any issues in this documentation, you can create a pull request to improve it.