fmgd_user_local – Configure local users.
Added in version 1.1.0.
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- user_local - Configure local users. type: dict
- auth_concurrent_override (Alias name: auth-concurrent-override) Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: [disable, enable] more...
- auth_concurrent_value (Alias name: 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 (Alias name: email-to) Two-factor recipients email address. type: str more...
- fortitoken Two-factor recipients fortitoken serial number. type: list more...
- id User id. type: int more...
- ldap_server (Alias name: ldap-server) Name of ldap server with which the user must authenticate. type: list more...
- name Local user name. type: str more...
- passwd Users password. type: list more...
- passwd_policy (Alias name: passwd-policy) Password policy to apply to this user, as defined in config user password-policy. type: list more...
- ppk_identity (Alias name: ppk-identity) Ikev2 postquantum preshared key identity. type: str more...
- ppk_secret (Alias name: ppk-secret) Ikev2 postquantum preshared key (ascii string or hexadecimal encoded with a leading 0x). type: list more...
- radius_server (Alias name: radius-server) Name of radius server with which the user must authenticate. type: list more...
- sms_custom_server (Alias name: sms-custom-server) Two-factor recipients sms server. type: list more...
- sms_phone (Alias name: sms-phone) Two-factor recipients mobile phone number. type: str more...
- sms_server (Alias name: 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 (Alias name: tacacs+-server) Name of tacacs+ server with which the user must authenticate. type: list more...
- two_factor (Alias name: two-factor) Enable/disable two-factor authentication. type: str choices: [disable, fortitoken, email, sms, fortitoken-cloud] more...
- two_factor_authentication (Alias name: two-factor-authentication) Authentication method by fortitoken cloud. type: str choices: [fortitoken, email, sms] more...
- two_factor_notification (Alias name: two-factor-notification) Notification method for user activation by fortitoken cloud. type: str choices: [email, sms] more...
- type Authentication method. type: str choices: [password, radius, tacacs+, ldap, saml] more...
- username_sensitivity (Alias name: 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...
- workstation Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str more...
- history1 History1. type: list more...
- history0 History0. type: list more...
- qkd_profile (Alias name: qkd-profile) Quantum key distribution (qkd) profile. type: list more...
- username_case_sensitivity (Alias name: 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 (Alias name: username-case-insensitivity) Username case insensitivity. type: str choices: [disable, enable] more...
- history10 History10. type: list more...
- history11 History11. type: list more...
- history12 History12. type: list more...
- history13 History13. type: list more...
- history14 History14. type: list more...
- history15 History15. type: list more...
- history16 History16. type: list more...
- history17 History17. type: list more...
- history18 History18. type: list more...
- history19 History19. type: list more...
- history2 History2. type: list more...
- history3 History3. type: list more...
- history4 History4. type: list more...
- history5 History5. type: list more...
- history6 History6. type: list more...
- history7 History7. type: list more...
- history8 History8. type: list more...
- history9 History9. type: list more...
- saml_server (Alias name: saml-server) Name of saml server with which the user must authenticate. type: list 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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure local users.
fortinet.fmgdevice.fmgd_user_local:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
user_local:
id: 0 # Required variable, integer
# auth_concurrent_override: <value in [disable, enable]>
# auth_concurrent_value: <integer>
# authtimeout: <integer>
# email_to: <string>
# fortitoken: <list or string>
# ldap_server: <list or string>
# name: <string>
# passwd: <list or string>
# passwd_policy: <list or string>
# ppk_identity: <string>
# ppk_secret: <list or string>
# radius_server: <list or string>
# sms_custom_server: <list or string>
# sms_phone: <string>
# sms_server: <value in [fortiguard, custom]>
# status: <value in [disable, enable]>
# tacacs__server: <list or string>
# two_factor: <value in [disable, fortitoken, email, ...]>
# two_factor_authentication: <value in [fortitoken, email, sms]>
# two_factor_notification: <value in [email, sms]>
# type: <value in [password, radius, tacacs+, ...]>
# username_sensitivity: <value in [disable, enable]>
# workstation: <string>
# history1: <list or string>
# history0: <list or string>
# qkd_profile: <list or string>
# username_case_sensitivity: <value in [disable, enable]>
# username_case_insensitivity: <value in [disable, enable]>
# history10: <list or string>
# history11: <list or string>
# history12: <list or string>
# history13: <list or string>
# history14: <list or string>
# history15: <list or string>
# history16: <list or string>
# history17: <list or string>
# history18: <list or string>
# history19: <list or string>
# history2: <list or string>
# history3: <list or string>
# history4: <list or string>
# history5: <list or string>
# history6: <list or string>
# history7: <list or string>
# history8: <list or string>
# history9: <list or string>
# saml_server: <list or 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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.