The ldaptestconnection command

Overview

The 'ldaptestconnection' command tests the connection to each of the hosts servicing the LDAP directory identified by domain. It must be placed at the beginning of a search pipeline. A sample usage follows:

| ldaptestconnection domain=default

There are several possible arguments:

Argument	Description
domain=<domain>	Specifies the name of a configuration stanza in ldap.conf. If you do not specify a domain, the command uses the default stanza.
debug=<boolean>	Specifies whether or not ldapfetch should write debug log data. When set to T, specifies that debug logging should occur.
logging_level=(CRITICAL|ERROR|WARNING|INFO|DEBUG)	Specifies the logging level for the $SPLUNK_HOME/var/log/splunk/SA-ldapsearch.log file. Splunk can access this file with the "index=_internal sourcetype=SA-ldapsearch" search and exposes the following fields: File: Full pathname of the source file where the logging call was made. Level: Level of the logging call that was made; one of CRITICAL, ERROR, WARNING, INFO, or DEBUG. Line: Line number in the source file where the logging call was made. Pid: ID of the process that made the logging call. log_source: String of the form "Pid=<Pid>, File=<File>, Line=<Line>". message: Full text of the logged message.

On return, ldaptestconnection generates a single event record for each host servicing the LDAP directory identified by the default domain. Each record contains the host name and the distinguished name of the domain. If the connection test fails for any reason, an error message is produced instead.

Example

To test the connection for the SPL domain:

| ldaptestconnection domain=SPL