fmgr_user_ldap – Configure LDAP server entries.

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_ldap 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_ldap - no description type: dict
    • account-key-filter - Account key filter, using the UPN as the search filter. type: str more...
    • account-key-processing - Account key processing operation, either keep or strip domain string of UPN in the token. type: str choices: [same, strip] more...
    • ca-cert - CA certificate name. type: str more...
    • cnid - Common name identifier for the LDAP server. type: str more...
    • dn - Distinguished name used to look up entries on the LDAP server. type: str more...
    • dynamic_mapping - Dynamic_Mapping. type: array more...
      • _scope - _Scope. type: array more...
        • name - Name. type: str more...
        • vdom - Vdom. type: str more...
      • account-key-filter - Account key filter, using the UPN as the search filter. type: str more...
      • account-key-name - Account-Key-Name. type: str more...
      • account-key-processing - Account key processing operation, either keep or strip domain string of UPN in the token. type: str choices: [same, strip] more...
      • ca-cert - CA certificate name. type: str more...
      • cnid - Common name identifier for the LDAP server. type: str more...
      • dn - Distinguished name used to look up entries on the LDAP server. type: str more...
      • filter - Filter. type: str more...
      • group - Group. type: str more...
      • group-filter - Filter used for group matching. type: str more...
      • group-member-check - Group member checking methods. type: str choices: [user-attr, group-object, posix-group-object] more...
      • group-object-filter - Filter used for group searching. type: str more...
      • group-object-search-base - Group-Object-Search-Base. type: str more...
      • group-search-base - Search base used for group searching. type: str more...
      • member-attr - Name of attribute from which to get group membership. type: str more...
      • obtain-user-info - Enable/disable obtaining of user information. type: str choices: [disable, enable] more...
      • password - Password for initial binding. type: str more...
      • password-expiry-warning - Enable/disable password expiry warnings. type: str choices: [disable, enable] more...
      • password-renewal - Enable/disable online password renewal. type: str choices: [disable, enable] more...
      • port - Port to be used for communication with the LDAP server (default = 389). type: int more...
      • retrieve-protection-profile - Retrieve-Protection-Profile. type: str more...
      • search-type - Search type. type: array choices: [nested, recursive] more...
      • secondary-server - Secondary LDAP server CN domain name or IP. type: str more...
      • secure - Port to be used for authentication. type: str choices: [disable, starttls, ldaps] more...
      • server - LDAP server CN domain name or IP. type: str more...
      • server-identity-check - Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). type: str choices: [disable, enable] more...
      • source-ip - Source IP for communications to LDAP server. type: str more...
      • ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3] more...
      • tertiary-server - Tertiary LDAP server CN domain name or IP. type: str more...
      • type - Authentication type for LDAP searches. type: str choices: [simple, anonymous, regular] more...
      • user-info-exchange-server - MS Exchange server from which to fetch user information. type: str more...
      • username - Username (full DN) for initial binding. type: str more...
      • two-factor - Enable/disable two-factor authentication. type: str choices: [disable, fortitoken-cloud] more...
      • interface - Specify outgoing interface to reach server. type: str more...
      • interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] 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...
      • antiphish - Enable/disable AntiPhishing credential backend. type: str choices: [disable, enable] more...
      • password-attr - Name of attribute to get password hash. type: str more...
      • source-port - Source port to be used for communication with the LDAP server. type: int more...
      • client-cert - Client certificate name. type: str more...
      • client-cert-auth - Enable/disable using client certificate for TLS authentication. type: str choices: [disable, enable] more...
    • group-filter - Filter used for group matching. type: str more...
    • group-member-check - Group member checking methods. type: str choices: [user-attr, group-object, posix-group-object] more...
    • group-object-filter - Filter used for group searching. type: str more...
    • group-search-base - Search base used for group searching. type: str more...
    • member-attr - Name of attribute from which to get group membership. type: str more...
    • name - LDAP server entry name. type: str more...
    • password - Password for initial binding. type: str more...
    • password-expiry-warning - Enable/disable password expiry warnings. type: str choices: [disable, enable] more...
    • password-renewal - Enable/disable online password renewal. type: str choices: [disable, enable] more...
    • port - Port to be used for communication with the LDAP server (default = 389). type: int more...
    • secondary-server - Secondary LDAP server CN domain name or IP. type: str more...
    • secure - Port to be used for authentication. type: str choices: [disable, starttls, ldaps] more...
    • server - LDAP server CN domain name or IP. type: str more...
    • server-identity-check - Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). type: str choices: [disable, enable] more...
    • source-ip - Source IP for communications to LDAP server. type: str more...
    • ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3] more...
    • tertiary-server - Tertiary LDAP server CN domain name or IP. type: str more...
    • type - Authentication type for LDAP searches. type: str choices: [simple, anonymous, regular] more...
    • username - Username (full DN) for initial binding. type: str more...
    • obtain-user-info - Enable/disable obtaining of user information. type: str choices: [disable, enable] more...
    • search-type - Search type. type: array choices: [nested, recursive] more...
    • user-info-exchange-server - MS Exchange server from which to fetch user information. type: str more...
    • two-factor - Enable/disable two-factor authentication. type: str choices: [disable, fortitoken-cloud] more...
    • interface - Specify outgoing interface to reach server. type: str more...
    • interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] 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...
    • antiphish - Enable/disable AntiPhishing credential backend. type: str choices: [disable, enable] more...
    • password-attr - Name of attribute to get password hash. type: str more...
    • source-port - Source port to be used for communication with the LDAP server. type: int more...
    • client-cert - Client certificate name. type: str more...
    • client-cert-auth - Enable/disable using client certificate for TLS authentication. 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 LDAP server entries.
     fmgr_user_ldap:
        bypass_validation: False
        adom: ansible
        state: present
        user_ldap:
           dn: ansible-test
           name: ansible-test-ldap
           password: fortinet
           port: 9000
           server: ansible

- 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 LDAP server entries
     fmgr_fact:
       facts:
           selector: 'user_ldap'
           params:
               adom: 'ansible'
               ldap: '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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.