fortinet.fortios.fortios_user_ldap module – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_ldap
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and ldap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure LDAP server entries. |
|
Define subject identity field in certificate for user access right checking. Choices:
|
|
Account key filter, using the UPN as the search filter. |
|
Account key processing operation. The FortiGate will keep either the whole domain or strip the domain from the subject identity. Choices:
|
|
Define SAN in certificate for user principle name matching. Choices:
|
|
Enable/disable AntiPhishing credential backend. Choices:
|
|
CA certificate name. Source vpn.certificate.ca.name. |
|
Client certificate name. Source vpn.certificate.local.name. |
|
Enable/disable using client certificate for TLS authentication. Choices:
|
|
Common name identifier for the LDAP server. The common name identifier for most LDAP servers is “cn”. |
|
Distinguished name used to look up entries on the LDAP server. |
|
Filter used for group matching. |
|
Group member checking methods. Choices:
|
|
Filter used for group searching. |
|
Search base used for group searching. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
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:
|
|
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 (verify server domain name/IP address against the server certificate). Choices:
|
|
FortiGate IP address to be used for communication with the LDAP server. |
|
Source interface for communication with the LDAP server. Source system.interface.name. |
|
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 this period of time (0 = cache disabled). |
|
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. Source user.exchange.name. |
|
Username (full DN) for initial binding. |
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure LDAP server entries.
fortinet.fortios.fortios_user_ldap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_ldap:
account_key_cert_field: "othername"
account_key_filter: "<your_own_value>"
account_key_processing: "same"
account_key_upn_san: "othername"
antiphish: "enable"
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
client_cert: "<your_own_value> (source vpn.certificate.local.name)"
client_cert_auth: "enable"
cnid: "<your_own_value>"
dn: "<your_own_value>"
group_filter: "<your_own_value>"
group_member_check: "user-attr"
group_object_filter: "<your_own_value>"
group_search_base: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
member_attr: "<your_own_value>"
name: "default_name_20"
obtain_user_info: "enable"
password: "<your_own_value>"
password_attr: "<your_own_value>"
password_expiry_warning: "enable"
password_renewal: "enable"
port: "389"
search_type: "recursive"
secondary_server: "<your_own_value>"
secure: "disable"
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
source_port: "0"
ssl_min_proto_version: "default"
status_ttl: "300"
tertiary_server: "<your_own_value>"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_filter: "<your_own_value>"
two_factor_notification: "email"
type: "simple"
user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
username: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |