Exit Print View

Sun OpenDS Standard Edition 2.0 Command-Line Usage Guide

Get PDF Book Print View

Document Information

Directory Server Administration Tools

Data Administration Tools

LDAP Client Utilities

Other Tools

General Tool Usage Information

Summary of Directory Server Commands and Their Use

Using a Properties File With Directory Server Commands

Using a Properties File With Directory Server Commands

Certain command-line utilities can use a common properties file to provide default values for options such as the following:

The following utilities can use a properties file:

The following mutually exclusive options are used with the command-line utilities to indicate whether a properties files is used:

--propertiesFilePath path
Specify the path to the file that contains default values for command-line options.

Indicates that the properties file is not used to obtain default values for command-line options.

Locating the Properties File

Utilities that use the common properties file have the following default behavior:

Order of Precedence of Options and Properties

If an option is provided on the command line, this option and its corresponding value are used by the command-line interface. In other words, options specified on the command line take precedence over the properties defined in the properties file.

The properties file has the standard JAVA properties file format (property-name=value). As such, the file supports variations on property names to enable them to be overridden according to the command that uses them. For example, the properties file might contain the following:

bindDN=cn=Directory Manager

If a command-line interface uses the port property, the command first tries to locate a toolname.port definition. If this is not defined, the command tries to locate a port definition. For example, the properties file might have several port options defined for different utilities:


Note - Do not use quotation marks around the values in the properties file (for example, port="4444").