Sun Java System Directory Server Enterprise Edition 6.0 Reference

Chapter 15 Directory Server File Reference

This chapter describes the files found after you install Directory Server, and after you create server instances.

The examples shown in this chapter are for Solaris systems. File extensions and path separators may differ for your operating system. This chapter includes the following sections.

If you installed software from native packages, you may also use the packaging commands on your system to list the files installed. For example, after installing from native packages on Solaris systems, you can obtain a full list for a particular package using the pkgchk -v package-name command.

If you installed software from a zip distribution, find lists of installed files in the install-path/dsee6/data/ directory.

Software Layout for Directory Server

This section describes the file layout you find after installing Directory Server from the zip distribution. All files locations are relative to the path where you installed the product. For information on default native package installation locations, see Default Paths and Command Locations.

install-path/ds6/

Directory Server files shared by server instances. This directory houses the following files of interest.

install-path/ds6/bin/dsadm: Directory Server command for local administration. See dsadm(1M).
install-path/ds6/bin/dsconf: Directory Server command for configuration over LDAP. See dsconf(1M).
install-path/ds6/bin/dsmig: Directory Server command for migration to this version of Directory Server. See dsmig(1M).
install-path/ds6/bin/dsrepair: Directory Server command for repairing replicated directory entries, not intended for use without help for qualified support personnel. See dsrepair(1M).
install-path/ds6/bin/entrycmp: Directory Server command for comparing directory entries across replica. See entrycmp(1).
install-path/ds6/bin/fildif: Directory Server command for filtering LDIF content. See fildif(1).
install-path/ds6/bin/insync: Directory Server command for examining replica synchronization. See insync(1).
install-path/ds6/bin/mmldif: Directory Server command for combining LDIF content. See mmldif(1).
install-path/ds6/bin/ns-accountstatus: Directory Server command for examining whether an account is locked. See ns-accountstatus(1M).
install-path/ds6/bin/ns-activate: Directory Server command for activating a locked account. See ns-activate(1M).
install-path/ds6/bin/ns-inactivate: Directory Server command for explicitly locking an account. See ns-inactivate(1M).
install-path/ds6/bin/pwdhash: Directory Server command for displaying the hashed form of a password value. See pwdhash(1).
install-path/ds6/bin/repldisc: Directory Server command for discovering a replication topology. See repldisc(1).
install-path/ds6/bin/schema_push: Directory Server command for pushing schema updates to replicas. See schema_push(1M).
install-path/ds6/etc/: Registration configuration for Directory Server monitoring agents, not intended to be used directly.
install-path/ds6/examples/: Sample Directory Server plug-ins.
install-path/ds6/include/: Directory Server plug-in header files.
install-path/ds6/install/: Directory Server instance installation templates, not intended to be used directly.
install-path/ds6/ldif/Example.ldif: Sample Directory Server LDIF content.
install-path/ds6/ldif/Example-roles.ldif: Sample Directory Server LDIF content with grouping based on roles.
install-path/ds6/lib/: Shared Directory Server libraries, not intended for use directly.
install-path/ds6/plugins/: Directory Server plug-in configuration files, not intended to be used directly.
install-path/ds6/resources/: Directory Server resource files, not intended to be used directly.
install-path/ds6/schema/: Directory Server instance LDAP schema templates, not intended to be used directly.

install-path/dscc6/

Directory Service Control Center agent files shared by multiple Directory Server Enterprise Edition component products. This directory houses the following files of interest.

install-path/dscc6/bin/dsccmon: Command to monitor servers managed through Directory Service Control Center. See dsccmon(1M).
install-path/dscc6/bin/dsccreg: Command to manage the Directory Service Control Center registry. See dsccreg(1M).
install-path/dscc6/bin/dsccsetup: Command to set up Directory Service Control Center. See dsccsetup(1M).
install-path/dscc6/etc/: Directory Service Control Center agent configuration information, not intended to be used directly.
install-path/dscc6/lib/: Shared libraries, not intended to be used directly.

install-path/dsee6/

Files shared by multiple Directory Server Enterprise Edition component products. This directory houses the following files of interest.

install-path/dsee6/bin/certutil: NSS certificate manipulation command used by other tools, not intended to be used directly.
install-path/dsee6/bin/dsee_deploy: Command to install and remove software. See dsee_deploy(1M).
install-path/dsee6/bin/ldif: Command to base64 encode LDIF attribute values. See ldif(1)
install-path/dsee6/cacao_2.0/: Common agent container files shared by Directory Server Enterprise Edition component products, not intended to be used directly.
install-path/dsee6/data/: Lists of installed files used by the dsee_deploy command, not intended to be used directly.
install-path/dsee6/lib/: Libraries shared by Directory Server Enterprise Edition component products, not intended to be used directly.
install-path/dsee6/man/: Directory Server Enterprise Edition online reference manual pages. See also Sun Java System Directory Server Enterprise Edition 6.0 Man Page Reference.
install-path/dsee6/SUNWmfwk/: Monitoring framework files shared by Directory Server Enterprise Edition component products, not intended to be used directly.
install-path/dsee6/private/include/: Directory SDK for C header files used by Directory Server Enterprise Edition component products.
install-path/dsee6/private/lib/: Directory SDK for C shared libraries used by Directory Server Enterprise Edition component products.

install-path/dsrk6/bin/ldapcmp

Directory Server Resource Kit command to compare LDAP entries from two directories. See ldapcmp(1).

install-path/dsrk6/bin/ldapcompare

Directory Server Resource Kit command to perform LDAP compare operations. See ldapcompare(1).

install-path/dsrk6/bin/ldapdelete

Directory Server Resource Kit command to delete directory entries. See ldapdelete(1).

install-path/dsrk6/bin/ldapmodify

Directory Server Resource Kit command to update entries over LDAP. See ldapmodify(1).

install-path/dsrk6/bin/ldappasswd

Directory Server Resource Kit command to change user passwords. See ldappasswd(1).

install-path/dsrk6/bin/ldapsearch

Directory Server Resource Kit command to search a directory. See ldapsearch(1).

install-path/dsrk6/lib/

Libraries used by Directory Server Resource Kit commands, not intended to be used directly.

install-path/etc/

Container for configuration files.

install-path/jre/

Java Runtime Environment, not intended to be used directly.

install-path/var/

Container for runtime files, not intended to be used directly.

Directory Server Instance Default Layout

This section describes the file layout you find after creating a Directory Server instance. The instance-path is the file system path where you created the instance.

This section does not cover the following deprecated scripts, generated for backwards compatibility:

bak2db
db2bak
db2ldif
ldif2db
restart-slapd
start-slapd
stop-slapd

If you do not use the scripts, you can safely remove them.

instance-path/alias/

NSS certificate database directory.

instance-path/alias/certmap.conf

NSS certificate mapping configuration file.

instance-path/bak/

Default data backup directory.

Each directory database backup is held in its own file system directory. The name of the backup directory corresponds to the time and date of the backup.

instance-path/confbak/

Default configuration backup directory provided for you to backup up versions of your configuration.

instance-path/conf_bk/

Default server configuration backup directory.

This directory contains a backup copy of the original Directory Server configuration file, dse.ldif, generated when the server instance was created. This copy can be compared with the current configuration file for troubleshooting.

instance-path/config/

Server configuration directory.

instance-path/config/dse.ldif

Server configuration file, not intended to be edited directly.

instance-path/config/schema/

LDAP schema configuration files. See dirserv(5dssd).

instance-path/db/

Default server database files directory. When a suffix has been created, the following database files are stored in this file system directory.

__db.00x

Files used internally by the database. Do not move, delete, or modify these files.

DBVERSION

File that identifies the version of the database.

guardian

File used to store information about the state of the database, used to determine whether database recovery is required.

log.xxxxxxxxxx

Files used to store the database transaction logs.

suffix

Files that store your directory suffix information. The directory name is derived from the suffix name, such that the database for a suffix identified by DN dc=example,dc=com is stored in a file system directory named example.

For every index defined in the database, the suffix directory contains a file with a name of the form suffix_indexedAttr.db3, such that an index of CNs for dc=example,dc=com has file name example_cn.db3.

Suffix directories also contain a file named suffix_id2entry.db3. The suffix_id2entry.db3 file contains the directory database entries.

If necessary, all index files can be rebuild from the suffix_id2entry.db3 file. To recreate the index files, reindex the suffix.

instance-path/locks/

Lock files directory.

Lock files stored here in subdirectories exports/, imports/, and server/ prevent simultaneous operations from conflicting with each other. The lock mechanisms allow one server instance to run at a time. The lock mechanisms also permit only one dsadm import (offline import) operation at a time. As a result, no export or server instance operations can be run during import.

The lock restriction does not however apply to dsconf import (online import) operations. Multiple online imports can run at the same time.

instance-path/logs/

Default server logs directory. The following files are stored here.

access logs: This file records information about client access to Directory Server. For detail about access logs, see Access Logs.
audit logs: This file records information about modifications to Directory Server data. For detail about audit logs, see Audit Logs.
core files: By default, server core files are dumped here during a crash.
errors logs: This file records errors, warnings, and informational messages logged during Directory Server operation. For detail about errors logs, see Error Logs. See also Chapter 14, Directory Server Error Log Message Reference.
pid file: This file holds the process identifier of the running server.
slapd.stats file: This memory mapped-file cannot be read in an editor. The slapd.stats file contains data collected for SNMP, which is communicated to the agent responsible for handling SNMP requests.

instance-path/plugins/signatures/

Plug-in signatures directory, not intended to be used directly.

instance-path/tmp/

Server runtime files directory, not intended to be used directly.