6 Command-line utilities

This chapter contains reference information on command-line utilities used with the HP-UX Directory Server (Directory Server). These command-line utilities make it easy to perform administration tasks on the Directory Server.

6.1 Finding and executing command-line utilities

For HP-UX Directory Server documentation, the LDAP tools used in the examples, such as ldapsearch and ldapmodify utilities, are the Mozilla LDAP tools. The LDAP tools are located in the /opt/dirsrv/bin directory. Add this directory to the PATH environment variable to use these command-line utilities

The ldif and dbscan command-line utilities are stored in the /opt/dirsrv/bin directory.

6.2 Using special characters

When using the ldapsearch command-line utility, it may be necessary to specify values that contain characters that have special meaning to the command-line interpreter, such as space ( ), asterisk (*), and backslash (\). When this situation occurs, enclose the value in quotation marks (""). For example:

-D "cn=Barbara Jensen, ou=Product Development, dc=example,dc=com"

Depending on the command-line interpreter, use either single or double quotation marks for this purpose. See the operating system documentation for more information.

Additionally, commas in DN values must be escaped with a backslash. For example:

-D "cn=Patricia Fuentes, ou=people, dc=example,dc=Bolivia\, S.A."

6.3 Command-line utilities quick reference

The following table provides a summary of the command-line utilities provided for Directory Server.

Table 6-1 Commonly-used command-line utilities

Command-line utility

Description

ldapsearch

Searches the directory and returns search results in LDIF format. For details on this tool, see

 

the "Finding directory entries" appendix in the HP-UX Directory Server administrator guide.

 

 

ldapmodify

Adds, deletes, modifies, or renames entries. All operations are specified using LDIF update

 

statements. For details on this tool, see "Adding and modifying entries using ldapmodify"

 

in the "Creating directory entries" chapter in the HP-UX Directory Server administrator guide.

 

 

ldapdelete

Deletes entries in the directory. For information on using this utility, see "Deleting entries

 

using ldapdelete" in the "Creating directory entries" chapter in the HP-UX Directory Server

 

administrator guide.

 

 

ldappasswd

Changes users passwords with the password change extended operation. For more

 

information on the password extended change operation, see the "Managing the password

 

policy" section of the "Managing user accounts and passwords" chapter in the HP-UX Directory

 

Server administrator guide.

 

 

ldif

Automatically formats LDIF files and creates base 64-encoded attribute values. For details

 

on this tool, see appendix A in the HP-UX Directory Server administrator guide.

 

 

dbscan

Analyzes and extracts information from a Directory Server database file.

 

 

6.1 Finding and executing command-line utilities 189