fortios_user_local.rst

source:	fortios_user_local.py
orphan:

fortios_user_local -- Configure local users in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_user_local	v6.0.0 -> latest

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...

  	Supported Version Ranges
  user_local	v6.0.0 -> latest

• auth_concurrent_override - Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: enable, disable more...

  	Supported Version Ranges
  auth_concurrent_override	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_concurrent_value - Maximum number of concurrent logins permitted from the same user. type: int more...

  	Supported Version Ranges
  auth_concurrent_value	v6.0.0 -> latest

• authtimeout - Time in minutes before the authentication timeout for a user is reached. type: int more...

  	Supported Version Ranges
  authtimeout	v6.0.0 -> latest

• email_to - Two-factor recipient"s email address. type: str more...

  	Supported Version Ranges
  email_to	v6.0.0 -> latest

• fortitoken - Two-factor recipient"s FortiToken serial number. Source user.fortitoken.serial-number. type: str more...

  	Supported Version Ranges
  fortitoken	v6.0.0 -> latest

• id - User ID. type: int more...

  	Supported Version Ranges
  id	v6.0.0 -> v7.0.5	v7.2.0 -> v7.2.0

• ldap_server - Name of LDAP server with which the user must authenticate. Source user.ldap.name. type: str more...

  	Supported Version Ranges
  ldap_server	v6.0.0 -> latest

• name - Local user name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• passwd - User"s password. type: str more...

  	Supported Version Ranges
  passwd	v6.0.0 -> latest

• passwd_policy - Password policy to apply to this user, as defined in config user password-policy. Source user.password-policy.name. type: str more...

  	Supported Version Ranges
  passwd_policy	v6.0.0 -> latest

• passwd_time - Time of the last password update. type: str more...

  	Supported Version Ranges
  passwd_time	v6.0.0 -> latest

• ppk_identity - IKEv2 Postquantum Preshared Key Identity. type: str more...

  	Supported Version Ranges
  ppk_identity	v6.0.0 -> latest

• ppk_secret - IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). type: str more...

  	Supported Version Ranges
  ppk_secret	v6.0.0 -> latest

• radius_server - Name of RADIUS server with which the user must authenticate. Source user.radius.name. type: str more...

  	Supported Version Ranges
  radius_server	v6.0.0 -> latest

• sms_custom_server - Two-factor recipient"s SMS server. Source system.sms-server.name. type: str more...

  	Supported Version Ranges
  sms_custom_server	v6.0.0 -> latest

• sms_phone - Two-factor recipient"s mobile phone number. type: str more...

  	Supported Version Ranges
  sms_phone	v6.0.0 -> latest

• sms_server - Send SMS through FortiGuard or other external server. type: str choices: fortiguard, custom more...

  	Supported Version Ranges
  sms_server	v6.0.0 -> latest
  [fortiguard]	v6.0.0 -> latest
  [custom]	v6.0.0 -> latest

• status - Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• tacacs_plus_server - Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name. type: str more...

  	Supported Version Ranges
  tacacs_plus_server	v6.0.0 -> latest

• two_factor - Enable/disable two-factor authentication. type: str choices: disable, fortitoken, fortitoken-cloud, email, sms more...

  	Supported Version Ranges
  two_factor	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [fortitoken]	v6.0.0 -> latest
  [fortitoken-cloud]	v6.2.0 -> latest
  [email]	v6.0.0 -> latest
  [sms]	v6.0.0 -> latest

• two_factor_authentication - Authentication method by FortiToken Cloud. type: str choices: fortitoken, email, sms more...

  	Supported Version Ranges
  two_factor_authentication	v6.2.0 -> v6.2.0	v6.2.5 -> latest
  [fortitoken]	v6.0.0 -> latest
  [email]	v6.0.0 -> latest
  [sms]	v6.0.0 -> latest

• two_factor_notification - Notification method for user activation by FortiToken Cloud. type: str choices: email, sms more...

  	Supported Version Ranges
  two_factor_notification	v6.2.0 -> v6.2.0	v6.2.5 -> latest
  [email]	v6.0.0 -> latest
  [sms]	v6.0.0 -> latest

• type - Authentication method. type: str choices: password, radius, tacacs+, ldap more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [password]	v6.0.0 -> latest
  [radius]	v6.0.0 -> latest
  [tacacs+]	v6.0.0 -> latest
  [ldap]	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  username_case_sensitivity	v6.0.0 -> v6.0.0	v6.0.11 -> v6.2.0	v6.2.5 -> v7.0.0
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  username_sensitivity	v7.0.1 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• workstation - Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str more...

  	Supported Version Ranges
  workstation	v6.0.0 -> latest

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>"
          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.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.