fmgr_user_ldap_dynamicmapping – Configure LDAP server entries.

Added in version 2.0.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 v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.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
  • 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
  • adom - The parameter in requested url type: str required: true
  • ldap - The parameter in requested url type: str required: true
  • user_ldap_dynamicmapping - Configure LDAP server entries. type: dict
    • _scope type: list more...
      • name type: str more...
      • vdom type: str more...
    • account_key_filter (Alias name: account-key-filter) type: str more...
    • account_key_name (Alias name: account-key-name) type: str more...
    • account_key_processing (Alias name: account-key-processing) type: str choices: [same, strip] more...
    • ca_cert (Alias name: ca-cert) type: str more...
    • cnid type: str more...
    • dn type: str more...
    • filter type: str more...
    • group type: str more...
    • group_filter (Alias name: group-filter) type: str more...
    • group_member_check (Alias name: group-member-check) type: str choices: [user-attr, group-object, posix-group-object] more...
    • group_object_filter (Alias name: group-object-filter) type: str more...
    • group_object_search_base (Alias name: group-object-search-base) type: str more...
    • group_search_base (Alias name: group-search-base) type: str more...
    • member_attr (Alias name: member-attr) type: str more...
    • obtain_user_info (Alias name: obtain-user-info) type: str choices: [disable, enable] more...
    • password type: list more...
    • password_expiry_warning (Alias name: password-expiry-warning) type: str choices: [disable, enable] more...
    • password_renewal (Alias name: password-renewal) type: str choices: [disable, enable] more...
    • port type: int more...
    • retrieve_protection_profile (Alias name: retrieve-protection-profile) type: str more...
    • search_type (Alias name: search-type) type: list choices: [nested, recursive] more...
    • secondary_server (Alias name: secondary-server) type: str more...
    • secure type: str choices: [disable, starttls, ldaps] more...
    • server type: str more...
    • server_identity_check (Alias name: server-identity-check) type: str choices: [disable, enable] more...
    • source_ip (Alias name: source-ip) type: str more...
    • ssl_min_proto_version (Alias name: ssl-min-proto-version) type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3] more...
    • tertiary_server (Alias name: tertiary-server) type: str more...
    • type type: str choices: [simple, anonymous, regular] more...
    • user_info_exchange_server (Alias name: user-info-exchange-server) type: str more...
    • username type: str more...
    • two_factor (Alias name: two-factor) type: str choices: [disable, fortitoken-cloud] more...
    • interface type: str more...
    • interface_select_method (Alias name: interface-select-method) type: str choices: [auto, sdwan, specify] more...
    • two_factor_authentication (Alias name: two-factor-authentication) type: str choices: [fortitoken, email, sms] more...
    • two_factor_notification (Alias name: two-factor-notification) type: str choices: [email, sms] more...
    • antiphish Enable/disable antiphishing credential backend. type: str choices: [disable, enable] more...
    • password_attr (Alias name: password-attr) Name of attribute to get password hash. type: str more...
    • source_port (Alias name: source-port) Source port to be used for communication with the ldap server. type: int more...
    • client_cert (Alias name: client-cert) Client certificate name. type: str more...
    • client_cert_auth (Alias name: client-cert-auth) Enable/disable using client certificate for tls authentication. type: str choices: [disable, enable] more...
    • max_connections (Alias name: max-connections) type: int more...
    • two_factor_filter (Alias name: two-factor-filter) Filter used to synchronize users to fortitoken cloud. type: str more...
    • account_key_upn_san (Alias name: account-key-upn-san) Define san in certificate for user principle name matching. type: str choices: [othername, rfc822name, dnsname] more...
    • account_key_cert_field (Alias name: account-key-cert-field) Define subject identity field in certificate for user access right checking. type: str choices: [othername, rfc822name, dnsname] 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_user_ldap_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ldap: ansible-test-ldap # name
        state: present
        user_ldap_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          dn: ansible-test-dn
          password: fortinet
          port: 9000
          server: ansible
          username: ansible-test-dyn

- 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 dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap_dynamicmapping"
          params:
            adom: "ansible"
            ldap: "ansible-test-ldap" # name
            dynamic_mapping: "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:

  • 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)