fortios_user_fsso_polling – Configure FSSO active directory servers for polling mode 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_polling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_user_fsso_polling | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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_polling - Configure FSSO active directory servers for polling mode. type: dict more...
- adgrp - LDAP Group Info. type: list more...
- name - Name. type: str more...
- default_domain - Default domain managed by this Active Directory server. type: str more...
- id - Active Directory server ID. type: int required: true more...
- ldap_server - LDAP server name used in LDAP connection strings. Source user.ldap.name. type: str more...
- logon_history - Number of hours of logon history to keep, 0 means keep all history. type: int more...
- password - Password required to log into this Active Directory server. type: str more...
- polling_frequency - Polling frequency (every 1 to 30 seconds). type: int more...
- port - Port to communicate with this Active Directory server. type: int more...
- server - Host name or IP address of the Active Directory server. type: str more...
- smb_ntlmv1_auth - Enable/disable support of NTLMv1 for Samba authentication. type: str choices: enable, disable more...
- smbv1 - Enable/disable support of SMBv1 for Samba. type: str choices: enable, disable more...
- status - Enable/disable polling for the status of this Active Directory server. type: str choices: enable, disable more...
- user - User name required to log into this Active Directory server. type: str more...
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 FSSO active directory servers for polling mode.
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: 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