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

Note

This plugin is part of the fortinet.fortios collection (version 1.1.8).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_vpn_ssl_web_user_bookmark.

New in version 2.9: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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

Parameters

Parameter				Choices/Defaults	Comments
access_token string					Token-based authentication. Generated from GUI of Fortigate.
state string / required				present absent	Indicates whether to create or remove the object.
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					Configure SSL VPN user bookmark.
	bookmarks list / elements=string				Bookmark table.
		additional_params string			Additional parameters.
		apptype string		citrix ftp portforward rdp smb ssh telnet vnc web	Application type.
		description string			Description.
		folder string			Network shared file folder parameter.
		form_data list / elements=string			Form data.
			name string / required		Name.
			value string		Value.
		host string			Host name/IP parameter.
		listening_port integer			Listening port (0 - 65535).
		logon_password string			Logon password.
		logon_user string			Logon user.
		name string / required			Bookmark name.
		port integer			Remote port.
		remote_port integer			Remote port (0 - 65535).
		security string		rdp nla tls any	Security mode for RDP connection.
		server_layout string		en-us-qwerty de-de-qwertz fr-fr-azerty it-it-qwerty sv-se-qwerty failsafe	Server side keyboard layout.
		show_status_window string		enable disable	Enable/disable showing of status window.
		sso string		disable static auto	Single Sign-On.
		sso_credential string		sslvpn-login alternative	Single sign-on credentials.
		sso_credential_sent_once string		enable disable	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

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

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 bookmark.
    fortios_vpn_ssl_web_user_bookmark:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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"
            logon_password: "<your_own_value>"
            logon_user: "<your_own_value>"
            name: "default_name_15"
            port: "16"
            remote_port: "17"
            security: "rdp"
            server_layout: "en-us-qwerty"
            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_28"

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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_vpn_ssl_web_user_bookmark_module.html