fortios_vpn_ssl_web_user_bookmark – Configure SSL VPN user bookmark in Fortinet’s FortiOS and FortiGate
New in version 2.9.
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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
host string | FortiOS or FortiGate IP address. | ||||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |||
password string | Default: "" | FortiOS or FortiGate password. | |||
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | |||
state string / required |
| Indicates whether to create or remove the object. | |||
username string | FortiOS or FortiGate username. | ||||
vdom string | Default: "root" | 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. | |||
vpn_ssl_web_user_bookmark dictionary | Default: null | Configure SSL VPN user bookmark. | |||
bookmarks list | Bookmark table. | ||||
additional_params string | Additional parameters. | ||||
apptype string |
| Application type. | |||
description string | Description. | ||||
folder string | Network shared file folder parameter. | ||||
form_data list | Form data. | ||||
name string / required | Name. | ||||
value string | Value. | ||||
host string | Host name/IP parameter. | ||||
listening_port integer | Listening port (0 - 65535). | ||||
load_balancing_info string | The load balancing information or cookie which should be provided to the connection broker. | ||||
logon_password string | Logon password. | ||||
logon_user string | Logon user. | ||||
name string / required | Bookmark name. | ||||
port integer | Remote port. | ||||
preconnection_blob string | An arbitrary string which identifies the RDP source. | ||||
preconnection_id integer | The numeric ID of the RDP source (0-2147483648). | ||||
remote_port integer | Remote port (0 - 65535). | ||||
security string |
| Security mode for RDP connection. | |||
server_layout string |
| Server side keyboard layout. | |||
show_status_window string |
| Enable/disable showing of status window. | |||
sso string |
| Single Sign-On. | |||
sso_credential string |
| Single sign-on credentials. | |||
sso_credential_sent_once string |
| Single sign-on credentials are only sent once to remote server. | |||
sso_password string | SSO password. | ||||
sso_username string | SSO user name. | ||||
url string | URL parameter. | ||||
custom_lang string | Personal language. Source system.custom-language.name. | ||||
name string / required | User and group name. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure SSL VPN user bookmark. fortios_vpn_ssl_web_user_bookmark: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" vpn_ssl_web_user_bookmark: bookmarks: - additional_params: "<your_own_value>" apptype: "citrix" description: "<your_own_value>" folder: "<your_own_value>" form_data: - name: "default_name_9" value: "<your_own_value>" host: "<your_own_value>" listening_port: "12" load_balancing_info: "<your_own_value>" logon_password: "<your_own_value>" logon_user: "<your_own_value>" name: "default_name_16" port: "17" preconnection_blob: "<your_own_value>" preconnection_id: "19" remote_port: "20" 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" custom_lang: "<your_own_value> (source system.custom-language.name)" name: "default_name_31"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_vpn_ssl_web_user_bookmark_module.html