fortios_user_local – Configure local users 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 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
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_local - Configure local users. type: dict more...
- auth_concurrent_override - Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: enable, disable more...
- auth_concurrent_value - Maximum number of concurrent logins permitted from the same user. type: int more...
- authtimeout - Time in minutes before the authentication timeout for a user is reached. type: int more...
- email_to - Two-factor recipient"s email address. type: str more...
- fortitoken - Two-factor recipient"s FortiToken serial number. Source user.fortitoken.serial-number. type: str more...
- id - User ID. type: int more...
- ldap_server - Name of LDAP server with which the user must authenticate. Source user.ldap.name. type: str more...
- name - Local user name. type: str required: true more...
- passwd - User"s password. type: str more...
- passwd_policy - Password policy to apply to this user, as defined in config user password-policy. Source user.password-policy.name. type: str more...
- passwd_time - Time of the last password update. type: str more...
- ppk_identity - IKEv2 Postquantum Preshared Key Identity. type: str more...
- ppk_secret - IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
- qkd_profile - Quantum Key Distribution (QKD) profile. Source vpn.qkd.name. type: str more...
- radius_server - Name of RADIUS server with which the user must authenticate. Source user.radius.name. type: str more...
- sms_custom_server - Two-factor recipient"s SMS server. Source system.sms-server.name. type: str more...
- sms_phone - Two-factor recipient"s mobile phone number. type: str more...
- sms_server - Send SMS through FortiGuard or other external server. type: str choices: fortiguard, custom more...
- status - Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str choices: enable, disable more...
- tacacs_plus_server - Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name. type: str more...
- two_factor - Enable/disable two-factor authentication. type: str choices: disable, fortitoken, fortitoken-cloud, email, sms more...
- two_factor_authentication - Authentication method by FortiToken Cloud. type: str choices: fortitoken, email, sms more...
- two_factor_notification - Notification method for user activation by FortiToken Cloud. type: str choices: email, sms more...
- type - Authentication method. type: str choices: password, radius, tacacs+, ldap more...
- username_case_sensitivity - Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). type: str choices: disable, enable more...
- username_sensitivity - Enable/disable case and accent sensitivity when performing username matching (accents are stripped and case is ignored when disabled). type: str choices: disable, enable more...
- workstation - Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: 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
Status
This module is not guaranteed to have a backwards compatible interface.