installutil validateldap

Use the installutil validateldap subcommand to confirm that an LDAP configuration is working correctly.

Synopsis

installutil validateldap dbset_name cq_login cq_password [ –site site ] [ –domain domain ] ldap_login ldap_password

Description

The installutil validateldap subcommand uses an LDAP user name and password and the LDAP configuration settings of the HCL Compass database set to perform an LDAP authentication. It is run once per domain, site, or both, if applicable. The subcommand checks for the following conditions:
  • There is a valid, accessible LDAP server for the current site. The subcommand displays configuration settings for the other sites in a MultiSite clan.
  • A search base is configured for each site that has an LDAP server configured (setldapinit).
  • A HCL Compass to LDAP mapping is specified (installutil setcqldapmap).
  • A parameterized search string, which contains %login%, is configured (installutil setldapsearch).

The subcommand displays the database set's configuration settings and the results of the authentication request. If the validation is successful, the database set is ready to authenticate HCL Compass users with the LDAP server.

Option and Arguments

ldap_login
An LDAP user login name.
ldap_password
An LDAP login password.
–site site
If you use this option, HCL Compass attempts to validate LDAP authentication by using the LDAP configuration parameters for the site that you specify. The LDAP server must be accessible from the computer where you run this command; otherwise, the command fails.
–domain domain
HCL Compass supports environments where multiple LDAP configurations can be used to authenticate. If you use this option, HCL Compass attempts to validate LDAP authentication by using the LDAP configuration parameters for the domain that you specify. The LDAP server must be accessible from the computer where you run this command; otherwise, the command fails.

Example

In the following example, the installutil validateldap subcommand checks the LDAP configuration settings of the default HCL Compass database set. The subcommand uses the LDAP user vladimir@vladimirscompany.com and LDAP password vlad_pw when attempting to perform an LDAP authentication.
installutil validateldap dbset1 bob_admin bob_pw vladimir@vladimirscompany.com vlad_pw