fortinet.fortios.fortios_user_fsso module – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_user_fsso.
New in version 2.0.0: of fortinet.fortios
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fsso 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 |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure Fortinet Single Sign On (FSSO) agents. |
|
Interval in minutes within to fetch groups from FSSO server, or unset to disable. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Enable/disable automatic fetching of groups from LDAP server. Choices:
|
|
Filter used to fetch groups. |
|
Interval in minutes within to fetch groups from LDAP server. |
|
LDAP server to get group information. Source user.ldap.name. |
|
Interval in minutes to keep logons after FSSO server down. |
|
Name. |
|
Password of the first FSSO collector agent. |
|
Password of the second FSSO collector agent. |
|
Password of the third FSSO collector agent. |
|
Password of the fourth FSSO collector agent. |
|
Password of the fifth FSSO collector agent. |
|
Port of the first FSSO collector agent. |
|
Port of the second FSSO collector agent. |
|
Port of the third FSSO collector agent. |
|
Port of the fourth FSSO collector agent. |
|
Port of the fifth FSSO collector agent. |
|
Domain name or IP address of the first FSSO collector agent. |
|
Domain name or IP address of the second FSSO collector agent. |
|
Domain name or IP address of the third FSSO collector agent. |
|
Domain name or IP address of the fourth FSSO collector agent. |
|
Domain name or IP address of the fifth FSSO collector agent. |
|
Source IP for communications to FSSO agent. |
|
IPv6 source for communications to FSSO agent. |
|
Enable/disable use of SSL. Choices:
|
|
Enable/disable server host/IP verification. Choices:
|
|
Trusted server certificate or CA certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name. |
|
Server type. Choices:
|
|
LDAP server to get user information. Source user.ldap.name. |
|
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. Default: “root” |
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 Fortinet Single Sign On (FSSO) agents.
fortios_user_fsso:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fsso:
group_poll_interval: "3"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ldap_poll: "enable"
ldap_poll_filter: "<your_own_value>"
ldap_poll_interval: "8"
ldap_server: "<your_own_value> (source user.ldap.name)"
logon_timeout: "10"
name: "default_name_11"
password: "<your_own_value>"
password2: "<your_own_value>"
password3: "<your_own_value>"
password4: "<your_own_value>"
password5: "<your_own_value>"
port: "17"
port2: "18"
port3: "19"
port4: "20"
port5: "21"
server: "192.168.100.40"
server2: "<your_own_value>"
server3: "<your_own_value>"
server4: "<your_own_value>"
server5: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
ssl: "enable"
ssl_server_host_ip_check: "enable"
ssl_trusted_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
type: "default"
user_info_server: "<your_own_value> (source user.ldap.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)