2.1.2. ApacheDS tools

{scrollbar}

Apache DS tools are simple operations that help user to interact with the server. The following operations are available:

Import: A command to import data into a server
Dump: Simple tool used to dump the contents of a jdbm based partition
Diagnostic: A command to send an extened request which launches a diagnostic UI on the server's console
Disconnect Notification: Responds to unsolicited notifications by launching an external process
Graceful Shutdown: A command used to send a graceful disconnect to established clients while allowing them time to complete operations already in progress
Capacity Test: A command which will generate bogus user entries and add them under a base DN. It will output a table of values mapping the capacity of the partition to the time it took to add an entry to it.
Index: A command which adds attribute indices to an existing partition

Each one of these commands does have a set of options. They will be described below.

Launching a command

Using those command is pretty simple. Jump to the bin directory of your installation and simply type the following command line :

java -jar apacheds-tools.jar <command> [options]

The import comand allows to import entries into a Ldap server.

Available options are :

Option	description	default value
-a	Authentication type	simple
-e	Continue to process the file even if errors are encountered	false
-f	The file to be imported
-h	The server host	localhost
-p	The server port	10389
-u	The user	uid=admin, ou=system
-w	The administrator password	secret

example :

java -jar apacheds-tools.jar import -e -f newUsers.ldif

Imports new users in the default server.

Allows you to dump the contents of a jdbm based partition.

Available options are:

Option	description	default value	required
-e	the attributes to exclude		false
-f	file to output the dump to		false
-p	the partitions to dump		true
-o	include operational attributes	false	false
-i	path to apacheds installation directory		true

example :

java -jar apacheds-tools.jar dump -i C:\Programme\apacheds-1.0.0 -p system

Dumps the content of the system partition.

Option	description	default value	required
-h	server host	localhost	false
-p	server port	10389 or server.xml specified port	false
-w	the apacheds administrator's password	secret	false
-i	path to apacheds installation directory		false

Option	description	default value	required
-h	server host	localhost	false
-p	server port	10389 or server.xml specified port	false
-w	the apacheds administrator's password	secret	false
-u	an apacheds user's dn	uid=admin,ou=system	false
-i	path to apacheds installation directory		false

Available options are:

Option	description	default value	required
-h	server host	localhost	false
-p	server port	10389 or server.xml specified port	false
-e	delay (seconds) before shutdown	0	false
-w	the apacheds administrator's password	secret	false
-t	server offline time (minutes)	0 (indefinate)	false
-i	path to apacheds installation directory		false

example :

java -jar apacheds-tools.jar graceful

Option	description	default value	required
-f	file to output the stats to	console	false
-i	path to apacheds installation directory		true
-h	server host	localhost	false
-p	server port	10389 or server.xml specified port	false
-w	the apacheds administrator's password	secret	false
-s	start on id: number to start on (user.start)	0	false
-e	end on id: number to end on (user.end)	2 ³¹ -1 (Integer.MAX_VALUE)	false

Option	description	required
-p	the partitions to add the attribute indices to	true
-a	the attribute to index	true
-i	path to apacheds installation directory	true

example :

java -jar apacheds-tools index -i /usr/local/apacheds-1.0 -p examplePartition -a postalCode