PingDirectory

The tools.properties file

The tools.properties file simplifies command-line invocations by reading in a set of arguments for each tool from a text file. Each property consists of a name/value pair for a tool’s arguments.

Two types of properties files are supported:

  • Default properties files that can be applied to all command-line utilities.

  • Tool-specific properties file that can be specified using the --propertiesFilePath option.

All of the server’s command-line utilities can be overwritten using the config/tools.properties file.

Create a properties file with a text editor or using the standard Java properties file format (name=value). For example, create a simple properties file that defines a set of LDAP connection parameters as follows:

hostname=server1.example.com
port=1389
bindDN=cn=Directory\ Manager
bindPassword=secret

Specify the location of the file using the --propertiesFilePath option. For example, specify the path to the properties file with ldapsearch as follows:

$ bin/ldapsearch --propertiesFilePath bin/mytools.properties "(objectclass=*)"

Properties files do not allow quotation marks around values. Any spaces or special characters should be removed.