fortios_vpn_ssl_web_user_group_bookmark.rst

source:	fortios_vpn_ssl_web_user_group_bookmark.py
orphan:

fortios_vpn_ssl_web_user_group_bookmark -- Configure SSL-VPN user group bookmark in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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_group_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.14

Tips

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

FortiOS Version Compatibility

	Supported Version Ranges
fortios_vpn_ssl_web_user_group_bookmark	v6.0.0 -> latest

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
• vpn_ssl_web_user_group_bookmark - Configure SSL-VPN user group bookmark. type: dict more...

  	Supported Version Ranges
  vpn_ssl_web_user_group_bookmark	v6.0.0 -> latest

• bookmarks - Bookmark table. type: list member_path: bookmarks:name more...

  	Supported Version Ranges
  bookmarks	v6.0.0 -> latest

• additional_params - Additional parameters. type: str more...

  	Supported Version Ranges
  additional_params	v6.0.0 -> latest

• apptype - Application type. type: str choices: ftp, rdp, sftp, smb, ssh, telnet, vnc, web, citrix, portforward more...

  	Supported Version Ranges
  apptype	v6.0.0 -> latest
  [ftp]	v6.0.0 -> latest
  [rdp]	v6.0.0 -> latest
  [sftp]	v6.2.0 -> latest
  [smb]	v6.0.0 -> latest
  [ssh]	v6.0.0 -> latest
  [telnet]	v6.0.0 -> latest
  [vnc]	v6.0.0 -> latest
  [web]	v6.0.0 -> latest
  [citrix]	v6.0.0 -> v6.0.11
  [portforward]	v6.0.0 -> v6.0.11

• color_depth - Color depth per pixel. type: str choices: 32, 16, 8 more...

  	Supported Version Ranges
  color_depth	v7.0.1 -> latest
  [32]	v6.0.0 -> latest
  [16]	v6.0.0 -> latest
  [8]	v6.0.0 -> latest

• description - Description. type: str more...

  	Supported Version Ranges
  description	v6.0.0 -> latest

• domain - Login domain. type: str more...

  	Supported Version Ranges
  domain	v6.4.0 -> v6.4.0	v6.4.4 -> latest

• folder - Network shared file folder parameter. type: str more...

  	Supported Version Ranges
  folder	v6.0.0 -> latest

• form_data - Form data. type: list member_path: bookmarks:name/form_data:name more...

  	Supported Version Ranges
  form_data	v6.0.0 -> latest

• name - Name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• value - Value. type: str more...

  	Supported Version Ranges
  value	v6.0.0 -> latest

• height - Screen height (range from 0 - 65535). type: int more...

  	Supported Version Ranges
  height	v7.0.4 -> latest

• host - Host name/IP parameter. type: str more...

  	Supported Version Ranges
  host	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  keyboard_layout	v7.0.1 -> latest
  [ar-101]	v6.0.0 -> latest
  [ar-102]	v6.0.0 -> latest
  [ar-102-azerty]	v6.0.0 -> latest
  [can-mul]	v6.0.0 -> latest
  [cz]	v6.0.0 -> latest
  [cz-qwerty]	v6.0.0 -> latest
  [cz-pr]	v6.0.0 -> latest
  [da]	v6.0.0 -> latest
  [nl]	v6.0.0 -> latest
  [de]	v6.0.0 -> latest
  [de-ch]	v6.0.0 -> latest
  [de-ibm]	v6.0.0 -> latest
  [en-uk]	v6.0.0 -> latest
  [en-uk-ext]	v6.0.0 -> latest
  [en-us]	v6.0.0 -> latest
  [en-us-dvorak]	v6.0.0 -> latest
  [es]	v6.0.0 -> latest
  [es-var]	v6.0.0 -> latest
  [fi]	v6.0.0 -> latest
  [fi-sami]	v6.0.0 -> latest
  [fr]	v6.0.0 -> latest
  [fr-apple]	v7.0.6 -> latest
  [fr-ca]	v6.0.0 -> latest
  [fr-ch]	v6.0.0 -> latest
  [fr-be]	v6.0.0 -> latest
  [hr]	v6.0.0 -> latest
  [hu]	v6.0.0 -> latest
  [hu-101]	v6.0.0 -> latest
  [it]	v6.0.0 -> latest
  [it-142]	v6.0.0 -> latest
  [ja]	v6.0.0 -> latest
  [ko]	v6.0.0 -> latest
  [la-am]	v7.4.1 -> latest
  [lt]	v6.0.0 -> latest
  [lt-ibm]	v6.0.0 -> latest
  [lt-std]	v6.0.0 -> latest
  [lav-std]	v6.0.0 -> latest
  [lav-leg]	v6.0.0 -> latest
  [mk]	v6.0.0 -> latest
  [mk-std]	v6.0.0 -> latest
  [no]	v6.0.0 -> latest
  [no-sami]	v6.0.0 -> latest
  [pol-214]	v6.0.0 -> latest
  [pol-pr]	v6.0.0 -> latest
  [pt]	v6.0.0 -> latest
  [pt-br]	v6.0.0 -> latest
  [pt-br-abnt2]	v6.0.0 -> latest
  [ru]	v6.0.0 -> latest
  [ru-mne]	v6.0.0 -> latest
  [ru-t]	v6.0.0 -> latest
  [sl]	v6.0.0 -> latest
  [sv]	v6.0.0 -> latest
  [sv-sami]	v6.0.0 -> latest
  [tuk]	v6.0.0 -> latest
  [tur-f]	v6.0.0 -> latest
  [tur-q]	v6.0.0 -> latest
  [zh-sym-sg-us]	v6.0.0 -> latest
  [zh-sym-us]	v6.0.0 -> latest
  [zh-tr-hk]	v6.0.0 -> latest
  [zh-tr-mo]	v6.0.0 -> latest
  [zh-tr-us]	v6.0.0 -> latest

• listening_port - Listening port (0 - 65535). type: int more...

  	Supported Version Ranges
  listening_port	v6.0.0 -> v7.0.0

• load_balancing_info - The load balancing information or cookie which should be provided to the connection broker. type: str more...

  	Supported Version Ranges
  load_balancing_info	v6.0.0 -> latest

• logon_password - Logon password. type: str more...

  	Supported Version Ranges
  logon_password	v6.0.0 -> latest

• logon_user - Logon user. type: str more...

  	Supported Version Ranges
  logon_user	v6.0.0 -> latest

• name - Bookmark name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• port - Remote port. type: int more...

  	Supported Version Ranges
  port	v6.0.0 -> latest

• preconnection_blob - An arbitrary string which identifies the RDP source. type: str more...

  	Supported Version Ranges
  preconnection_blob	v6.0.0 -> latest

• preconnection_id - The numeric ID of the RDP source (0-4294967295). type: int more...

  	Supported Version Ranges
  preconnection_id	v6.0.0 -> latest

• remote_port - Remote port (0 - 65535). type: int more...

  	Supported Version Ranges
  remote_port	v6.0.0 -> v7.0.0

• restricted_admin - Enable/disable restricted admin mode for RDP. type: str choices: enable, disable more...

  	Supported Version Ranges
  restricted_admin	v7.0.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• security - Security mode for RDP connection . type: str choices: any, rdp, nla, tls more...

  	Supported Version Ranges
  security	v6.0.0 -> latest
  [any]	v6.0.0 -> latest
  [rdp]	v6.0.0 -> latest
  [nla]	v6.0.0 -> latest
  [tls]	v6.0.0 -> latest

• send_preconnection_id - Enable/disable sending of preconnection ID. type: str choices: enable, disable more...

  	Supported Version Ranges
  send_preconnection_id	v7.0.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  server_layout	v6.0.0 -> v7.0.0
  [de-de-qwertz]	v6.0.0 -> latest
  [en-gb-qwerty]	v6.0.0 -> latest
  [en-us-qwerty]	v6.0.0 -> latest
  [es-es-qwerty]	v6.0.0 -> latest
  [fr-ca-qwerty]	v6.2.0 -> v7.0.0
  [fr-fr-azerty]	v6.0.0 -> latest
  [fr-ch-qwertz]	v6.0.0 -> latest
  [it-it-qwerty]	v6.0.0 -> latest
  [ja-jp-qwerty]	v6.0.0 -> latest
  [pt-br-qwerty]	v6.0.0 -> latest
  [sv-se-qwerty]	v6.0.0 -> latest
  [tr-tr-qwerty]	v6.0.0 -> latest
  [failsafe]	v6.0.0 -> latest

• show_status_window - Enable/disable showing of status window. type: str choices: enable, disable more...

  	Supported Version Ranges
  show_status_window	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• sso - Single sign-on. type: str choices: disable, static, auto more...

  	Supported Version Ranges
  sso	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [static]	v6.0.0 -> latest
  [auto]	v6.0.0 -> latest

• sso_credential - Single sign-on credentials. type: str choices: sslvpn-login, alternative more...

  	Supported Version Ranges
  sso_credential	v6.0.0 -> latest
  [sslvpn-login]	v6.0.0 -> latest
  [alternative]	v6.0.0 -> latest

• sso_credential_sent_once - Single sign-on credentials are only sent once to remote server. type: str choices: enable, disable more...

  	Supported Version Ranges
  sso_credential_sent_once	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• sso_password - SSO password. type: str more...

  	Supported Version Ranges
  sso_password	v6.0.0 -> latest

• sso_username - SSO user name. type: str more...

  	Supported Version Ranges
  sso_username	v6.0.0 -> latest

• url - URL parameter. type: str more...

  	Supported Version Ranges
  url	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  vnc_keyboard_layout	v7.2.4 -> latest
  [default]	v6.0.0 -> latest
  [da]	v6.0.0 -> latest
  [nl]	v6.0.0 -> latest
  [en-uk]	v6.0.0 -> latest
  [en-uk-ext]	v6.0.0 -> latest
  [fi]	v6.0.0 -> latest
  [fr]	v6.0.0 -> latest
  [fr-be]	v6.0.0 -> latest
  [fr-ca-mul]	v6.0.0 -> latest
  [de]	v6.0.0 -> latest
  [de-ch]	v6.0.0 -> latest
  [it]	v6.0.0 -> latest
  [it-142]	v6.0.0 -> latest
  [pt]	v6.0.0 -> latest
  [pt-br-abnt2]	v6.0.0 -> latest
  [no]	v6.0.0 -> latest
  [gd]	v6.0.0 -> latest
  [es]	v6.0.0 -> latest
  [sv]	v6.0.0 -> latest
  [us-intl]	v6.0.0 -> latest

• width - Screen width (range from 0 - 65535). type: int more...

  	Supported Version Ranges
  width	v7.0.4 -> latest

• name - Group name. Source user.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure SSL-VPN user group bookmark.
  fortinet.fortios.fortios_vpn_ssl_web_user_group_bookmark:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_web_user_group_bookmark:
          bookmarks:
              -
                  additional_params: "<your_own_value>"
                  apptype: "ftp"
                  color_depth: "32"
                  description: "<your_own_value>"
                  domain: "<your_own_value>"
                  folder: "<your_own_value>"
                  form_data:
                      -
                          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: "myurl.com"
                  vnc_keyboard_layout: "default"
                  width: "1024"
          name: "default_name_38 (source user.group.name)"

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.

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.