Previous Next Contents Index


Chapter 1 Administering Netscape Directory Server

The Netscape Directory Server simplifies management and retrieval of corporate user information. Using the directory server, corporate IS organizations can manage all their user information from a single point of control, and corporate users can retrieve this information from multiple, easily accessible network locations.

The Netscape Directory Server product ships with a directory server, an administration server, and Netscape Console.

This chapter provides the information you need to get started administering the directory server, in the following sections:


Overview of Directory Server Management
Netscape Directory Server is based on an open-systems server protocol called the Lightweight Directory Access Protocol (LDAP). The directory server is a robust, scalable server designed to manage an enterprise-wide directory of users and resources. The directory server runs as the ns-slapd process or service on your machine. The server manages the directory databases and responds to client requests.

You perform most Directory Server administrative tasks through the Administration Server, a second server that Netscape provides to help you manage the Directory Server (and all other Netscape Servers). For Directory Server, you use a part of the Administration Server called Netscape Console. The Directory Server Console is a part of Netscape Console designed specifically for use with Netscape Directory Server.

You can perform most directory server administrative tasks from the Directory Server Console. You can also perform administrative tasks manually by editing the configuration files or by using command-line utilities. For more information about the Netscape Console see Managing Servers with Netscape Console.


Using the Directory Server Console
From the Directory Server Console you can do the following:

Opening the Directory Server Console

You bring up the Directory Server Console from Netscape Console, which is described in Managing Servers with Netscape Console. See Installing the Netscape Directory Server for information on installing the server.

To open the Directory Server Console, from the Netscape Console:

  1. On the Console tab, open the folder designated by the domain in which the directory server resides, for example, airius.com.
  2. Open the folder designated by the hostname of the directory server, for example, dirserver.airius.com.
  3. Expand the Server Group folder.
  4. Double-click the Directory Server entry (for example, slapd-phonebook).
  5. This brings up the Directory Server Console with the Tasks tab displayed by default.

Binding to the Directory From Netscape Console

When you create or manage entries from the Directory Server Console, and when you first access the Netscape Console, you are given the option to log in by providing a bind DN and a password. This option allows you to indicate who you are accessing the directory tree as. This in turn determines whether you can perform the requested operation in the tree.

You can log in with the root DN when you first bring up the Netscape Console. If you choose not to do this, you can log in as the root DN or a different user through the Directory Server Console.

To log in to Netscape Console:

  1. On the Directory Server Console, select the Tasks tab.
  2. Click "Log on to the Directory Server as a New User".
  3. A login dialog box appears.

  4. Enter the new DN and password and click OK.
  5. Enter the full distinguished name of the entry with which you want to bind to the server. For example, if you want to bind as the Root DN and the Root DN is Directory Manager, then enter the following in the Distinguished Name text box:

    cn=Directory Manager

    For more information about the root DN and password, refer to "Managing the Root DN".

    Do not perform daily administrative tasks using the directory manager as your bind DN. Instead, set up a directory server administrator account with the access control privileges required for the most common tasks you perform. For information on how to do this, see Managing Servers with Netscape Console.

Viewing the Current Bind DN From Netscape Console

You can view the bind DN you used to log in to the Directory Server Console by clicking the login icon in the lower-left corner of the display. The current bind DN appears next to the login icon as shown here.

Figure 1.1 Viewing the bind DN


Starting and Stopping the Directory Server
If you are not using Secure Sockets Layer (SSL), you can start and stop the directory server using the methods listed here. If you are using SSL, see "Starting the Server with SSL Enabled".

From the Directory Server Console. On the Tasks tab, click "Start the Directory Server" or "Stop the Directory Server" as appropriate.

When you successfully start or stop your directory server from the server console, the server displays a message box stating either that the server started or has shut down.

From the Windows NT Services Control Panel.

  1. Select Start|Settings|Control Panel from the desktop.
  2. Double-click the Services icon.
  3. Scroll through the list of services and select the Netscape Directory Server.
  4. The service name is Netscape Directory Server 4.1 (<serverID>) where is the identifier you gave the server when you installed it.

  5. Start or stop the service:
From the Unix or Windows NT command line. Use one of the following scripts:

<NSHOME>/slapd-<serverID>/start-slapd

or

<NSHOME>/slapd-<serverID>/stop-slapd

where <NSHOME> is the location where your server is installed, and <serverID> is the identifier you gave the server when you installed it.

On Unix, both of these scripts must run with the same UID and GID as that used by the directory server. For example, if the directory server runs as nobody, you must run the start-slapd and stop-slapd utilities as nobody.


Starting the Server with SSL Enabled
On Windows NT, if you are using SSL with your server, then you must start the server from the server's host machine. This is because a dialog box will prompt you for the certificate PIN before the server will start. For security reasons, this dialog box appears only on the server's host machine.

On Unix, you must start the server from the command line.

Note. If you are using FORTEZZA, see "Starting the Server with FORTEZZA Enabled" for information on starting and stopping the server.

Alternatively, on either platform, you can create a password file to store your certificate password. By placing your certificate database password in a file, you can start your server from the server console, and also allow your server to automatically restart when running unattended.

This password is stored in clear text within the password file, so its usage represents a significant security risk. Do not use a password file if your server is running in an unsecured environment.

The password file must be placed in the following location:

<NSHOME>/alias/slapd-<serverID>-pin.txt

where <NSHOME> is the location where your server is installed, and <serverID> is the identifier you gave the server when you installed it.

You create certificate databases using the administration server and the Certificate Setup Wizard. For information on certificate databases, certificate aliases, SSL, and obtaining a server certificate, see Managing Servers with Netscape Console. For information on using SSL with your directory server, see Chapter  11, "Managing SSL."


Starting the Server in Referral-Only Mode
You can also start the server in referral-only mode. You might want to do this if you're making configuration changes to the directory server and you want all clients to be referred to another master for the duration. There are two ways to configure the server to start up in referral-only mode:


Using the Command-Line Utilities
Netscape Directory Server comes with a robust set of command-line utilities that you can use to manage the entries in your directory. The most important of these are listed in Table 1.1.

Table 1.1 Commonly used command-line utilities  

Command-line utility
Description
aclupg
Upgrades LDIF formatted with the 1.x access control statements to the 4.x ACI. See the Netscape Directory Server Installation Guide for more information.
ldapdelete
Allows you to delete entries in the directory. For information on using this utility, see "Deleting Entries Using ldapdelete".
ldapsearch
Allows you to search the directory. Returns search results in LDIF format. For details on this tool, see Chapter  8, "Finding Directory Entries."
ldapmodify
Allows you to add, delete, modify, or rename entries. All operations are specified using LDIF update statements. For details on this tool, see "Adding and Modifying Entries Using ldapmodify".
ns-slapd (Unix)
slapd (Windows NT)

Used to start the directory server process, to build a directory database from an LDIF file, or to convert an existing database to an LDIF file. For details, see
ldif
Automatically formats LDIF files for you, and creates base 64 encoded attribute values. For details on this tool, see "Base 64 Encoding".

Finding the Command-Line Utilities

Most of the directory server's command line utilities are stored in a single location. You can find them in the following directory:

<NSHOME>/bin/slapd/server

where <NSHOME> is your server installation directory.

The remaining three-ldapdelete, ldapmodify, and ldapsearch-are stored in the following directory:

<NSHOME>/shared/bin

where <NSHOME> is your server installation directory.

Warning. The command-line utilities in these directories that are not described in this manual are used internally by the directory server. Their use outside of that environment is not recommended.

Setting Environment Variables

On Windows NT, before using the command-line utilities, set your PATH variable to include the locations of the directory server command-line utilities:

<NSHOME>/bin/slapd/server

and

/shared/bin

For information on how to set environment variables, see the documentation available for your operating system.

On Unix, to run the command-line utilities, change to the directory where they are stored.


Directory Server Command-Line Scripts
In addition to the command-line utilities described in "Using the Command-Line Utilities", the Netscape Directory Server provides several scripts you can use to invoke the utilities with the most common options set. These scripts are stored in the following directory:

<NSHOME>/slapd-<serverID>/

All of these scripts assume that you want to use the slapd.conf file located in

<NSHOME>/slapd-<serverID>/config/

You can copy these scripts and modify your copies to suit your needs. In general, the rest of this manual does not describe the use of these scripts. Some of the most commonly used scripts are listed in Table  1.2.

Table 1.2 Commonly used command-line scripts  

Command-line script
Description
bak2db
Restores the database from the most recent archived backup. Syntax: bak2db [backup_directory]
db2bak
Creates a backup of the current database contents. Syntax: db2bak [backup_directory]. For more information, see "Backing Up Your Database From the Command Line".
db2ldif
Exports the contents of the database to LDIF. By default, the server stores the LDIF file in: <NSHOME>/slapd-<serverID>/ldif/
Syntax: db2ldif <ldif_filename> [-s ] [-x ]
getpwenc
Prints the encrypted form of a password using one of the server's encryption algorithms. If a user cannot log in, you can use this script to compare the user's password to the password stored in the directory. Syntax:  getpwenc  sha  <password>
or: getpwenc  crypt  <password>
ldif2db
Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. By default, the script first saves and then merges any existing configuration tree (o=NetscapeRoot), with any files to be imported. You can specify -noconfig if you want to overwrite the configuration information.
Warning. Netscape recommends that you do not overwrite the configuration data unless instructed to do so by Netscape Techical Support.
Syntax:
ldif2db [-noconfig] -i [-i ] ... [-s ] [-x }
monitor
Retrieves performance monitoring information using the ldapsearch command-line utility.
Syntax: monitor  -b  <baseDN>  [options]  filter
or:
monitor "cn=monitor"
See "Using ldapsearch" for more information on ldapsearch.
restart-slapd
Restarts the directory server. Syntax: restart-slapd
start-slapd
Starts the directory server. Syntax: start-slapd
stop-slapd
Stops the directory server. Syntax: stop-slapd
vlvindex
Reserved.


Directory Server Configuration Files
You can also perform many administrative tasks manually by editing the directory server's configuration files. There are two main configuration files:

All of the directory server's configuration files are located in the following directory:

<NSHOME>/slapd-<serverID>/config

where <NSHOME> is your server installation directory and <serverID> is the server identifier that you defined when you installed your directory server. Thus, if you installed your directory server in /usr/dirserver and you selected a server identifier of phonebook, then your configuration files are all stored under

/usr/dirserver/slapd-phonebook/config

Table  1.3 briefly describes each configuration file.

Table 1.3 Directory Server Configuration Files  

Configuration Filename
Purpose
dse.ldif
Contains front-end Directory Specific Entries created by the directory at server startup. These include the Root DSE (""), and the contents of cn=config, cn=monitor, and cn=schema.
ldbm.ldif
Contains back-end Directory Specific Entries created by the directory at server startup. These include the contents of cn=config,cn=ldbm and cn=monitor,cn=ldbm.
ns-admin-schema.conf
Schema used by Netscape Administration Server 4.0 and Netscape Console.
ns-calendar-schema.conf
Schema used by Netscape Calendar Server.
ns-wcal-schema.conf
Schema used by Netscape Calendar Hosting Server.
ns-certificate-schema.conf
Schema used to identify a Netscape Certificate Server. netscapeCertificateServer is the sole object class.
ns-common-schema.conf
Schema that contains objects classes and attributes common to the Netscape Console framework.
ns-compass-schema.conf
Schema used by Netscape Compass Server to define personal interest profiles.
ns-delegated-admin-schema.conf
Schema used by Netscape Delegated Administrator 1.0.
ns-directory-schema.conf
Schema used to identify a Netscape Directory Server.
ns-legacy-schema.conf
Schema used by Netscape Administration Server for legacy servers.
ns-mail-schema.conf
Schema used by Messaging Server to define mail users and mail groups.
ns-mcd-browser-schema.conf
Schema used by Mission Control Desktop to hold browser client preferences.
ns-mcd-config-schema.conf
Schema used by Mission Control Desktop to set MCD "config()" preferences.
ns-mcd-li-schema.conf
Schema used by Mission Control Desktop to define location independence.
ns-mcd-mail-schema.conf
Schema used by Mission Control Desktop to hold mail client preferences and messenger security preferences.
ns-media-schema.conf
Schema used to identify a Netscape Media server.
ns-mlm-schema.conf
Schema used by Messaging Server 4.0 for mailing list management.
ns-msg-schema.conf
Schema used by Netscape Messaging Server 4.0.
ns-netshare-schema.conf
Schema used by Netscape Enterprise and FastTrack servers.
ns-news-schema.conf
Schema used by Netscape Collabra Server to hold news group preferences.
ns-proxy-schema.conf
Schema used to identify a proxy server.
ns-schema.conf
Lists all schema files used by the Netscape Directory Server.
ns-value-schema.conf
Schema used for defining schemaless configuration for LDAP.
ns-web-schema.conf
Schema used to identify an HTTP server.
slapd.at.conf
Contains Includes X.500 user schema for use with LDAP, LDAP attributes defined by the IETF, pilot X.500 schema for use in LDAPv3, and Netscape-defined attributes. Modifying this file will cause interoperability problems. User defined attributes should be added using Netscape Console.
slapd.conf
Contains server configuration parameters.
slapd.conf.old
Backup of slapd.conf.
slapd.ldbm.conf
Contains database configuration parameters.
slapd.oc.conf
Contains standard object classes expected to be present in Directory Server 4.x unchanged. Modifying this file will cause interoperability problems. User defined object classes should be added using Netscape Console. User-defined objectClasses are saved in slapd.user_oc.conf.
slapd.user_at.conf
Contains user-defined attributes.
slapd.user_oc.conf
Contains user-defined object classes.
slapd-collations.conf
Contains collation orders used with matching rules.

 

© Copyright 1999 Netscape Communications Corporation, a subsidiary of America Online, Inc. All Rights Reserved.