Previous     Contents     Index     DocHome     Next     
iPlanet Directory Server Configuration, Command, and File Reference

About this Reference Guide

iPlanet Directory Server 5.1 is a powerful and scalable distributed directory server based on the industry-standard Lightweight Directory Access Protocol (LDAP). iPlanet Directory Server is the cornerstone for building a centralized and distributed data repository that can be used in your intranet, over your extranet with your trading partners, or over the public Internet to reach your customers.

For the latest information about new features and enhancements in this release of iPlanet Directory Server, please see the online release notes at:

This Configuration, Command, and File Reference documents the server configuration and command-line utilities provided with iPlanet Directory Server.

Prerequisite Reading

This reference guide does not describe many of the basic directory and architectural concepts that you need to successfully design, implement, and administer your directory service. You should be familiar with those concepts, which are described in the iPlanet Directory Server Deployment Guide and the iPlanet Directory Server Administrator's Guide.

When you are familiar with directory server concepts and have done some preliminary planning for your directory service, you can install the iPlanet Directory Server. The instructions for installing the various Directory Server components are contained in the iPlanet Directory Server Installation Guide.

Managing Servers with iPlanet Console contains general background information on how to use iPlanet servers. You should read and understand the concepts in that book before you attempt to administer the Directory Server.

What Is In This Reference Guide?

This book is a reference guide for the server configuration and the command-line utilities. It is designed primarily for directory administrators and experienced directory users who want to use the command line to access the directory. After configuring your server, use this reference guide to help you maintain it.

You can also manage the Directory Server using the Directory Server Console, a graphical user interface. The iPlanet Directory Server Administrator's Guide describes how to do this and explains individual administration tasks more fully.

Conventions Used In This Reference Guide

This section explains the typographic conventions used in this book.

Monospaced font - This typeface is used for literal text, such as the names of attributes and object classes when they appear in text. It is also used for URLs, filenames and examples.

Italic font - This typeface is used for emphasis, for new terms, and for text that you must substitute for actual values, such as placeholders in path names.

Note Notes, Cautions and Tips highlight important conditions or limitations. Be sure to read this information before continuing.

This book uses the following format for paths and file names:


The actual path and server identifier will depend on your platform, your installation, and your configuration. The default path is platform-dependent:

Solaris 9 platform


Other UNIX platforms


Windows platform


If you have installed the Directory Server in a different location, you should adapt the path accordingly. serverID represents the server identifier you gave the server when you installed it. For example, if you gave the name phonebook to your directory server, then the actual path would be:

Solaris 9 platform


Other UNIX platforms


Windows platform


Most paths and commands specified in this manual are in UNIX format. If you are using a Windows-based version of Directory Server, use equivalent paths and commands. All commands on Windows platforms have the same name with the .exe or .bat extension.

Related Information

The document set for iPlanet Directory Server also contains the following guides:

iPlanet Directory Server Installation Guide. Procedures for installing Directory Server as well as procedures for migrating your Netscape Directory Server to iPlanet Directory Server.

iPlanet Directory Server Deployment Guide. Provides an overview for planning your deployment of the Directory Server. Includes deployment examples.

iPlanet Directory Server Administrator's Guide. Procedures for the day-to-day maintenance of your directory service. Includes information on configuring server-side plug-ins.

iPlanet Directory Server Schema Reference. Information about the LDAP schema shipped with Directory Server and useful for client applications.

Other useful iPlanet information can be found at the following Internet locations:

Previous     Contents     Index     DocHome     Next     
Copyright © 2001 Sun Microsystems, Inc. Some preexisting portions Copyright © 2001 Netscape Communications Corp. All rights reserved.

Last Updated October 29, 2001