fortinet.fortimanager.fmgr_user_local – Configure local users.

Note

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

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

Comments

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

the directive to create, update or delete an object

Choices:

  • present

  • absent

user_local

dictionary

the top level parameters set

auth-concurrent-override

string

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

Choices:

  • disable

  • enable

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

Users password.

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

IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x).

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

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

string

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

two-factor

string

Enable/disable two-factor authentication.

Choices:

  • disable

  • fortitoken

  • email

  • sms

  • fortitoken-cloud

two-factor-authentication

string

Authentication method by FortiToken Cloud.

Choices:

  • fortitoken

  • email

  • sms

two-factor-notification

string

Notification method for user activation by FortiToken Cloud.

Choices:

  • email

  • sms

type

string

Authentication method.

Choices:

  • password

  • radius

  • tacacs+

  • ldap

username-case-insensitivity

string

Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti…

Choices:

  • disable

  • enable

username-case-sensitivity

string

Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as disti…

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

  • 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: fortimanager00
  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
        adom: ansible
        state: present
        user_local:
           id: 1
           name: ansible-test-local
           passwd: fortinet
           status: disable

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the local users
     fmgr_fact:
       facts:
           selector: 'user_local'
           params:
               adom: 'ansible'
               local: ''

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)