fortinet.fortimanager.fmgr_user_ldap module – Configure LDAP server entries.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_ldap.

New in fortinet.fortimanager 2.0.0

Synopsis 

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters 

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
user_ldap dictionary	The top level parameters set.
account-key-cert-field string	Deprecated, please rename it to account_key_cert_field. Define subject identity field in certificate for user access right… Choices: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account-key-filter string	Deprecated, please rename it to account_key_filter. Account key filter, using the UPN as the search filter.
account-key-name string	Deprecated, please rename it to account_key_name. Account key name, using the UPN as the search filter.
account-key-processing string	Deprecated, please rename it to account_key_processing. Account key processing operation, either keep or strip domain stri… Choices: `"same"` `"strip"`
account-key-upn-san string	Deprecated, please rename it to account_key_upn_san. Define SAN in certificate for user principle name matching. Choices: `"othername"` `"rfc822name"` `"dnsname"`
antiphish string	Enable/disable AntiPhishing credential backend. Choices: `"disable"` `"enable"`
ca-cert string	Deprecated, please rename it to ca_cert. CA certificate name.
client-cert string	Deprecated, please rename it to client_cert. Client certificate name.
client-cert-auth string	Deprecated, please rename it to client_cert_auth. Enable/disable using client certificate for TLS authentication. Choices: `"disable"` `"enable"`
cnid string	Common name identifier for the LDAP server.
dn string	Distinguished name used to look up entries on the LDAP server.
dynamic_mapping list / elements=dictionary	Dynamic mapping.
_scope list / elements=dictionary	Scope.
name string	Name.
vdom string	Vdom.
account-key-cert-field string	Deprecated, please rename it to account_key_cert_field. Define subject identity field in certificate for user acce… Choices: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account-key-filter string	Deprecated, please rename it to account_key_filter. Account key filter.
account-key-name string	Deprecated, please rename it to account_key_name. Account key name.
account-key-processing string	Deprecated, please rename it to account_key_processing. Account key processing. Choices: `"same"` `"strip"`
account-key-upn-san string	Deprecated, please rename it to account_key_upn_san. Define SAN in certificate for user principle name matching. Choices: `"othername"` `"rfc822name"` `"dnsname"`
antiphish string	Enable/disable AntiPhishing credential backend. Choices: `"disable"` `"enable"`
ca-cert string	Deprecated, please rename it to ca_cert. Ca cert.
client-cert string	Deprecated, please rename it to client_cert. Client certificate name.
client-cert-auth string	Deprecated, please rename it to client_cert_auth. Enable/disable using client certificate for TLS authentication. Choices: `"disable"` `"enable"`
cnid string	Cnid.
dn string	Dn.
filter string	Filter.
group string	Group.
group-filter string	Deprecated, please rename it to group_filter. Group filter.
group-member-check string	Deprecated, please rename it to group_member_check. Group member check. Choices: `"user-attr"` `"group-object"` `"posix-group-object"`
group-object-filter string	Deprecated, please rename it to group_object_filter. Group object filter.
group-object-search-base string	Deprecated, please rename it to group_object_search_base. Group object search base.
group-search-base string	Deprecated, please rename it to group_search_base. Group search base.
interface string	Interface.
interface-select-method string	Deprecated, please rename it to interface_select_method. Interface select method. Choices: `"auto"` `"sdwan"` `"specify"`
max-connections integer	Deprecated, please rename it to max_connections. Max connections.
member-attr string	Deprecated, please rename it to member_attr. Member attr.
obtain-user-info string	Deprecated, please rename it to obtain_user_info. Obtain user info. Choices: `"disable"` `"enable"`
password any	(list) Password.
password-attr string	Deprecated, please rename it to password_attr. Name of attribute to get password hash.
password-expiry-warning string	Deprecated, please rename it to password_expiry_warning. Password expiry warning. Choices: `"disable"` `"enable"`
password-renewal string	Deprecated, please rename it to password_renewal. Password renewal. Choices: `"disable"` `"enable"`
port integer	Port.
retrieve-protection-profile string	Deprecated, please rename it to retrieve_protection_profile. Retrieve protection profile.
search-type list / elements=string	Deprecated, please rename it to search_type. Search type. Choices: `"nested"` `"recursive"`
secondary-server string	Deprecated, please rename it to secondary_server. Secondary server.
secure string	Secure. Choices: `"disable"` `"starttls"` `"ldaps"`
server string	Server.
server-identity-check string	Deprecated, please rename it to server_identity_check. Server identity check. Choices: `"disable"` `"enable"`
source-ip string	Deprecated, please rename it to source_ip. Source ip.
source-ip-interface any	(list) Deprecated, please rename it to source_ip_interface. Source interface for communication with the LDAP server.
source-port integer	Deprecated, please rename it to source_port. Source port to be used for communication with the LDAP server.
ssl-min-proto-version string	Deprecated, please rename it to ssl_min_proto_version. Ssl min proto version. Choices: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status-ttl integer	Deprecated, please rename it to status_ttl. Time for which server reachability is cached so that when a server is …
tertiary-server string	Deprecated, please rename it to tertiary_server. Tertiary server.
two-factor string	Deprecated, please rename it to two_factor. Two factor. Choices: `"disable"` `"fortitoken-cloud"`
two-factor-authentication string	Deprecated, please rename it to two_factor_authentication. Two factor authentication. Choices: `"fortitoken"` `"email"` `"sms"`
two-factor-filter string	Deprecated, please rename it to two_factor_filter. Filter used to synchronize users to FortiToken Cloud.
two-factor-notification string	Deprecated, please rename it to two_factor_notification. Two factor notification. Choices: `"email"` `"sms"`
type string	Type. Choices: `"simple"` `"anonymous"` `"regular"`
user-info-exchange-server string	Deprecated, please rename it to user_info_exchange_server. User info exchange server.
username string	Username.
group-filter string	Deprecated, please rename it to group_filter. Filter used for group matching.
group-member-check string	Deprecated, please rename it to group_member_check. Group member checking methods. Choices: `"user-attr"` `"group-object"` `"posix-group-object"`
group-object-filter string	Deprecated, please rename it to group_object_filter. Filter used for group searching.
group-object-search-base string	Deprecated, please rename it to group_object_search_base. Search base used for group searching.
group-search-base string	Deprecated, please rename it to group_search_base. Search base used for group searching.
interface string	Specify outgoing interface to reach server.
interface-select-method string	Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. Choices: `"auto"` `"sdwan"` `"specify"`
member-attr string	Deprecated, please rename it to member_attr. Name of attribute from which to get group membership.
name string / required	LDAP server entry name.
obtain-user-info string	Deprecated, please rename it to obtain_user_info. Enable/disable obtaining of user information. Choices: `"disable"` `"enable"`
password any	(list) Password for initial binding.
password-attr string	Deprecated, please rename it to password_attr. Name of attribute to get password hash.
password-expiry-warning string	Deprecated, please rename it to password_expiry_warning. Enable/disable password expiry warnings. Choices: `"disable"` `"enable"`
password-renewal string	Deprecated, please rename it to password_renewal. Enable/disable online password renewal. Choices: `"disable"` `"enable"`
port integer	Port to be used for communication with the LDAP server
search-type list / elements=string	Deprecated, please rename it to search_type. Search type. Choices: `"nested"` `"recursive"`
secondary-server string	Deprecated, please rename it to secondary_server. Secondary LDAP server CN domain name or IP.
secure string	Port to be used for authentication. Choices: `"disable"` `"starttls"` `"ldaps"`
server string	LDAP server CN domain name or IP.
server-identity-check string	Deprecated, please rename it to server_identity_check. Enable/disable LDAP server identity check Choices: `"disable"` `"enable"`
source-ip string	Deprecated, please rename it to source_ip. Source IP for communications to LDAP server.
source-ip-interface any	(list) Deprecated, please rename it to source_ip_interface. Source interface for communication with the LDAP server.
source-port integer	Deprecated, please rename it to source_port. Source port to be used for communication with the LDAP server.
ssl-min-proto-version string	Deprecated, please rename it to ssl_min_proto_version. Minimum supported protocol version for SSL/TLS connections Choices: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status-ttl integer	Deprecated, please rename it to status_ttl. Time for which server reachability is cached so that when a server is unreacha…
tertiary-server string	Deprecated, please rename it to tertiary_server. Tertiary LDAP server CN domain name or IP.
two-factor string	Deprecated, please rename it to two_factor. Enable/disable two-factor authentication. Choices: `"disable"` `"fortitoken-cloud"`
two-factor-authentication string	Deprecated, please rename it to two_factor_authentication. Authentication method by FortiToken Cloud. Choices: `"fortitoken"` `"email"` `"sms"`
two-factor-filter string	Deprecated, please rename it to two_factor_filter. Filter used to synchronize users to FortiToken Cloud.
two-factor-notification string	Deprecated, please rename it to two_factor_notification. Notification method for user activation by FortiToken Cloud. Choices: `"email"` `"sms"`
type string	Authentication type for LDAP searches. Choices: `"simple"` `"anonymous"` `"regular"`
user-info-exchange-server string	Deprecated, please rename it to user_info_exchange_server. MS Exchange server from which to fetch user information.
username string	Username
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes 

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 LDAP server entries.
      fortinet.fortimanager.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: 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 LDAP server entries
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap"
          params:
            adom: "ansible"
            ldap: "your_value"

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_user_ldap module – Configure LDAP server entries.

Synopsis

Parameters

Notes

Examples

Return Values