Page created: 4 Feb 2020
|
Page updated: 22 Jul 2020
PingDataSync Server uses the following evaluation ordering to determine options for a given command-line tool:
- All options on the tool's command line take precedence over any options in any properties file.
- If you use the --propertiesFilePath option with no other options, PingDataSync Server takes its options from the specified properties file.
- If you use no options on the command line including the --propertiesFilePath option (and --noPropertiesFile), PingDataSync Server searches for the tools.properties file at <server-root>.
- If no default properties file is found and a required option is missing, the tool generates an error.
- Tool-specific properties (for example,
ldapsearch.port=3389
) take precedence over general properties (for example,port=1389
).
Consider this example properties file that is saved as
<server-root>/bin/tools.properties:
hostname=server1.example.com port=1389 bindDN=cn=Directory\ Manager bindPassword=secret
PingDataSync Server locates a command-line option in a specific priority order.
- All options presented with the tool on the command line take precedence over any options
in any properties file. In the following example, the client request is run with the
options specified on the command line (--port and
--baseDN). The command uses the
bindDN
andbindPassword
values specified in the properties file.$ bin/ldapsearch --port 2389 --baseDN ou=People,dc=example,dc=com \ --propertiesFilePath bin/tools.properties “(objectclass=*)”
- Next, if you specify the properties file using the --propertiesFilePath
option and no other command-line options, PingDataSync Server uses the specified
properties file as
follows:
$ bin/ldapsearch --propertiesFilePath bin/tools.properties \ “(objectclass=*)”
- If no options are presented with the tool on the command line and the
--noPropertiesFile option is not present, PingDataSync Server
attempts to locate any default
tools.properties
file in the following location:<server-root>/config/tools.properties
If you move your tools.properties file from <server-root>/bin to the <server-root>/config directory. You can then run your tools as follows:$ bin/ldapsearch "(objectclass=*)"
You can PingDataSync Server so that it does not search for a properties file by using the --noPropertiesFile option. This options tells PingDataSync Server to use only those options specified on the command line. You cannot use the --propertiesFilePath and --noPropertiesFile options together.
- If no default tools.properties file is found and no options are specified with the command-line tool, then the tool generates an error for any missing arguments.