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

dsjavaproperties

encode-password

ldif-diff

ldifmodify

ldifsearch

make-ldif

General Tool Usage Information

dsjavaproperties

The dsjavaproperties command specifies the JVM version and Java arguments that are used by each directory server command.

Synopsis

dsjavaproperties options

Description

The dsjavaproperties command can be used to specify the JVM version and Java arguments that are used by each directory server command. The JVM and Java arguments for each command are specified in a properties file, located at install-dir/config/java.properties. The properties file is not used unless you run the dsjavaproperties command. If you edit the properties file, you must run dsjavaproperties again for the new settings to be taken into account.

dsjavaproperties can be used to specify (among other arguments) whether a command runs using the JVM in -server mode or -client mode. By default, all client applications run in -client mode, and all of the server utilities run in -server mode. Generally, -server mode provides higher throughput than -client mode, at the expense of slightly longer startup times.

For certain commands (import-ldif, export-ldif, backup, and restore) you can also specify different Java arguments (and a different JVM) depending on whether the command is run in online or offline mode.

If the value of the overwrite-env-java-home property is set to false in the java.properties file, the OPENDS_JAVA_HOME environment variable takes precedence over the arguments specified in the properties file. Similarly, if the value of the overwrite-env-java-args property is set to false in the java.properties file, the OPENDS_JAVA_ARGS environment variable takes precedence over the arguments specified in the properties file.

Options

The dsjavaproperties command accepts an option in either its short form (for example, -Q) or their long form equivalent (for example, --quiet).

-Q, --quiet

Run in quiet mode. Quiet mode does not output progress information to standard output.

-?, -H, --help

Display command-line usage information for the command and exit without making any attempt to stop or restart the server.

-V, --version

Display the version information for the directory server and exit rather than attempting to run this command.

Example

The following example shows how to use the directory server commands. You can use the commands on any UNIX, Linux, or Windows system that has at least the Java SE 5 (at least Sun version 1.5.0_08, preferably the latest version of Java SE 6) runtime environment installed on its target system.

See Directory Server System Requirements in Sun OpenDS Standard Edition 2.0 Installation Guide for more information.

This example shows how to change the export-ldif script to use a maximum JVM heap size of 256 Mbytes when the command is run with the directory server online.

  1. Edit the install-dir/config/java.properties file and set the export-ldif.online arguments as follows:export-ldif.online.java-args=-client -Xms8m -Xmx256m

  2. Run the dsjavaproperties command for the change to take effect. $ dsjavaproperties The script files were successfully updated. The OpenDS command-line utilities will use the java properties specified in the properties file install-dir/config/java.properties

Exit Codes

An exit code of 0 indicates that the operation completed successfully. A nonzero exit code indicates that an error occurred during processing.

Location