fmgr_user_local – Configure local users.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| user_local | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_local - no description type: dict
- auth-concurrent-override - Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: [disable, enable] more...
- auth-concurrent-value - Maximum number of concurrent logins permitted from the same user. type: int more...
- authtimeout - Time in minutes before the authentication timeout for a user is reached. type: int more...
- email-to - Two-factor recipients email address. type: str more...
- fortitoken - Two-factor recipients FortiToken serial number. type: str more...
- id - User ID. type: int more...
- ldap-server - Name of LDAP server with which the user must authenticate. type: str more...
- name - User name. type: str more...
- passwd - Users password. type: str more...
- passwd-policy - Password policy to apply to this user, as defined in config user password-policy. type: str more...
- ppk-identity - IKEv2 Postquantum Preshared Key Identity. type: str more...
- ppk-secret - IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
- radius-server - Name of RADIUS server with which the user must authenticate. type: str more...
- sms-custom-server - Two-factor recipients SMS server. type: str more...
- sms-phone - Two-factor recipients mobile phone number. type: str more...
- sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom] more...
- status - Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str choices: [disable, enable] more...
- tacacs+-server - Name of TACACS+ server with which the user must authenticate. type: str more...
- two-factor - Enable/disable two-factor authentication. type: str choices: [disable, fortitoken, email, sms, fortitoken-cloud] more...
- type - Authentication method. type: str choices: [password, radius, tacacs+, ldap] more...
- workstation - Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str more...
- two-factor-authentication - Authentication method by FortiToken Cloud. type: str choices: [fortitoken, email, sms] more...
- two-factor-notification - Notification method for user activation by FortiToken Cloud. type: str choices: [email, sms] more...
- username-case-sensitivity - Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). type: str choices: [disable, enable] more...
- username-case-insensitivity - Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). type: str choices: [disable, enable] more...
- username-sensitivity - Enable/disable case and accent sensitivity when performing username matching (accents are stripped and case is ignored when disabled). type: str choices: [disable, enable] more...
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: 'your_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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict