fmgr_user_local_dynamicmapping – Configure local users.

Added in version 2.15.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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: v8.0.0 -> 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
  • 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
  • revision_note - The change note that can be specified when an object is created or updated. type: string required: false
  • adom - The parameter in requested url type: str required: true
  • local - The parameter in requested url type: str required: true
  • user_local_dynamicmapping - Configure local users. type: dict
    • _scope Scope. type: list more...
      • name Name. type: str more...
      • vdom Vdom. type: str more...
    • 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...
    • fabric_force_sync (Alias name: fabric-force-sync) Enable/disable forced synchronization of configuration objects from the root fortigate unit to the downstream devices. type: str choices: [disable, enable] more...
    • fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable] more...
    • fabric_object_source (Alias name: fabric-object-source) Source of truth for fabric object. type: str choices: [member, local, root] more...
    • fortitoken Two-factor recipients fortitoken serial number. type: list more...
    • history0 History0. type: list more...
    • history1 History1. type: list 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...
    • id Id. type: int more...
    • ldap_server (Alias name: ldap-server) Name of ldap server with which the user must authenticate. type: list 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...
    • passwd_time (Alias name: passwd-time) Time of the last password update. type: str 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...
    • qkd_profile (Alias name: qkd-profile) Quantum key distribution (qkd) profile. type: list more...
    • radius_server (Alias name: radius-server) Name of radius server with which the user must authenticate. type: list more...
    • saml_server (Alias name: saml-server) Name of saml 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_provider (Alias name: sms-provider) Sms provider. type: list 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_case_insensitivity (Alias name: username-case-insensitivity) Username case insensitivity. type: str choices: [disable, enable] more...
    • username_case_sensitivity (Alias name: username-case-sensitivity) Username case sensitivity. type: str choices: [disable, enable] 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...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str 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...

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: Test local user dynamic mappings
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create the parent local user
      fortinet.fortimanager.fmgr_user_local:
        enable_log: true
        adom: root
        state: present
        user_local:
          name: test_local_user
          status: disable

    - name: Configure a local user dynamic mapping
      fortinet.fortimanager.fmgr_user_local_dynamicmapping:
        enable_log: true
        adom: root
        local: test_local_user
        user_local_dynamicmapping:
          _scope:
            - name: test_device
              vdom: root

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.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)