: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
- 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 Agentless VPN user bookmark. type: dict
more...
| Supported Version Ranges |
| vpn_ssl_web_user_bookmark |
v6.0.0 -> 7.6.6 |
- bookmarks - Bookmark table. type: list member_path: bookmarks:name
more...
| Supported Version Ranges |
| bookmarks |
v6.0.0 -> 7.6.6 |
- additional_params - Additional parameters. type: str
more...
|
Supported Version Ranges |
| additional_params |
v6.0.0 -> 7.6.6 |
- apptype - Application type. type: str choices: ftp, rdp, sftp, smb, ssh, telnet, vnc, web, citrix, portforward
more...
|
Supported Version Ranges |
| apptype |
v6.0.0 -> 7.6.6 |
| [ftp] |
v6.0.0 -> 7.6.6 |
| [rdp] |
v6.0.0 -> 7.6.6 |
| [sftp] |
v6.2.0 -> 7.6.6 |
| [smb] |
v6.0.0 -> 7.6.6 |
| [ssh] |
v6.0.0 -> 7.6.6 |
| [telnet] |
v6.0.0 -> 7.6.6 |
| [vnc] |
v6.0.0 -> 7.6.6 |
| [web] |
v6.0.0 -> 7.6.6 |
| [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 -> 7.6.6 |
| [32] |
v7.0.1 -> 7.6.6 |
| [16] |
v7.0.1 -> 7.6.6 |
| [8] |
v7.0.1 -> 7.6.6 |
- description - Description. type: str
more...
|
Supported Version Ranges |
| description |
v6.0.0 -> 7.6.6 |
- domain - Login domain. type: str
more...
|
Supported Version Ranges |
| domain |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- folder - Network shared file folder parameter. type: str
more...
|
Supported Version Ranges |
| folder |
v6.0.0 -> 7.6.6 |
- form_data - Form data. type: list member_path: bookmarks:name/form_data:name
more...
| Supported Version Ranges |
| form_data |
v6.0.0 -> 7.6.6 |
- name - Name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- value - Value. type: str
more...
|
Supported Version Ranges |
| value |
v6.0.0 -> 7.6.6 |
- height - Screen height (range from 0 - 65535). type: int
more...
|
Supported Version Ranges |
| height |
v7.0.4 -> 7.6.6 |
- host - Host name/IP parameter. type: str
more...
|
Supported Version Ranges |
| host |
v6.0.0 -> 7.6.6 |
- 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, ja-106, 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 -> 7.6.6 |
| [ar-101] |
v7.0.1 -> 7.6.6 |
| [ar-102] |
v7.0.1 -> 7.6.6 |
| [ar-102-azerty] |
v7.0.1 -> 7.6.6 |
| [can-mul] |
v7.0.1 -> 7.6.6 |
| [cz] |
v7.0.1 -> 7.6.6 |
| [cz-qwerty] |
v7.0.1 -> 7.6.6 |
| [cz-pr] |
v7.0.1 -> 7.6.6 |
| [da] |
v7.0.1 -> 7.6.6 |
| [nl] |
v7.0.1 -> 7.6.6 |
| [de] |
v7.0.1 -> 7.6.6 |
| [de-ch] |
v7.0.1 -> 7.6.6 |
| [de-ibm] |
v7.0.1 -> 7.6.6 |
| [en-uk] |
v7.0.1 -> 7.6.6 |
| [en-uk-ext] |
v7.0.1 -> 7.6.6 |
| [en-us] |
v7.0.1 -> 7.6.6 |
| [en-us-dvorak] |
v7.0.1 -> 7.6.6 |
| [es] |
v7.0.1 -> 7.6.6 |
| [es-var] |
v7.0.1 -> 7.6.6 |
| [fi] |
v7.0.1 -> 7.6.6 |
| [fi-sami] |
v7.0.1 -> 7.6.6 |
| [fr] |
v7.0.1 -> 7.6.6 |
| [fr-apple] |
v7.0.6 -> 7.6.6 |
| [fr-ca] |
v7.0.1 -> 7.6.6 |
| [fr-ch] |
v7.0.1 -> 7.6.6 |
| [fr-be] |
v7.0.1 -> 7.6.6 |
| [hr] |
v7.0.1 -> 7.6.6 |
| [hu] |
v7.0.1 -> 7.6.6 |
| [hu-101] |
v7.0.1 -> 7.6.6 |
| [it] |
v7.0.1 -> 7.6.6 |
| [it-142] |
v7.0.1 -> 7.6.6 |
| [ja] |
v7.0.1 -> 7.6.6 |
| [ja-106] |
v7.4.2 -> 7.6.6 |
| [ko] |
v7.0.1 -> 7.6.6 |
| [la-am] |
v7.4.1 -> 7.6.6 |
| [lt] |
v7.0.1 -> 7.6.6 |
| [lt-ibm] |
v7.0.1 -> 7.6.6 |
| [lt-std] |
v7.0.1 -> 7.6.6 |
| [lav-std] |
v7.0.1 -> 7.6.6 |
| [lav-leg] |
v7.0.1 -> 7.6.6 |
| [mk] |
v7.0.1 -> 7.6.6 |
| [mk-std] |
v7.0.1 -> 7.6.6 |
| [no] |
v7.0.1 -> 7.6.6 |
| [no-sami] |
v7.0.1 -> 7.6.6 |
| [pol-214] |
v7.0.1 -> 7.6.6 |
| [pol-pr] |
v7.0.1 -> 7.6.6 |
| [pt] |
v7.0.1 -> 7.6.6 |
| [pt-br] |
v7.0.1 -> 7.6.6 |
| [pt-br-abnt2] |
v7.0.1 -> 7.6.6 |
| [ru] |
v7.0.1 -> 7.6.6 |
| [ru-mne] |
v7.0.1 -> 7.6.6 |
| [ru-t] |
v7.0.1 -> 7.6.6 |
| [sl] |
v7.0.1 -> 7.6.6 |
| [sv] |
v7.0.1 -> 7.6.6 |
| [sv-sami] |
v7.0.1 -> 7.6.6 |
| [tuk] |
v7.0.1 -> 7.6.6 |
| [tur-f] |
v7.0.1 -> 7.6.6 |
| [tur-q] |
v7.0.1 -> 7.6.6 |
| [zh-sym-sg-us] |
v7.0.1 -> 7.6.6 |
| [zh-sym-us] |
v7.0.1 -> 7.6.6 |
| [zh-tr-hk] |
v7.0.1 -> 7.6.6 |
| [zh-tr-mo] |
v7.0.1 -> 7.6.6 |
| [zh-tr-us] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
- logon_password - Logon password. type: str
more...
|
Supported Version Ranges |
| logon_password |
v6.0.0 -> 7.6.6 |
- logon_user - Logon user. type: str
more...
|
Supported Version Ranges |
| logon_user |
v6.0.0 -> 7.6.6 |
- name - Bookmark name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- port - Remote port. type: int
more...
|
Supported Version Ranges |
| port |
v6.0.0 -> 7.6.6 |
- preconnection_blob - An arbitrary string which identifies the RDP source. type: str
more...
|
Supported Version Ranges |
| preconnection_blob |
v6.0.0 -> 7.6.6 |
- preconnection_id - The numeric ID of the RDP source (0-4294967295). type: int
more...
|
Supported Version Ranges |
| preconnection_id |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- security - Security mode for RDP connection . type: str choices: any, rdp, nla, tls
more...
|
Supported Version Ranges |
| security |
v6.0.0 -> 7.6.6 |
| [any] |
v6.0.0 -> 7.6.6 |
| [rdp] |
v6.0.0 -> 7.6.6 |
| [nla] |
v6.0.0 -> 7.6.6 |
| [tls] |
v6.0.0 -> 7.6.6 |
- send_preconnection_id - Enable/disable sending of preconnection ID. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| send_preconnection_id |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- 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 -> v7.0.0 |
| [en-gb-qwerty] |
v6.0.0 -> v7.0.0 |
| [en-us-qwerty] |
v6.0.0 -> v7.0.0 |
| [es-es-qwerty] |
v6.0.0 -> v7.0.0 |
| [fr-ca-qwerty] |
v6.2.0 -> v7.0.0 |
| [fr-fr-azerty] |
v6.0.0 -> v7.0.0 |
| [fr-ch-qwertz] |
v6.0.0 -> v7.0.0 |
| [it-it-qwerty] |
v6.0.0 -> v7.0.0 |
| [ja-jp-qwerty] |
v6.0.0 -> v7.0.0 |
| [pt-br-qwerty] |
v6.0.0 -> v7.0.0 |
| [sv-se-qwerty] |
v6.0.0 -> v7.0.0 |
| [tr-tr-qwerty] |
v6.0.0 -> v7.0.0 |
| [failsafe] |
v6.0.0 -> v7.0.0 |
- 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 -> v7.0.0 |
| [disable] |
v6.0.0 -> v7.0.0 |
- sso - Single sign-on. type: str choices: disable, static, auto
more...
|
Supported Version Ranges |
| sso |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [static] |
v6.0.0 -> 7.6.6 |
| [auto] |
v6.0.0 -> 7.6.6 |
- sso_credential - Single sign-on credentials. type: str choices: sslvpn-login, alternative
more...
|
Supported Version Ranges |
| sso_credential |
v6.0.0 -> 7.6.6 |
| [sslvpn-login] |
v6.0.0 -> 7.6.6 |
| [alternative] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- sso_password - SSO password. type: str
more...
|
Supported Version Ranges |
| sso_password |
v6.0.0 -> 7.6.6 |
- sso_username - SSO user name. type: str
more...
|
Supported Version Ranges |
| sso_username |
v6.0.0 -> 7.6.6 |
- url - URL parameter. type: str
more...
|
Supported Version Ranges |
| url |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [default] |
v7.2.4 -> 7.6.6 |
| [da] |
v7.2.4 -> 7.6.6 |
| [nl] |
v7.2.4 -> 7.6.6 |
| [en-uk] |
v7.2.4 -> 7.6.6 |
| [en-uk-ext] |
v7.2.4 -> 7.6.6 |
| [fi] |
v7.2.4 -> 7.6.6 |
| [fr] |
v7.2.4 -> 7.6.6 |
| [fr-be] |
v7.2.4 -> 7.6.6 |
| [fr-ca-mul] |
v7.2.4 -> 7.6.6 |
| [de] |
v7.2.4 -> 7.6.6 |
| [de-ch] |
v7.2.4 -> 7.6.6 |
| [it] |
v7.2.4 -> 7.6.6 |
| [it-142] |
v7.2.4 -> 7.6.6 |
| [pt] |
v7.2.4 -> 7.6.6 |
| [pt-br-abnt2] |
v7.2.4 -> 7.6.6 |
| [no] |
v7.2.4 -> 7.6.6 |
| [gd] |
v7.2.4 -> 7.6.6 |
| [es] |
v7.2.4 -> 7.6.6 |
| [sv] |
v7.2.4 -> 7.6.6 |
| [us-intl] |
v7.2.4 -> 7.6.6 |
- width - Screen width (range from 0 - 65535). type: int
more...
|
Supported Version Ranges |
| width |
v7.0.4 -> 7.6.6 |
- custom_lang - Personal language. Source system.custom-language.name. type: str
more...
|
Supported Version Ranges |
| custom_lang |
v6.0.0 -> 7.6.6 |
- name - User and group name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
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.