fortinet.fortimanager.fmgr_user_local module – Configure local users.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Enable/disable overriding the policy-auth-concurrent under config system global. Choices:
|
|
Maximum number of concurrent logins permitted from the same user. |
|
Time in minutes before the authentication timeout for a user is reached. |
|
Two-factor recipients email address. |
|
Two-factor recipients FortiToken serial number. |
|
(list) History0. |
|
(list) History1. |
|
User ID. |
|
Name of LDAP server with which the user must authenticate. |
|
User name. |
|
(list) Users password. |
|
Password policy to apply to this user, as defined in config user password-policy. |
|
IKEv2 Postquantum Preshared Key Identity. |
|
(list) IKEv2 Postquantum Preshared Key |
|
Quantum Key Distribution |
|
Name of RADIUS server with which the user must authenticate. |
|
Two-factor recipients SMS server. |
|
Two-factor recipients mobile phone number. |
|
Send SMS through FortiGuard or other external server. Choices:
|
|
Enable/disable allowing the local user to authenticate with the FortiGate unit. Choices:
|
|
Name of TACACS+ server with which the user must authenticate. |
|
Enable/disable two-factor authentication. Choices:
|
|
Authentication method by FortiToken Cloud. Choices:
|
|
Notification method for user activation by FortiToken Cloud. Choices:
|
|
Authentication method. Choices:
|
|
Enable/disable case sensitivity when performing username matching Choices:
|
|
Enable/disable case sensitivity when performing username matching Choices:
|
|
Enable/disable case and accent sensitivity when performing username matching Choices:
|
|
Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |