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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - Configure local users. type: dict
- auth-concurrent-override - Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: [disable, enable]
- auth-concurrent-value - Maximum number of concurrent logins permitted from the same user. type: int
- authtimeout - Time in minutes before the authentication timeout for a user is reached. type: int
- email-to - Two-factor recipients email address. type: str
- fortitoken - Two-factor recipients FortiToken serial number. type: str
- id - User ID. type: int
- ldap-server - Name of LDAP server with which the user must authenticate. type: str
- name - User name. type: str
- passwd - No description for the parameter type: str
- passwd-policy - Password policy to apply to this user, as defined in config user password-policy. type: str
- ppk-identity - IKEv2 Postquantum Preshared Key Identity. type: str
- ppk-secret - No description for the parameter type: str
- radius-server - Name of RADIUS server with which the user must authenticate. type: str
- sms-custom-server - Two-factor recipients SMS server. type: str
- sms-phone - Two-factor recipients mobile phone number. type: str
- sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom]
- status - Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str choices: [disable, enable]
- tacacs+-server - Name of TACACS+ server with which the user must authenticate. type: str
- two-factor - Enable/disable two-factor authentication. type: str choices: [disable, fortitoken, email, sms, fortitoken-cloud]
- type - Authentication method. type: str choices: [password, radius, tacacs+, ldap]
- workstation - Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str
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>
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