fortios_user_fsso – Configure Fortinet Single Sign On (FSSO) agents in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- 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
- ldap_server - LDAP server to get group information. Source user.ldap.name. type: str
- name - Name. type: str required: True
- password - Password of the first FSSO collector agent. type: str
- password2 - Password of the second FSSO collector agent. type: str
- password3 - Password of the third FSSO collector agent. type: str
- password4 - Password of the fourth FSSO collector agent. type: str
- password5 - Password of the fifth FSSO collector agent. type: str
- port - Port of the first FSSO collector agent. type: int
- port2 - Port of the second FSSO collector agent. type: int
- port3 - Port of the third FSSO collector agent. type: int
- port4 - Port of the fourth FSSO collector agent. type: int
- port5 - Port of the fifth FSSO collector agent. type: int
- server - Domain name or IP address of the first FSSO collector agent. type: str
- server2 - Domain name or IP address of the second FSSO collector agent. type: str
- server3 - Domain name or IP address of the third FSSO collector agent. type: str
- server4 - Domain name or IP address of the fourth FSSO collector agent. type: str
- server5 - Domain name or IP address of the fifth FSSO collector agent. type: str
- source_ip - Source IP for communications to FSSO agent. type: str
- source_ip6 - IPv6 source for communications to FSSO agent. type: str
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:
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_4"
password: "<your_own_value>"
password2: "<your_own_value>"
password3: "<your_own_value>"
password4: "<your_own_value>"
password5: "<your_own_value>"
port: "10"
port2: "11"
port3: "12"
port4: "13"
port5: "14"
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>"
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