You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

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

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 version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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
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: no ← (default) yes
enable_log boolean	Enable/Disable logging for task Choices: no ← (default) yes
proposed_method string	The overridden method for the underlying Json RPC request Choices: update set add
rc_failed list / elements=string	the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string	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-filter string	Account key filter, using the UPN as the search filter.
account-key-processing string	Account key processing operation, either keep or strip domain string of UPN in the token. Choices: same strip
antiphish string	Enable/disable AntiPhishing credential backend. Choices: disable enable
ca-cert string	CA certificate name.
cnid string	Common name identifier for the LDAP server. The common name identifier for most LDAP servers is “cn”.
dn string	Distinguished name used to look up entries on the LDAP server.
dynamic_mapping list / elements=string	Dynamic_Mapping.
_scope list / elements=string	_Scope.
name string	Name.
vdom string	Vdom.
account-key-filter string	Account key filter, using the UPN as the search filter.
account-key-name string	Account-Key-Name.
account-key-processing string	Account key processing operation, either keep or strip domain string of UPN in the token. Choices: same strip
antiphish string	Enable/disable AntiPhishing credential backend. Choices: disable enable
ca-cert string	CA certificate name.
cnid string	Common name identifier for the LDAP server. The common name identifier for most LDAP servers is “cn”.
dn string	Distinguished name used to look up entries on the LDAP server.
filter string	Filter.
group string	Group.
group-filter string	Filter used for group matching.
group-member-check string	Group member checking methods. Choices: user-attr group-object posix-group-object
group-object-filter string	Filter used for group searching.
group-object-search-base string	Group-Object-Search-Base.
group-search-base string	Search base used for group searching.
interface string	Specify outgoing interface to reach server.
interface-select-method string	Specify how to select outgoing interface to reach server. Choices: auto sdwan specify
member-attr string	Name of attribute from which to get group membership.
obtain-user-info string	Enable/disable obtaining of user information. Choices: disable enable
password string	Password for initial binding.
password-attr string	Name of attribute to get password hash.
password-expiry-warning string	Enable/disable password expiry warnings. Choices: disable enable
password-renewal string	Enable/disable online password renewal. Choices: disable enable
port integer	Port to be used for communication with the LDAP server (default = 389).
retrieve-protection-profile string	Retrieve-Protection-Profile.
search-type list / elements=string	Search type. Choices: nested recursive
secondary-server string	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	Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). Choices: disable enable
source-ip string	Source IP for communications to LDAP server.
source-port integer	Source port to be used for communication with the LDAP server.
ssl-min-proto-version string	Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). Choices: default TLSv1 TLSv1-1 TLSv1-2 SSLv3
tertiary-server string	Tertiary LDAP server CN domain name or IP.
two-factor string	Enable/disable two-factor authentication. Choices: disable fortitoken-cloud
two-factor-authentication string	Authentication method by FortiToken Cloud. Choices: fortitoken email sms
two-factor-notification string	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	MS Exchange server from which to fetch user information.
username string	Username (full DN) for initial binding.
group-filter string	Filter used for group matching.
group-member-check string	Group member checking methods. Choices: user-attr group-object posix-group-object
group-object-filter string	Filter used for group searching.
group-search-base string	Search base used for group searching.
interface string	Specify outgoing interface to reach server.
interface-select-method string	Specify how to select outgoing interface to reach server. Choices: auto sdwan specify
member-attr string	Name of attribute from which to get group membership.
name string	LDAP server entry name.
obtain-user-info string	Enable/disable obtaining of user information. Choices: disable enable
password string	Password for initial binding.
password-attr string	Name of attribute to get password hash.
password-expiry-warning string	Enable/disable password expiry warnings. Choices: disable enable
password-renewal string	Enable/disable online password renewal. Choices: disable enable
port integer	Port to be used for communication with the LDAP server (default = 389).
search-type list / elements=string	Search type. Choices: nested recursive
secondary-server string	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	Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). Choices: disable enable
source-ip string	Source IP for communications to LDAP server.
source-port integer	Source port to be used for communication with the LDAP server.
ssl-min-proto-version string	Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). Choices: default TLSv1 TLSv1-1 TLSv1-2 SSLv3
tertiary-server string	Tertiary LDAP server CN domain name or IP.
two-factor string	Enable/disable two-factor authentication. Choices: disable fortitoken-cloud
two-factor-authentication string	Authentication method by FortiToken Cloud. Choices: fortitoken email sms
two-factor-notification string	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	MS Exchange server from which to fetch user information.
username string	Username (full DN) for initial binding.
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

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: ''

Return Values 

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

Key	Description
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_message string	The descriptive message of the api response Returned: always Sample: “OK.”

Authors

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

Collection links

Issue Tracker Homepage Repository (Sources)

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

Synopsis

Parameters

Notes

Examples

Return Values