Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Administering the Directory Server


he Netscape Directory Server simplifies management and retrieval of corporate user information. 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. Using the directory server, corporate IS organizations can manage all their user information from a single point of control, while corporate users can retrieve this information from multiple, easily accessible network locations.

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

The directory server is Netscape's LDAP implementation. The directory server runs as the ns-slapd process or service on your machine. This server manages the directory databases and responds to client requests.

The administration server is a common front end to all Netscape servers. The part of the administration server that you use to manage the directory server is called the directory server manager. You can perform most directory server administrative tasks from the directory server manager. For more information about the administration server, see Managing Netscape Servers.

Additionally, you can also perform administrative tasks manually by editing the configuration files or by using the command-line utilities.

This chapter provides the information you need to get started administering the directory server, including

  • Prerequisite Reading

  • Starting and Stopping the Directory Server

  • Binding to the Directory

  • Introducing the Directory Server Manager

  • Introducing the Directory Server Command-Line Utilities

  • Introducing the Directory Server Configuration Files

The remainder of this manual describes the various directory server administrative tasks in detail.

 

Prerequisite Reading

This manual describes how to administer the directory server and its contents. This manual also describes how to administer the NT synchronization service. However, this manual does not describe many of the basic directory and architectural concepts that you will need to successfully deploy, install, and administer your directory service. Those concepts are contained in the Netscape Directory Server Deployment Manual. You should read that book before continuing with this manual.

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

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

 

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:

  • server selector. Click the On/Off icon located to the left of the server's name in the server selector. If the server is on, you will see a green light under the icon. Click the icon to turn the server off. To turn the server back on, click the icon again.

  • directory server manager. Go to System Setting|On/Off and click the appropriate button.

  • When you successfully start your directory server from the server manager, the server issues the following message:


	Success!


		The server has started up.


When you successfully stop your directory server from the server manager, 
the server issues the following message:

Success! The server has been shutdown.
  • Windows NT Services Control Panel. The service name is

  • Netscape Directory Server slapd-<serverID>

    where <serverID> is the identifier you gave the server when you installed it. In the Main group:

  1. Double-click the Control Panel icon.
  2. Double-click the Services icon.
  3. Scroll through the list of services and select Netscape Directory Server slapd-<serverID>.
  4. Click Stop and then confirm that you want to stop the service.
  5. To start the service, either reboot your system, or select the directory server service and click Start.

  • Unix command line. Use the following scripts:

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

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

    Both of these scripts must run with the same UID and GID as is used by the directory server. For example, if the directory server runs as nobody, the start and stop utilities must also be run as nobody.

     

    Starting the Server with SSL Enabled

    If you are using SSL with your server, then you cannot start the server from the server manager. Under Unix, you must start the server from the command line. (Under NT, no such restriction exists.)

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

      Note
      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/<aliasname>-password.txt
    
    
    where <NSHOME> is the location where your server is installed, and <aliasname> is the alias name that you configured for your certificate database when you created the database.

    Certificate databases are created using the administration server. For information on certificate databases, certificate aliases, SSL, and obtaining a server certificate, see Managing Netscape Servers. For information on using SSL with your directory server, see "Managing SSL" on page 234.

     

    Binding to the Directory

    When you create or manage entries from the directory server manager, you are given the option to provide 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.

    These fields are used when you manage:

    • access control

    • replication

    You can use the default values for Bind to Server as and Password fields if both of the following are true:

    • You want to bind as the root DN so that the access control rules do not apply to you.

    • You have selected a root password storage scheme of clear text.

    The latter case is a requirement because the default Password value is a null string. If you are storing your Root DN password in clear text, then the server manager can use the password when it authenticates to ns-slapd. If you are not using clear text, then the server manager cannot obtain the root password value in order to authenticate to the directory server.

    When you fill in the Bind to Server as field, be sure to enter the full distinguished name of the entry you are binding as. For example, if you want to bind as the Root DN, and the Root DN is set to be Directory Manager, then enter the following to the Bind to Server as field:

    
    	cn=Directory Manager
    
    
    For more information about the root password, refer to "Managing the Root DN" on page 230.

     

    Introducing the Directory Server Manager

    The part of the administration server that you use to manage the directory server is called the directory server manager. From the directory server manager you can do the following:

    • start and stop the directory server

    • add and delete directory databases

    • manage access control

    • manage referrals

    • manage the directory server configuration files

    • manage directory schema

    • view server logs

    • manage server settings such as TCP ports and the database cache size

     

    Introducing the Directory Server Command-Line Utilities

    The 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

    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 a modified form of LDIF called LDIF update statements. For details on this tool, see "Modifying Entries Using ldapmodify" on page 200.

    ns-slapd

    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:

    • "Starting and Stopping the Directory Server" on page 25

    • "Importing LDIF from the Command Line" on page 61

    • "Converting to LDIF Using ns-slapd" on page 64

    ldif

    Automatically formats LDIF files for you, and creates base 64 encoded attribute values. For details on this tool, see "Base 64 Encoding" on page 36.

    aclupg

    Upgrades LDIF formatted with the 1.x access control statements to the 3.0 ACI. See the Netscape Directory Server Installation Guide for more information.

     

    Finding the Command-Line Utilities

    All of the directory server's command line utilities are stored in the same location in your installation directory. You can find them in the following directory:

    
    	<NSHOME>/bin/slapd/server
    
    
    where <NSHOME> is your server installation directory.

      Warning
      The command-line utilities in this directory that are not described in this manual are used internally by the directory server manager. Their usage outside of that environment is not recommended.
      However, the command line utilities that are described in this manual are not used by the directory server manager.
     

    Setting Environment Variables

    Before using the command-line utilities, set your PATH variable to include the location where the directory server command line utilities live:

    
    	<NSHOME>/bin/slapd/server
    
    
    On Unix systems, you should also set your LD_LIBRARY_PATH variable to include the following two locations:

    
    	<NSHOME>/lib
    
    
    	<NSHOME>/bin/slapd
    
    
    For information on how to set environment variables, see the documentation available for your operating system.

     

    Introducing the Directory Server Configuration Files

    There are two main configuration files:

    • slapd.conf--contains the server's parameters and parameter values. These parameters are read by the server at startup time and they define everything from the server's name and the port that it uses, to the type of database(s) used to store directory information, to tuning values. slapd.conf file and its parameters are described in detail in Chapter 14, "Configuration Parameters."

    • slapd.dynamic_ldbm.conf--Contains slapd.conf server parameters that can be changed dynamically; that is, when they are changed from the server manager UI, they do not require a restart of the directory server. This file is included into slapd.conf using the dynamicconf parameter.

    • Currently only the index parameter is supported in slapd.dynamic_ldbm.conf.

     

    Finding the 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/ns-home, and you selected a server identifier of directory, then your configuration files are all stored under:

    /usr/ns-home/slapd-directory/config

    Typewritten Software • bear@typewritten.org • Edmonds, WA 98026