Try SpotterConfigure SSL-VPN user group bookmark in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This 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
- 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: "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: "rdp"
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"
width: "1024"
name: "default_name_37 (source user.group.name)"
vdom:
default: root
description:
- 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
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
vpn_ssl_web_user_group_bookmark:
default: null
description:
- Configure SSL-VPN user group bookmark.
suboptions:
bookmarks:
description:
- Bookmark table.
elements: dict
suboptions:
additional_params:
description:
- Additional parameters.
type: str
apptype:
choices:
- ftp
- rdp
- sftp
- smb
- ssh
- telnet
- vnc
- web
- citrix
- portforward
description:
- Application type.
type: str
color_depth:
choices:
- '32'
- '16'
- '8'
description:
- Color depth per pixel.
type: str
description:
description:
- Description.
type: str
domain:
description:
- Login domain.
type: str
folder:
description:
- Network shared file folder parameter.
type: str
form_data:
description:
- Form data.
elements: dict
suboptions:
name:
description:
- Name.
type: str
value:
description:
- Value.
type: str
type: list
height:
description:
- Screen height (range from 0 - 65535).
type: int
host:
description:
- Host name/IP parameter.
type: str
keyboard_layout:
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
- 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
description:
- Keyboard layout.
type: str
listening_port:
description:
- Listening port (0 - 65535).
type: int
load_balancing_info:
description:
- The load balancing information or cookie which should be provided to the
connection broker.
type: str
logon_password:
description:
- Logon password.
type: str
logon_user:
description:
- Logon user.
type: str
name:
description:
- Bookmark name.
type: str
port:
description:
- Remote port.
type: int
preconnection_blob:
description:
- An arbitrary string which identifies the RDP source.
type: str
preconnection_id:
description:
- The numeric ID of the RDP source (0-4294967295).
type: int
remote_port:
description:
- Remote port (0 - 65535).
type: int
restricted_admin:
choices:
- enable
- disable
description:
- Enable/disable restricted admin mode for RDP.
type: str
security:
choices:
- rdp
- nla
- tls
- any
description:
- Security mode for RDP connection.
type: str
send_preconnection_id:
choices:
- enable
- disable
description:
- Enable/disable sending of preconnection ID.
type: str
server_layout:
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
description:
- Server side keyboard layout.
type: str
show_status_window:
choices:
- enable
- disable
description:
- Enable/disable showing of status window.
type: str
sso:
choices:
- disable
- static
- auto
description:
- Single Sign-On.
type: str
sso_credential:
choices:
- sslvpn-login
- alternative
description:
- Single sign-on credentials.
type: str
sso_credential_sent_once:
choices:
- enable
- disable
description:
- Single sign-on credentials are only sent once to remote server.
type: str
sso_password:
description:
- SSO password.
type: str
sso_username:
description:
- SSO user name.
type: str
url:
description:
- URL parameter.
type: str
width:
description:
- Screen width (range from 0 - 65535).
type: int
type: list
name:
description:
- Group name. Source user.group.name.
required: true
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str