fortinet.fortios.fortios_user_fsso_polling module – Configure FSSO active directory servers for polling mode in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_fsso_polling
.
New in fortinet.fortios 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_polling 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
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 FSSO active directory servers for polling mode. |
|
LDAP Group Info. |
|
Name. |
|
Default domain managed by this Active Directory server. |
|
Active Directory server ID. see <a href=’#notes’>Notes</a>. |
|
LDAP server name used in LDAP connection strings. Source user.ldap.name. |
|
Number of hours of logon history to keep, 0 means keep all history. |
|
Password required to log into this Active Directory server. |
|
Polling frequency (every 1 to 30 seconds). |
|
Port to communicate with this Active Directory server. |
|
Host name or IP address of the Active Directory server. |
|
Enable/disable support of NTLMv1 for Samba authentication. Choices:
|
|
Enable/disable support of SMBv1 for Samba. Choices:
|
|
Enable/disable polling for the status of this Active Directory server. Choices:
|
|
User name required to log into this Active Directory server. |
|
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: |
Notes
Note
We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure FSSO active directory servers for polling mode.
fortinet.fortios.fortios_user_fsso_polling:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_fsso_polling:
adgrp:
-
name: "default_name_4"
default_domain: "<your_own_value>"
id: "6"
ldap_server: "<your_own_value> (source user.ldap.name)"
logon_history: "8"
password: "<your_own_value>"
polling_frequency: "10"
port: "0"
server: "192.168.100.40"
smb_ntlmv1_auth: "enable"
smbv1: "enable"
status: "enable"
user: "<your_own_value>"
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: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |