fortios_user_fsso – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_fsso - Configure Fortinet Single Sign On (FSSO) agents. type: dict more...
- group_poll_interval - Interval in minutes within to fetch groups from FSSO server, or unset to disable. type: int more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- ldap_poll - Enable/disable automatic fetching of groups from LDAP server. type: str choices: enable, disable more...
- ldap_poll_filter - Filter used to fetch groups. type: str more...
- ldap_poll_interval - Interval in minutes within to fetch groups from LDAP server. type: int more...
- ldap_server - LDAP server to get group information. Source user.ldap.name. type: str more...
- logon_timeout - Interval in minutes to keep logons after FSSO server down. type: int more...
- name - Name. type: str required: true more...
- password - Password of the first FSSO collector agent. type: str more...
- password2 - Password of the second FSSO collector agent. type: str more...
- password3 - Password of the third FSSO collector agent. type: str more...
- password4 - Password of the fourth FSSO collector agent. type: str more...
- password5 - Password of the fifth FSSO collector agent. type: str more...
- port - Port of the first FSSO collector agent. type: int more...
- port2 - Port of the second FSSO collector agent. type: int more...
- port3 - Port of the third FSSO collector agent. type: int more...
- port4 - Port of the fourth FSSO collector agent. type: int more...
- port5 - Port of the fifth FSSO collector agent. type: int more...
- server - Domain name or IP address of the first FSSO collector agent. type: str more...
- server2 - Domain name or IP address of the second FSSO collector agent. type: str more...
- server3 - Domain name or IP address of the third FSSO collector agent. type: str more...
- server4 - Domain name or IP address of the fourth FSSO collector agent. type: str more...
- server5 - Domain name or IP address of the fifth FSSO collector agent. type: str more...
- sni - Server Name Indication. type: str more...
- source_ip - Source IP for communications to FSSO agent. type: str more...
- source_ip6 - IPv6 source for communications to FSSO agent. type: str more...
- ssl - Enable/disable use of SSL. type: str choices: enable, disable more...
- ssl_server_host_ip_check - Enable/disable server host/IP verification. type: str choices: enable, disable more...
- ssl_trusted_cert - Trusted server certificate or CA certificate. Source vpn.certificate.remote.name vpn.certificate.ca.name. type: str more...
- type - Server type. type: str choices: default, fortinac, fortiems, fortiems-cloud more...
- user_info_server - LDAP server to get user information. Source user.ldap.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure Fortinet Single Sign On (FSSO) agents.
fortinet.fortios.fortios_user_fsso:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fsso:
group_poll_interval: "0"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ldap_poll: "enable"
ldap_poll_filter: "<your_own_value>"
ldap_poll_interval: "180"
ldap_server: "<your_own_value> (source user.ldap.name)"
logon_timeout: "5"
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: "8000"
port2: "8000"
port3: "8000"
port4: "8000"
port5: "8000"
server: "192.168.100.40"
server2: "<your_own_value>"
server3: "<your_own_value>"
server4: "<your_own_value>"
server5: "<your_own_value>"
sni: "<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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.