fortinet.fortimanager.fmgr_user_ldap module – Configure LDAP server entries.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Define subject identity field in certificate for user access right checking. Choices:
|
|
Account key filter, using the UPN as the search filter. |
|
Account key name, using the UPN as the search filter. |
|
Account key processing operation, either keep or strip domain string of UPN in the token. Choices:
|
|
Define SAN in certificate for user principle name matching. Choices:
|
|
Enable/disable AntiPhishing credential backend. Choices:
|
|
CA certificate name. |
|
Client certificate name. |
|
Enable/disable using client certificate for TLS authentication. Choices:
|
|
Common name identifier for the LDAP server. |
|
Distinguished name used to look up entries on the LDAP server. |
|
Dynamic mapping. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Define subject identity field in certificate for user access right checking. Choices:
|
|
Account key filter. |
|
Account key name. |
|
Account key processing. Choices:
|
|
Define SAN in certificate for user principle name matching. Choices:
|
|
Enable/disable AntiPhishing credential backend. Choices:
|
|
Ca cert. |
|
Client certificate name. |
|
Enable/disable using client certificate for TLS authentication. Choices:
|
|
Cnid. |
|
Dn. |
|
Filter. |
|
Group. |
|
Group filter. |
|
Group member check. Choices:
|
|
Group object filter. |
|
Group object search base. |
|
Group search base. |
|
Interface. |
|
Interface select method. Choices:
|
|
Max connections. |
|
Member attr. |
|
Obtain user info. Choices:
|
|
(list) Password. |
|
Name of attribute to get password hash. |
|
Password expiry warning. Choices:
|
|
Password renewal. Choices:
|
|
Port. |
|
Retrieve protection profile. |
|
Search type. Choices:
|
|
Secondary server. |
|
Secure. Choices:
|
|
Server. |
|
Server identity check. Choices:
|
|
Source ip. |
|
(list) Source interface for communication with the LDAP server. |
|
Source port to be used for communication with the LDAP server. |
|
Ssl max proto version. Choices:
|
|
Ssl min proto version. Choices:
|
|
Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at l… |
|
Tertiary server. |
|
Two factor. Choices:
|
|
Two factor authentication. Choices:
|
|
Filter used to synchronize users to FortiToken Cloud. |
|
Two factor notification. Choices:
|
|
Type. Choices:
|
|
User info exchange server. |
|
Username. |
|
Filter used for group matching. |
|
Group member checking methods. Choices:
|
|
Filter used for group searching. |
|
Search base used for group searching. |
|
Search base used for group searching. |
|
Specify outgoing interface to reach server. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Name of attribute from which to get group membership. |
|
LDAP server entry name. |
|
Enable/disable obtaining of user information. Choices:
|
|
(list) Password for initial binding. |
|
Name of attribute to get password hash. |
|
Enable/disable password expiry warnings. Choices:
|
|
Enable/disable online password renewal. Choices:
|
|
Port to be used for communication with the LDAP server |
|
Search type. Choices:
|
|
Secondary LDAP server CN domain name or IP. |
|
Port to be used for authentication. Choices:
|
|
LDAP server CN domain name or IP. |
|
Enable/disable LDAP server identity check Choices:
|
|
Source IP for communications to LDAP server. |
|
(list) Source interface for communication with the LDAP server. |
|
Source port to be used for communication with the LDAP server. |
|
Minimum supported protocol version for SSL/TLS connections Choices:
|
|
Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least thi… |
|
Tertiary LDAP server CN domain name or IP. |
|
Enable/disable two-factor authentication. Choices:
|
|
Authentication method by FortiToken Cloud. Choices:
|
|
Filter used to synchronize users to FortiToken Cloud. |
|
Notification method for user activation by FortiToken Cloud. Choices:
|
|
Authentication type for LDAP searches. Choices:
|
|
MS Exchange server from which to fetch user information. |
|
Username |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |