fortinet.fortios.fortios_user_local module – Configure local users in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.9).
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_local.
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 local 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 local users. |
|
Enable/disable overriding the policy-auth-concurrent under config system global. Choices:
|
|
Maximum number of concurrent logins permitted from the same user. |
|
Time in minutes before the authentication timeout for a user is reached. |
|
Two-factor recipient”s email address. |
|
Two-factor recipient”s FortiToken serial number. Source user.fortitoken.serial-number. |
|
User ID. |
|
Name of LDAP server with which the user must authenticate. Source user.ldap.name. |
|
Local user name. |
|
User”s password. |
|
Password policy to apply to this user, as defined in config user password-policy. Source user.password-policy.name. |
|
Time of the last password update. |
|
IKEv2 Postquantum Preshared Key Identity. |
|
IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). |
|
Quantum Key Distribution (QKD) profile. Source vpn.qkd.name. |
|
Name of RADIUS server with which the user must authenticate. Source user.radius.name. |
|
Two-factor recipient”s SMS server. Source system.sms-server.name. |
|
Two-factor recipient”s mobile phone number. |
|
Send SMS through FortiGuard or other external server. Choices:
|
|
Enable/disable allowing the local user to authenticate with the FortiGate unit. Choices:
|
|
Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name. |
|
Enable/disable two-factor authentication. Choices:
|
|
Authentication method by FortiToken Cloud. Choices:
|
|
Notification method for user activation by FortiToken Cloud. Choices:
|
|
Authentication method. Choices:
|
|
Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). Choices:
|
|
Enable/disable case and accent sensitivity when performing username matching (accents are stripped and case is ignored when disabled). Choices:
|
|
Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. |
|
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
The module supports check_mode.
Examples
- name: Configure local users.
fortinet.fortios.fortios_user_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_local:
auth_concurrent_override: "enable"
auth_concurrent_value: "0"
authtimeout: "0"
email_to: "<your_own_value>"
fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
id: "8"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_10"
passwd: "<your_own_value>"
passwd_policy: "<your_own_value> (source user.password-policy.name)"
passwd_time: "<your_own_value>"
ppk_identity: "<your_own_value>"
ppk_secret: "<your_own_value>"
qkd_profile: "<your_own_value> (source vpn.qkd.name)"
radius_server: "<your_own_value> (source user.radius.name)"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_phone: "<your_own_value>"
sms_server: "fortiguard"
status: "enable"
tacacs_plus_server: "<your_own_value> (source user.tacacs+.name)"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_notification: "email"
type: "password"
username_case_sensitivity: "disable"
username_sensitivity: "disable"
workstation: "<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: |