Command-Line Usage Guide

The Sun OpenDS ^TM Standard Edition 1.0 directory server includes a number of command-line utilities that can be used to interact with the directory server. Some of the utilities are administrative tools for managing the directory server, while others are client applications that may be used to communicate with the directory server. The directory server also includes a number of other general utilities for performing directory-related tasks.

The following is a list of the command-line utilities provided with the directory server and links to information about those tools. Note that for all tools, you can include a --help command-line argument to obtain basic usage information.

Directory Server Administration Tools

• setup—Perform a directory server installation.
• uninstall—Remove the directory server installation by using the command-line.
• start-ds—Start the directory server.
• stop-ds—Stop or restart the directory server.
• create-rc-script—Create a shell script to start, stop, or restart the directory server.
• dsconfig—Configure a directory server.
• dsreplication—Configure replication between directory servers.
• status—Display basic directory server information from the command-line.
• status-panel—Display basic directory server information on a graphical interface that also allows starting, stopping, and restarting the directory server.
• windows-service—Enable or disable the directory server as a Windows service.
• manage-tasks—Manage and monitor tasks that have been scheduled to run within the directory server virtual machine.

Data Administration Tools

• backup—Back up one or more directory server back ends.
• restore—Restore a backup of a directory server back end.
• dbtest—Display database containers (root and entry), index status, and database dumps.
• export-ldif—Export directory server data to an LDIF file.
• import-ldif—Import LDIF data into the directory server.
• manage-account—Manage accounts by using the password policy state extended operation.
• rebuild-index—Rebuild a directory server index.
• verify-index—Perform validation of directory index data.
• list-backends—Display information about the available back ends.

LDAP Client Utilities

• ldapsearch—Perform LDAP search operations.
• ldapmodify—Perform LDAP modify, add, delete, and modify DN operations.
• ldappasswordmodify—Perform LDAP password modify operations.
• ldapcompare—Perform LDAP compare operations
• ldapdelete—Perform LDAP delete operations.

Other Tools

• dsjavaproperties—Update scripts to use the Java™ binary and Java arguments specified in a properties file.
• encode-password—Encode and compare user passwords.
• ldifsearch—Perform search operations in LDIF files.
• ldifmodify—Perform modify, add, and delete operations in LDIF files.
• ldif-diff—Identify the differences between two LDIF files.
• make-ldif—Generate sample LDIF data based on a template file.
• base64—Encode and decode information in base64.

General Tool Usage Information

Using a Properties File in Sun OpenDS Standard Edition Clients