fortios_user_local – Configure local users 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 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.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
  • state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
  • user_local - Configure local users. type: dict
    • auth_concurrent_override - Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: enable, disable
    • auth_concurrent_value - Maximum number of concurrent logins permitted from the same user. type: int
    • authtimeout - Time in minutes before the authentication timeout for a user is reached. type: int
    • email_to - Two-factor recipient"s email address. type: str
    • fortitoken - Two-factor recipient"s FortiToken serial number. Source user.fortitoken.serial-number. type: str
    • id - User ID. type: int
    • ldap_server - Name of LDAP server with which the user must authenticate. Source user.ldap.name. type: str
    • name - User name. type: str required: True
    • passwd - User"s password. type: str
    • passwd_policy - Password policy to apply to this user, as defined in config user password-policy. Source user.password-policy.name. type: str
    • passwd_time - Time of the last password update. type: str
    • ppk_secret - IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). type: str
    • radius_server - Name of RADIUS server with which the user must authenticate. Source user.radius.name. type: str
    • sms_custom_server - Two-factor recipient"s SMS server. Source system.sms-server.name. type: str
    • sms_phone - Two-factor recipient"s mobile phone number. type: str
    • sms_server - Send SMS through FortiGuard or other external server. type: str choices: fortiguard, custom
    • status - Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str choices: enable, disable
    • tacacs+_server - Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name. type: str
    • two_factor - Enable/disable two-factor authentication. type: str choices: disable, fortitoken, email, sms
    • type - Authentication method. type: str choices: password, radius, tacacs+, ldap
    • workstation - Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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 local users.
    fortios_user_local:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_local:
        auth_concurrent_override: "enable"
        auth_concurrent_value: "4"
        authtimeout: "5"
        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_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+_server: "<your_own_value> (source user.tacacs+.name)"
        two_factor: "disable"
        type: "password"
        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.