fortios_vpn_ssl_web_user_group_bookmark – Configure SSL VPN user group bookmark in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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.9.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
|
fortios_vpn_ssl_web_user_group_bookmark | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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
- 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...
- bookmarks - Bookmark table. type: list more...
- additional_params - Additional parameters. type: str more...
- apptype - Application type. type: str choices: citrix, ftp, portforward, rdp, smb, ssh, telnet, vnc, web, sftp 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 more...
- host - Host name/IP parameter. type: str 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-2147483648). type: int more...
- remote_port - Remote port (0 - 65535). type: int more...
- security - Security mode for RDP connection. type: str choices: rdp, nla, tls, any more...
- server_layout - Server side keyboard layout. type: str choices: de-de-qwertz, en-gb-qwerty, en-us-qwerty, es-es-qwerty, fr-fr-azerty, fr-ch-qwertz, it-it-qwerty, ja-jp-qwerty, pt-br-qwerty, sv-se-qwerty, tr-tr-qwerty, failsafe, fr-ca-qwerty 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...
- name - Group name. Source user.group.name. type: str required: True more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SSL VPN user group bookmark.
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: "citrix"
description: "<your_own_value>"
domain: "<your_own_value>"
folder: "<your_own_value>"
form_data:
-
name: "default_name_10"
value: "<your_own_value>"
host: "<your_own_value>"
listening_port: "13"
load_balancing_info: "<your_own_value>"
logon_password: "<your_own_value>"
logon_user: "<your_own_value>"
name: "default_name_17"
port: "18"
preconnection_blob: "<your_own_value>"
preconnection_id: "20"
remote_port: "21"
security: "rdp"
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"
name: "default_name_31 (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