fortios_user_setting – Configure user authentication setting 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 setting 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
- user_setting - Configure user authentication setting. type: dict
- auth_blackout_time - Time in seconds an IP address is denied access after failing to authenticate five times within one minute. type: int
- auth_ca_cert - HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name. type: str
- auth_cert - HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. type: str
- auth_http_basic - Enable/disable use of HTTP basic authentication for identity-based firewall policies. type: str choices: enable, disable
- auth_invalid_max - Maximum number of failed authentication attempts before the user is blocked. type: int
- auth_lockout_duration - Lockout period in seconds after too many login failures. type: int
- auth_lockout_threshold - Maximum number of failed login attempts before login lockout is triggered. type: int
- auth_portal_timeout - Time in minutes before captive portal user have to re-authenticate (1 - 30 min). type: int
- auth_ports - Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET. type: list
- id - ID. type: int required: True
- port - Non-standard port for firewall user authentication. type: int
- type - Service type. type: str choices: http, https, ftp, telnet
- auth_secure_http - Enable/disable redirecting HTTP user authentication to more secure HTTPS. type: str choices: enable, disable
- auth_ssl_allow_renegotiation - Allow/forbid SSL re-negotiation for HTTPS authentication. type: str choices: enable, disable
- auth_timeout - Time in minutes before the firewall user authentication timeout requires the user to re-authenticate. type: int
- auth_timeout_type - Control if authenticated users have to login again after a hard timeout, after an idle timeout, or after a session timeout. type: str choices: idle-timeout, hard-timeout, new-session
- auth_type - Supported firewall policy authentication protocols/methods. type: str choices: http, https, ftp, telnet
- radius_ses_timeout_act - Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server session timeouts. type: str choices: hard-timeout, ignore-timeout
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 user authentication setting.
fortios_user_setting:
vdom: "{{ vdom }}"
user_setting:
auth_blackout_time: "3"
auth_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_http_basic: "enable"
auth_invalid_max: "7"
auth_lockout_duration: "8"
auth_lockout_threshold: "9"
auth_portal_timeout: "10"
auth_ports:
-
id: "12"
port: "13"
type: "http"
auth_secure_http: "enable"
auth_ssl_allow_renegotiation: "enable"
auth_timeout: "17"
auth_timeout_type: "idle-timeout"
auth_type: "http"
radius_ses_timeout_act: "hard-timeout"
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