fortinet.fortios.fortios_user_setting module – Configure user authentication setting in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_setting
.
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 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.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:
|
|
Configure user authentication setting. |
|
Time in seconds an IP address is denied access after failing to authenticate five times within one minute. |
|
HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name. |
|
HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. |
|
Enable/disable use of HTTP basic authentication for identity-based firewall policies. Choices:
|
|
Maximum number of failed authentication attempts before the user is blocked. |
|
Lockout period in seconds after too many login failures. |
|
Maximum number of failed login attempts before login lockout is triggered. |
|
Always/implicitly trigger firewall authentication on demand. Choices:
|
|
Time in minutes before captive portal user have to re-authenticate (1 - 30 min). |
|
Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Non-standard port for firewall user authentication. |
|
Service type. Choices:
|
|
Enable/disable redirecting HTTP user authentication to more secure HTTPS. Choices:
|
|
Enable/disable source MAC for user identity. Choices:
|
|
Allow/forbid SSL re-negotiation for HTTPS authentication. Choices:
|
|
Maximum supported protocol version for SSL/TLS connections . Choices:
|
|
Minimum supported protocol version for SSL/TLS connections . Choices:
|
|
Set signature algorithms related to HTTPS authentication (affects TLS version <= 1.2 only). Choices:
|
|
Time in minutes before the firewall user authentication timeout requires the user to re-authenticate. |
|
Control if authenticated users have to login again after a hard timeout, after an idle timeout, or after a session timeout. Choices:
|
|
Supported firewall policy authentication protocols/methods. Choices:
|
|
Default password policy to apply to all local users unless otherwise specified, as defined in config user password-policy. Source user .password-policy.name. |
|
Enable/disable per policy disclaimer. Choices:
|
|
Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server session timeouts. Choices:
|
|
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
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure user authentication setting.
fortinet.fortios.fortios_user_setting:
vdom: "{{ vdom }}"
user_setting:
auth_blackout_time: "0"
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: "5"
auth_lockout_duration: "0"
auth_lockout_threshold: "3"
auth_on_demand: "always"
auth_portal_timeout: "3"
auth_ports:
-
id: "13"
port: "1024"
type: "http"
auth_secure_http: "enable"
auth_src_mac: "enable"
auth_ssl_allow_renegotiation: "enable"
auth_ssl_max_proto_version: "sslv3"
auth_ssl_min_proto_version: "default"
auth_ssl_sigalgs: "no-rsa-pss"
auth_timeout: "5"
auth_timeout_type: "idle-timeout"
auth_type: "http"
default_user_password_policy: "<your_own_value> (source user.password-policy.name)"
per_policy_disclaimer: "enable"
radius_ses_timeout_act: "hard-timeout"
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: |