Preface    About This Reference Guide

The major components of Directory Server include:

• An LDAP server. The core of the directory service, provided by the ns-slapd daemon and compliant with the LDAP v3 Internet standards.
  
  
• Directory Server Console. An improved management console that dramatically reduces the effort of setting up and maintaining your directory service. Directory Server Console is part of Netscape Console, the common management framework for Netscape servers.
  
  
• SNMP Agent. Permits you to monitor Directory Server in real time using the Simple Network Management Protocol (SNMP).
  
  
• Online backup and restore. Allows you to create backups and restore from backups while the server is running.

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. Those concepts are described in the Netscape Directory Server Administrator's Guide. You should read that book before continuing with this reference guide.

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

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

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  Netscape Directory Server Administrator's Guide describes how to do this and explains individual administration tasks more fully.

This section explains the conventions used in this book.

• Monospaced font -- This typeface is used for any text that appears on the computer screen or text that you should type. It is also used for filenames, functions, and examples.
  
  

• Note	Notes and Cautions mark important information. Make sure you read the information before continuing with a task.



• Throughout this book you will see path references of the form:
  
  serverRoot/slapd-serverID/...
  
  serverRoot is the installation directory. The default installation directory on UNIX is /usr/netscape/servers. On Windows, it is c:\usr\netscape\servers. If you have installed Directory Server in a different location, you should adapt the path accordingly.
  
  serverID is the ID or identifier you assigned to an instance of Directory Server when you installed it. For example, if you gave the server an identifier of phonebook, then the actual path would look like this: /usr/netscape/servers/slapd-phonebook/...
  
  
• All paths specified in this manual are in UNIX format. If you are using a Windows-based Directory Server, you should assume the equivalent file paths whenever UNIX file paths are shown in this book.
  
  
• In examples/sample code, paths assume that the Directory Server is installed in the default location /usr/netscape/servers. If you have installed your Directory Server in a different location, adapt the paths accordingly. Also, all examples use phonebook for the server identifier where appropriate.

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

• Netscape Directory Server Deployment Guide. Provides an overview for planning your deployment of the Directory Server. Includes deployment examples.
  
  
• Netscape Directory Server Installation Guide. Procedures for installing Directory Server as well as procedures for migrating your Directory Server.
  
  
• Netscape Directory Server Administrator's Guide. Procedures for the day-to-day maintenance of your directory service. Includes information on configuring server-side plug-ins.
  
  
• Netscape Directory Server Schema Reference. Provides information about the Netscape Directory Server schema.
  
  
• Netscape Directory Server Plug-in Programmer's Guide. Describes how to write server plug-ins in order to customize and extend the capabilities of Directory Server.
  
  
• Netscape Directory Server Gateway Customization Guide. Introduces Directory Server Gateway and explains how to implement a gateway instance with basic directory look-up functionality. Also contains information useful for implementing a more powerful gateway instance with directory authentication and administration capability.
  

For a list of documentation installed with Directory Server, open the serverRoot/manual/en/slapd/index.htm file.

For the latest information about Directory Server, including current release notes, complete product documentation, technical notes, and deployment information, check this site: