Docs4dev
Docs
ansible / latest / collections / fortinet / fortimanager / fmgr_user_local_module.html

fortinet.fortimanager.fmgr_user_local – Configure local users.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_local.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
user_local
dictionary
the top level parameters set
auth-concurrent-override
string
    Choices:
  • disable
  • enable
Enable/disable overriding the policy-auth-concurrent under config system global.
auth-concurrent-value
integer
Maximum number of concurrent logins permitted from the same user.
authtimeout
integer
Time in minutes before the authentication timeout for a user is reached.
email-to
string
Two-factor recipients email address.
fortitoken
string
Two-factor recipients FortiToken serial number.
id
integer
User ID.
ldap-server
string
Name of LDAP server with which the user must authenticate.
name
string
User name.
passwd
string
no description
passwd-policy
string
Password policy to apply to this user, as defined in config user password-policy.
ppk-identity
string
IKEv2 Postquantum Preshared Key Identity.
ppk-secret
string
no description
radius-server
string
Name of RADIUS server with which the user must authenticate.
sms-custom-server
string
Two-factor recipients SMS server.
sms-phone
string
Two-factor recipients mobile phone number.
sms-server
string
    Choices:
  • fortiguard
  • custom
Send SMS through FortiGuard or other external server.
status
string
    Choices:
  • disable
  • enable
Enable/disable allowing the local user to authenticate with the FortiGate unit.
tacacs+-server
string
Name of TACACS+ server with which the user must authenticate.
two-factor
string
    Choices:
  • disable
  • fortitoken
  • email
  • sms
  • fortitoken-cloud
Enable/disable two-factor authentication.
two-factor-authentication
string
    Choices:
  • fortitoken
  • email
  • sms
Authentication method by FortiToken Cloud.
two-factor-notification
string
    Choices:
  • email
  • sms
Notification method for user activation by FortiToken Cloud.
type
string
    Choices:
  • password
  • radius
  • tacacs+
  • ldap
Authentication method.
username-case-insensitivity
string
    Choices:
  • disable
  • enable
Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti...
username-case-sensitivity
string
    Choices:
  • disable
  • enable
Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti...
workstation
string
Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure local users.
     fmgr_user_local:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        user_local:
           auth-concurrent-override: <value in [disable, enable]>
           auth-concurrent-value: <value of integer>
           authtimeout: <value of integer>
           email-to: <value of string>
           fortitoken: <value of string>
           id: <value of integer>
           ldap-server: <value of string>
           name: <value of string>
           passwd: <value of string>
           passwd-policy: <value of string>
           ppk-identity: <value of string>
           ppk-secret: <value of string>
           radius-server: <value of string>
           sms-custom-server: <value of string>
           sms-phone: <value of string>
           sms-server: <value in [fortiguard, custom]>
           status: <value in [disable, enable]>
           tacacs+-server: <value of string>
           two-factor: <value in [disable, fortitoken, email, ...]>
           type: <value in [password, radius, tacacs+, ...]>
           workstation: <value of string>
           two-factor-authentication: <value in [fortitoken, email, sms]>
           two-factor-notification: <value in [email, sms]>
           username-case-sensitivity: <value in [disable, enable]>
           username-case-insensitivity: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_local_module.html