Red Hat Directory Server 8.0

Red Hat Directory Server 8.0

Configuration, Command, and File Reference

Joshua Oakes
Ella Deon Lackey
David O'Brien

Copyright © 2008 Red Hat, Inc.

Legal Notice

Updated: August 13, 2008

Released: January 10, 2008

Abstract

This reference documents the server configuration and command-line utilities provided with Red Hat Directory Server 8.0.

About This Reference
1. Directory Server Overview
2. Examples and Formatting
3. Additional Reading
4. Giving Feedback
5. Revision History
1. Introduction
1.1. Directory Server Configuration
1.2. Directory Server Instance File Reference
1.3. Using Directory Server Command-Line Utilities
1.4. Using Directory Server Command-Line Scripts
2. Core Server Configuration Reference
2.1. Server Configuration - Overview
2.1.1. LDIF and Schema Configuration Files
2.1.2. How the Server Configuration Is Organized
2.2. Accessing and Modifying Server Configuration
2.2.1. Access Control for Configuration Entries
2.2.2. Changing Configuration Attributes
2.3. Core Server Configuration Attributes Reference
2.3.1. cn=config
2.3.2. cn=changelog5
2.3.3. cn=encryption
2.3.4. cn=features
2.3.5. cn=mapping tree
2.3.6. Suffix Configuration Attributes under cn="suffixName"
2.3.7. Replication Attributes under cn=replica, cn="suffixDN", cn=mapping tree, cn=config
2.3.8. Replication Attributes under cn=ReplicationAgreementName, cn=replica, cn="suffixName", cn=mapping tree, cn=config
2.3.9. Synchronization Attributes under cn=syncAgreementName, cn=WindowsReplica,cn="suffixName", cn=mapping tree, cn=config
2.3.10. cn=monitor
2.3.11. cn=replication
2.3.12. cn=SNMP
2.3.13. SNMP Statistic Attributes
2.3.14. cn=tasks
2.3.15. cn=uniqueid generator
3. Plug-in Implemented Server Functionality Reference
3.1. Server Plug-in Functionality Reference
3.1.1. 7-bit Check Plug-in
3.1.2. ACL Plug-in
3.1.3. ACL Preoperation Plug-in
3.1.4. Attribute Uniqueness Plug-in
3.1.5. Binary Syntax Plug-in
3.1.6. Boolean Syntax Plug-in
3.1.7. Case Exact String Syntax Plug-in
3.1.8. Case Ignore String Syntax Plug-in
3.1.9. Chaining Database Plug-in
3.1.10. Class of Service Plug-in
3.1.11. Country String Syntax Plug-in
3.1.12. Distinguished Name Syntax Plug-in
3.1.13. Generalized Time Syntax Plug-in
3.1.14. HTTP Client Plug-in
3.1.15. Integer Syntax Plug-in
3.1.16. Internationalization Plug-in
3.1.17. JPEG Syntax Plug-in
3.1.18. ldbm database Plug-in
3.1.19. Legacy Replication Plug-in
3.1.20. Multi-master Replication Plug-in
3.1.21. Octet String Syntax Plug-in
3.1.22. OID Syntax Plug-in
3.1.23. CLEAR Password Storage Plug-in
3.1.24. CRYPT Password Storage Plug-in
3.1.25. NS-MTA-MD5 Password Storage Scheme Plug-in
3.1.26. SHA Password Storage Scheme Plug-in
3.1.27. SSHA Password Storage Scheme Plug-in
3.1.28. Postal Address String Syntax Plug-in
3.1.29. PTA Plug-in
3.1.30. Referential Integrity Postoperation Plug-in
3.1.31. Retro Changelog Plug-in
3.1.32. Roles Plug-in
3.1.33. Space Insensitive String Syntax Plug-in
3.1.34. State Change Plug-in
3.1.35. Telephone Syntax Plug-in
3.1.36. URI Syntax Plug-in
3.1.37. Views Plug-in
3.2. List of Attributes Common to All Plug-ins
3.2.1. nsslapd-pluginPath
3.2.2. nsslapd-pluginInitfunc
3.2.3. nsslapd-pluginType
3.2.4. nsslapd-pluginEnabled
3.2.5. nsslapd-pluginId
3.2.6. nsslapd-pluginVersion
3.2.7. nsslapd-pluginVendor
3.2.8. nsslapd-pluginDescription
3.3. Attributes Allowed by Certain Plug-ins
3.3.1. nsslapd-pluginLoadNow
3.3.2. nsslapd-pluginLoadGlobal
3.3.3. nsslapd-plugin-depends-on-type
3.3.4. nsslapd-plugin-depends-on-named
3.4. Database Plug-in Attributes
3.4.1. Database Attributes under cn=config, cn=ldbm database, cn=plugins, cn=config
3.4.2. Database Attributes under cn=monitor, cn=ldbm database, cn=plugins, cn=config
3.4.3. Database Attributes under cn=NetscapeRoot, cn=ldbm database, cn=plugins, cn=config and cn=UserRoot, cn=ldbm database, cn=plugins, cn=config
3.4.4. Database Attributes under cn=database, cn=monitor, cn=ldbm database, cn=plugins, cn=config
3.4.5. Database Attributes under cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config
3.4.6. Database Attributes under cn=monitor, cn=NetscapeRoot, cn=ldbm database, cn=plugins, cn=config
3.4.7. Database Attributes under cn=index, cn=NetscapeRoot, cn=ldbm database, cn=plugins, cn=config and cn=index, cn=UserRoot, cn=ldbm database, cn=plugins, cn=config
3.4.8. Database Attributes under cn=attributeName, cn=encrypted attributes, cn=database_name, cn=ldbm database, cn=plugins, cn=config
3.5. Database Link Plug-in Attributes (Chaining Attributes)
3.5.1. Database Link Attributes under cn=config, cn=chaining database, cn=plugins, cn=config
3.5.2. Database Link Attributes under cn=default instance config, cn=chaining database, cn=plugins, cn=config
3.5.3. Database Link Attributes under cn=database link instance name, cn=chaining database, cn=plugins, cn=config
3.5.4. Database Link Attributes under cn=monitor, cn=database instance name, cn=chaining database, cn=plugins, cn=config
3.6. Retro Changelog Plug-in Attributes
3.6.1. nsslapd-changelogdir
3.6.2. nsslapd-changelogmaxage (Max Changelog Age)
4. Server Instance File Reference
4.1. Overview of Directory Server Files
4.2. Backup Files
4.3. Configuration Files
4.4. Database Files
4.5. LDIF Files
4.6. Lock Files
4.7. Log Files
4.8. PID Files
4.9. Tools
4.10. Scripts
5. Access Log and Connection Code Reference
5.1. Access Log Content
5.1.1. Access Logging Levels
5.1.2. Default Access Logging Content
5.1.3. Access Log Content for Additional Access Logging Levels
5.2. Common Connection Codes
5.3. LDAP Result Codes
6. Command-Line Utilities
6.1. Finding and Executing Command-Line Utilities
6.2. Using Special Characters
6.3. Command-Line Utilities Quick Reference
6.4. ldapsearch
6.5. ldapmodify
6.6. ldapdelete
6.7. ldappasswd
6.8. ldif
6.9. dbscan
7. Command-Line Scripts
7.1. Finding and Executing Command-Line Scripts
7.2. Command-Line Scripts Quick Reference
7.3. Shell Scripts
7.3.1. bak2db (Restores a Database from Backup)
7.3.2. cl-dump (Dumps and Decodes the Changelog)
7.3.3. dbverify (Checks for Corrupt Databases)
7.3.4. db2bak (Creates a Backup of a Database)
7.3.5. db2ldif (Exports Database Contents to LDIF)
7.3.6. db2index (Reindexes Database Index Files)
7.3.7. ldif2db (Import)
7.3.8. ldif2ldap (Performs Import Operation over LDAP)
7.3.9. pwdhash (Prints Encrypted Passwords)
7.3.10. monitor (Retrieves Monitoring Information)
7.3.11. repl-monitor (Monitors Replication Status)
7.3.12. restart-slapd (Restarts the Directory Server)
7.3.13. restoreconfig (Restores Administration Server Configuration)
7.3.14. saveconfig (Saves Administration Server Configuration)
7.3.15. start-slapd (Starts the Directory Server)
7.3.16. stop-slapd (Stops the Directory Server)
7.3.17. suffix2instance (Maps a Suffix to a Backend Name)
7.3.18. vlvindex (Creates Virtual List View Indexes)
7.4. Perl Scripts
7.4.1. bak2db.pl (Restores a Database from Backup)
7.4.2. cl-dump.pl (Dumps and Decodes the Changelog)
7.4.3. db2bak.pl (Creates a Backup of a Database)
7.4.4. db2index.pl (Creates and Generates Indexes)
7.4.5. db2ldif.pl (Exports Database Contents to LDIF)
7.4.6. ldif2db.pl (Import)
7.4.7. logconv.pl (Log Converter)
7.4.8. ns-accountstatus.pl (Establishes Account Status)
7.4.9. ns-activate.pl (Activates an Entry or Group of Entries)
7.4.10. ns-inactivate.pl (Inactivates an Entry or Group of Entries)
7.4.11. ns-newpwpolicy.pl (Adds Attributes for Fine-Grained Password Policy)
7.4.12. repl-monitor.pl (Monitors Replication Status)
7.4.13. verify-db.pl (Check for Corrupt Databases)
A. Using the ns-slapd Command-Line Utilities
A.1. Overview of ns-slapd
A.2. Finding and Executing the ns-slapd Command-Line Utilities
A.3. Utilities for Exporting Databases: db2ldif
A.4. Utilities for Restoring and Backing up Databases: ldif2db
A.5. Utilities for Restoring and Backing up Databases: archive2db
A.6. Utilities for Restoring and Backing up Databases: db2archive
A.7. Utilities for Creating and Regenerating Indexes: db2index
Glossary
Index