Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_user_fsso_module.html

fortinet.fortios.fortios_user_fsso – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.

Note

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

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.10: 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 Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
user_fsso
dictionary
Configure Fortinet Single Sign On (FSSO) agents.
group_poll_interval
integer
Interval in minutes within to fetch groups from FSSO server, or unset to disable.
interface
string
Specify outgoing interface to reach server. Source system.interface.name.
interface_select_method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
ldap_poll
string
    Choices:
  • enable
  • disable
Enable/disable automatic fetching of groups from LDAP server.
ldap_poll_filter
string
Filter used to fetch groups.
ldap_poll_interval
integer
Interval in minutes within to fetch groups from LDAP server.
ldap_server
string
LDAP server to get group information. Source user.ldap.name.
name
string / required
Name.
password
string
Password of the first FSSO collector agent.
password2
string
Password of the second FSSO collector agent.
password3
string
Password of the third FSSO collector agent.
password4
string
Password of the fourth FSSO collector agent.
password5
string
Password of the fifth FSSO collector agent.
port
integer
Port of the first FSSO collector agent.
port2
integer
Port of the second FSSO collector agent.
port3
integer
Port of the third FSSO collector agent.
port4
integer
Port of the fourth FSSO collector agent.
port5
integer
Port of the fifth FSSO collector agent.
server
string
Domain name or IP address of the first FSSO collector agent.
server2
string
Domain name or IP address of the second FSSO collector agent.
server3
string
Domain name or IP address of the third FSSO collector agent.
server4
string
Domain name or IP address of the fourth FSSO collector agent.
server5
string
Domain name or IP address of the fifth FSSO collector agent.
source_ip
string
Source IP for communications to FSSO agent.
source_ip6
string
IPv6 source for communications to FSSO agent.
ssl
string
    Choices:
  • enable
  • disable
Enable/disable use of SSL.
ssl_trusted_cert
string
Trusted server certificate or CA certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name.
type
string
    Choices:
  • default
  • fortiems
  • fortinac
  • fortiems-cloud
Server type.
user_info_server
string
LDAP server to get user information. Source user.ldap.name.
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.

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 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)"
        name: "default_name_10"
        password: "<your_own_value>"
        password2: "<your_own_value>"
        password3: "<your_own_value>"
        password4: "<your_own_value>"
        password5: "<your_own_value>"
        port: "16"
        port2: "17"
        port3: "18"
        port4: "19"
        port5: "20"
        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_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 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_fsso_module.html