fortinet.fortimanager.fmgr_user_local module – Configure local users.

Note

This module is part of the fortinet.fortimanager collection (version 2.11.0).

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

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

user_local

dictionary

The top level parameters set.

auth_concurrent_override

aliases: auth-concurrent-override

string

Enable/disable overriding the policy-auth-concurrent under config system global.

Choices:

  • "disable"

  • "enable"

auth_concurrent_value

aliases: 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

aliases: email-to

string

Two-factor recipients email address.

fortitoken

string

Two-factor recipients FortiToken serial number.

history0

any

(list) History0.

history1

any

(list) History1.

id

integer

User ID.

ldap_server

aliases: ldap-server

string

Name of LDAP server with which the user must authenticate.

name

string / required

User name.

passwd

any

(list) Users password.

passwd_policy

aliases: passwd-policy

string

Password policy to apply to this user, as defined in config user password-policy.

ppk_identity

aliases: ppk-identity

string

IKEv2 Postquantum Preshared Key Identity.

ppk_secret

aliases: ppk-secret

any

(list) IKEv2 Postquantum Preshared Key

qkd_profile

aliases: qkd-profile

string

Quantum Key Distribution

radius_server

aliases: radius-server

string

Name of RADIUS server with which the user must authenticate.

saml_server

aliases: saml-server

any

(list) Name of SAML server with which the user must authenticate.

sms_custom_server

aliases: sms-custom-server

string

Two-factor recipients SMS server.

sms_phone

aliases: sms-phone

string

Two-factor recipients mobile phone number.

sms_server

aliases: sms-server

string

Send SMS through FortiGuard or other external server.

Choices:

  • "fortiguard"

  • "custom"

status

string

Enable/disable allowing the local user to authenticate with the FortiGate unit.

Choices:

  • "disable"

  • "enable"

tacacs__server

aliases: tacacs+-server

string

Name of TACACS+ server with which the user must authenticate.

two_factor

aliases: two-factor

string

Enable/disable two-factor authentication.

Choices:

  • "disable"

  • "fortitoken"

  • "email"

  • "sms"

  • "fortitoken-cloud"

two_factor_authentication

aliases: two-factor-authentication

string

Authentication method by FortiToken Cloud.

Choices:

  • "fortitoken"

  • "email"

  • "sms"

two_factor_notification

aliases: two-factor-notification

string

Notification method for user activation by FortiToken Cloud.

Choices:

  • "email"

  • "sms"

type

string

Authentication method.

Choices:

  • "password"

  • "radius"

  • "tacacs+"

  • "ldap"

  • "saml"

username_case_insensitivity

aliases: username-case-insensitivity

string

Enable/disable case sensitivity when performing username matching

Choices:

  • "disable"

  • "enable"

username_case_sensitivity

aliases: username-case-sensitivity

string

Enable/disable case sensitivity when performing username matching

Choices:

  • "disable"

  • "enable"

username_sensitivity

aliases: username-sensitivity

string

Enable/disable case and accent sensitivity when performing username matching

Choices:

  • "disable"

  • "enable"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure local users.
      fortinet.fortimanager.fmgr_user_local:
        bypass_validation: false
        adom: ansible
        state: present
        user_local:
          id: 1
          name: ansible-test-local
          passwd: fortinet
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the local users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_local"
          params:
            adom: "ansible"
            local: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)