Netscape NETSCAPE DIRECTORY SERVER 6.02 User manual

Configuration, Command, and
File Reference
Netscape Directory Server
Version6.02
May 2002

Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by
Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed
by the license agreement for the Software and applicable copyright law.
Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations or compilation works is
prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without
notice.
THIS DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE
LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY
ERROR IN THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS,
PROFITS, USE, OR DATA.
The Software and documentation are copyright © 2001 Sun Microsystems, Inc. Portions copyright 1999, 2002 Netscape
Communications Corporation. All rights reserved.
Portions of the Software copyright © 1995 PEER Networks, Inc. All rights reserved. The Software contains the Taligent International
Classes from Taligent, Inc. and IBM Corp. Portions of the Software copyright ©1992-1998 Regents of the University of Michigan. All
rights reserved. The software contains encryption software from RSA Security Inc. Copyright © 1994 RSA Data Security, Inc. All
rights reserved.
Netscape and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and
other countries. Other Netscape logos, product names, and service names are also trademarks of Netscape Communications
Corporation, which may be registered in other countries. Other product and brand names are the exclusive property of their
respective owners.
The downloading, exporting, or reexporting of Netscape software or any underlying information or technology must be in full
compliance with all United States and other applicable laws and regulations. Any provision of Netscape software or documentation
to the U.S. government is with restricted rights as described in the license agreement for that Software.

3
Contents
About This Reference Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
DirectoryServerOverview .............................................................. 17
PrerequisiteReading ................................................................... 18
WhatIsInThisReferenceGuide? ........................................................ 18
ConventionsUsedInThisReferenceGuide................................................ 19
RelatedInformation .................................................................... 19
Chapter 1 Introduction ........................................................21
OverviewofDirectoryServerManagement................................................ 21
DirectoryServerConfiguration .......................................................... 22
DirectoryServerInstanceFileReference................................................... 22
MigratingDirectoryServer .............................................................. 22
UsingDirectoryServerCommand-LineUtilities............................................ 22
UsingDirectoryServerCommand-LineScripts............................................. 23
Chapter 2 CoreServerConfigurationReference ...................................25
ServerConfiguration-Overview......................................................... 25
LDIFConfigurationFiles-Location.................................................... 27
SchemaConfigurationFiles-Location.................................................. 27
HowtheServerConfigurationisOrganized............................................. 27
ConfigurationAttributes........................................................... 27
ConfigurationofPlug-inFunctionality............................................... 28
ConfigurationofDatabases ........................................................ 29
ConfigurationofIndexes........................................................... 29
MigrationofPre-DirectoryServer6.xConfigurationFilestoLDIFFormat................... 30
AccessingandModifyingServerConfiguration ............................................ 30
AccessControlForConfigurationEntries............................................... 30
ChangingConfigurationAttributes .................................................... 31
ModifyingConfigurationEntriesUsingLDAP........................................ 32
RestrictionstoModifyingConfigurationEntriesandAttributes ......................... 33

4 Netscape Directory Server Configuration, Command, and File Reference • May 2002
ConfigurationChangesRequiringServerRestart...................................... 33
CoreServerConfigurationAttributesReference............................................ 33
cn=config........................................................................... 35
nsIdleTimeout(IdleTimeout)....................................................... 35
nsslapd-accesscontrol(EnableAccessControl)........................................ 35
nsslapd-accesslog(AccessLog) ..................................................... 36
nsslapd-accesslog-level ............................................................ 37
nsslapd-accesslog-list.............................................................. 37
nsslapd-accesslog-logbuffering(LogBuffering) ....................................... 37
nsslapd-accesslog-logexpirationtime(AccessLogExpirationTime) ...................... 38
nsslapd-accesslog-logexpirationtimeunit (Access Log Expiration Time Unit) . . . . . . . . . . . . . . 38
nsslapd-accesslog-logging-enabled(AccessLogEnableLogging)........................ 39
nsslapd-accesslog-logmaxdiskspace (Access Log Maximum Disk Space) . . . . . . . . . . . . . . . . . 39
nsslapd-accesslog-logminfreediskspace (Access Log Minimum Free Disk Space) . . . . . . . . . . 40
nsslapd-accesslog-logrotationtime(AccessLogRotationTime).......................... 40
nsslapd-accesslog-logrotationtimeunit(AccessLogRotationTimeUnit).................. 41
nsslapd-accesslog-maxlogsize(AccessLogMaximumLogSize)......................... 41
nsslapd-accesslog-maxlogsperdir (Access Log Maximum Number of Log Files) . . . . . . . . . . . 42
nsslapd-attribute-name-exceptions .................................................. 42
nsslapd-auditlog(AuditLog)....................................................... 43
nsslapd-auditlog-list .............................................................. 44
nsslapd-auditlog-logexpirationtime(AuditLogExpirationTime) ....................... 44
nsslapd-auditlog-logexpirationtimeunit (Audit Log Expiration Time Unit) . . . . . . . . . . . . . . . 44
nsslapd-auditlog-logging-enabled(AuditLogEnableLogging) ......................... 45
nsslapd-auditlog-logmaxdiskspace (Audit Log Maximum Disk Space) . . . . . . . . . . . . . . . . . . . 45
nsslapd-auditlog-logminfreediskspace (Audit Log Minimum Free Disk Space) . . . . . . . . . . . . 46
nsslapd-auditlog-logrotationtime(AuditLogRotationTime) ........................... 46
nsslapd-auditlog-logrotationtimeunit (Audit Log Rotation Time Unit) . . . . . . . . . . . . . . . . . . . 47
nsslapd-auditlog-maxlogsize(AuditLogMaximumLogSize) .......................... 47
nsslapd-auditlog-maxlogsperdir (Audit Log Maximum Number of Log Files) . . . . . . . . . . . . . 48
nsslapd-certmap-basedn(CertificateMapSearchBase) ................................ 49
nsslapd-config.................................................................... 49
nsslapd-ds4-compatible-schema .................................................... 49
nsslapd-enquote-sup-oc(EnableSuperiorObjectClassEnquoting) ...................... 50
nsslapd-errorlog(ErrorLog)........................................................ 51
nsslapd-errorlog-level(ErrorLogLevel) ............................................. 52
nsslapd-errorlog-list............................................................... 53
nsslapd-errorlog-logexpirationtime(ErrorLogExpirationTime) ........................ 53
nsslapd-errorlog-logexpirationtimeunit(ErrorLogExpirationTimeUnit) ................ 53
nsslapd-errorlog-logging-enabled(EnableErrorLogging) .............................. 54
nsslapd-errorlog-logmaxdiskspace(ErrorLogMaximumDiskSpace).................... 54
nsslapd-errorlog-logminfreediskspace (Error Log Minimum Free Disk Space) . . . . . . . . . . . . . 54
nsslapd-errorlog-logrotationtime(ErrorLogRotationTime) ............................ 55

5
nsslapd-errorlog-logrotationtimeunit(ErrorLogRotationTimeUnit) .................... 55
nsslapd-errorlog-maxlogsize(MaximumErrorLogSize) ............................... 56
nsslapd-errorlog-maxlogsperdir(MaximumNumberofErrorLogFiles) ................. 56
nsslapd-groupevalnestlevel ........................................................ 57
nsslapd-instancedir(InstanceDirectory) ............................................. 57
nsslapd-ioblocktimeout(IOBlockTimeOut) ......................................... 58
nsslapd-lastmod(TrackModificationTime) .......................................... 58
nsslapd-listenhost(ListentoIPAddress)............................................. 59
nsslapd-localhost(LocalHost) ...................................................... 59
nsslapd-localuser(LocalUser) ...................................................... 59
nsslapd-maxbersize(MaximumMessageSize)........................................ 60
nsslapd-maxdescriptors(MaximumFileDescriptors) .................................. 60
nsslapd-maxthreadsperconn(MaximumThreadsPerConnection)....................... 61
nsslapd-nagle .................................................................... 62
nsslapd-outbound-ldap-io-timeout.................................................. 62
nsslapd-plug-in................................................................... 62
nsslapd-port(PortNumber) ........................................................ 63
nsslapd-privatenamespaces ........................................................ 63
nsslapd-readonly(ReadOnly) ...................................................... 63
nsslapd-referral(Referral).......................................................... 64
nsslapd-referralmode(ReferralMode) ............................................... 65
nsslapd-reservedescriptors(ReservedFileDescriptors) ................................ 65
nsslapd-return-exact-case(ReturnExactCase) ........................................ 67
nsslapd-rootdn(ManagerDN)...................................................... 67
nsslapd-rootpw(RootPassword) ................................................... 68
nsslapd-rootpwstoragescheme(RootPasswordStorageScheme) ........................ 68
nsslapd-schemacheck(SchemaChecking) ............................................ 69
nsslapd-schemareplace ............................................................ 69
nsslapd-securelistenhost ........................................................... 70
nsslapd-securePort(EncryptedPortNumber) ........................................ 70
nsslapd-security(Security) ......................................................... 71
nsslapd-sizelimit(SizeLimit) ....................................................... 71
nsslapd-threadnumber(ThreadNumber) ............................................ 72
nsslapd-timelimit(TimeLimit) ..................................................... 72
nsslapd-versionstring ............................................................. 73
passwordChange(PasswordChange) ............................................... 73
passwordCheckSyntax(CheckPasswordSyntax) ..................................... 73
passwordExp(PasswordExpiration) ................................................ 74
passwordHistory(PasswordHistory)................................................ 74
passwordInHistory(NumberofPasswordstoRemember) ............................. 75
passwordLockout(AccountLockout)................................................ 75
passwordLockoutDuration(LockoutDuration) ....................................... 76
passwordMaxAge(PasswordMaximumAge) ........................................ 76

6 Netscape Directory Server Configuration, Command, and File Reference • May 2002
passwordMaxFailure(MaximumPasswordFailures) .................................. 77
passwordMinAge(PasswordMinimumAge)......................................... 77
passwordMinLength(PasswordMinimumLength) ................................... 77
passwordMustChange(PasswordMustChange)...................................... 78
passwordResetFailureCount(ResetPasswordFailureCountAfter) ...................... 78
passwordStorageScheme(PasswordStorageScheme).................................. 79
passwordUnlock(UnlockAccount) ................................................. 79
passwordWarning(SendWarning).................................................. 80
cn=changelog5 ...................................................................... 80
nsslapd-changelogdir ............................................................. 81
nsslapd-changelogmaxage(MaxChangelogAge) ..................................... 82
nsslapd-changelogmaxentries(MaxChangelogRecords)............................... 82
cn=encryption ...................................................................... 83
nssslsessiontimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
nssslclientauth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
nsssl2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ............. 84
nsssl3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ............. 84
nsssl3ciphers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
cn=features ......................................................................... 86
cn=mappingtree .................................................................... 86
SuffixConfigurationAttributesUndercn="dc=example,dc=com".......................... 87
nsslapd-state ..................................................................... 87
nsslapd-backend.................................................................. 87
Replication Attributes Under cn=replica, cn=“dc=example,dc=com”,
cn=mappingtree,cn=config ........................................................... 88
cn............................................................................... 88
nsDS5Flags ...................................................................... 89
nsDS5ReplicaBindDN ............................................................. 89
nsDS5ReplicaChangeCount ........................................................ 90
nsDS5ReplicaId................................................................... 90
nsDS5ReplicaLegacyConsumer ..................................................... 90
nsDS5ReplicaName ............................................................... 91
nsDS5ReplicaPurgeDelay .......................................................... 91
nsDS5ReplicaReferral ............................................................. 92
nsDS5ReplicaRoot ................................................................ 92
nsDS5ReplicaTombstonePurgeInterval .............................................. 92
nsDS5ReplicaType ................................................................ 93
nsState .......................................................................... 93
Replication Attributes Under cn=ReplicationAgreementName,cn=replica,
cn="dc=example,dc=com",cn=mappingtree,cn=config................................... 93
description....................................................................... 94
nsDS5ReplicaBindDN ............................................................. 94
nsDS5ReplicaBindMethod ......................................................... 95

7
nsDS5ReplicaChangesSentSinceStartup .............................................. 95
nsDS5ReplicaCredentials .......................................................... 95
nsDS5ReplicaHost ................................................................ 96
nsDS5ReplicaLastInitEnd .......................................................... 96
nsDS5ReplicaLastInitStart.......................................................... 96
nsDS5ReplicaLastInitStatus ........................................................ 97
nsDS5ReplicaLastUpdateEnd....................................................... 97
nsDS5ReplicaLastUpdateStart ...................................................... 98
nsDS5ReplicaLastUpdateStatus..................................................... 98
nsDS5ReplicaPort................................................................. 98
nsDS5ReplicaRefresh.............................................................. 99
nsDS5ReplicaRoot ................................................................ 99
nsDS5ReplicaTimeout ............................................................. 99
nsDS5ReplicaTransportInfo ....................................................... 100
nsDS5ReplicaUpdateInProgress ................................................... 100
nsDS5ReplicaUpdateSchedule ..................................................... 101
nsDS50ruv ...................................................................... 101
cn=monitor ........................................................................ 101
connection ...................................................................... 101
currentConnections .............................................................. 102
totalConnections................................................................. 102
dTableSize ...................................................................... 102
readWaiters ..................................................................... 102
opsInitiated ..................................................................... 102
opsCompleted................................................................... 102
entriesSent ...................................................................... 102
bytesSent ....................................................................... 102
currentTime..................................................................... 102
startTime ....................................................................... 102
nbackEnds ...................................................................... 102
backendMonitorDN.............................................................. 103
cn=replication...................................................................... 103
cn=SNMP ......................................................................... 103
nssnmpenabled.................................................................. 103
nssnmporganization ............................................................. 104
nssnmplocation.................................................................. 104
nssnmpcontact .................................................................. 104
nssnmpdescription............................................................... 105
nssnmpmasterhost ............................................................... 105
nssnmpmasterport ............................................................... 105
cn=tasks........................................................................... 106
cn=uniqueidgenerator .............................................................. 106
nsstate.......................................................................... 106

8 Netscape Directory Server Configuration, Command, and File Reference • May 2002
ConfigurationQuickReferenceTables ................................................... 106
LDIFConfigurationFiles ............................................................ 106
ConfigurationChangesRequiringServerRestart ....................................... 109
Chapter 3 Plug-in Implemented Server Functionality Reference . . . . . . . . . . . . . . . . . . . . 111
Overview ............................................................................ 111
ObjectClassesforPlug-InConfiguration .............................................. 112
ServerPlug-inFunctionalityReference ................................................... 112
7-bitcheckPlug-in.................................................................. 113
ACLPlug-in ....................................................................... 113
ACLpreoperationPlug-in ........................................................... 114
BinarySyntaxPlug-in ............................................................... 114
BooleanSyntaxPlug-in.............................................................. 115
CaseExactStringSyntaxPlug-in ..................................................... 115
CaseIgnoreStringSyntaxPlug-in .................................................... 116
ChainingdatabasePlug-in........................................................... 116
ClassofServicePlug-in ............................................................. 117
CountryStringSyntaxPlug-in ....................................................... 117
DistinguishedNameSyntaxPlug-in .................................................. 118
GeneralizedTimeSyntaxPlug-in ..................................................... 118
IntegerSyntaxPlug-in .............................................................. 119
InternationalizationPlug-in.......................................................... 119
ldbmdatabasePlug-in .............................................................. 120
LegacyReplicationPlug-in .......................................................... 121
MultimasterReplicationPlug-in...................................................... 121
OctetStringSyntaxPlug-in .......................................................... 122
CLEARPasswordStoragePlug-in .................................................... 122
CRYPTPasswordStoragePlug-in .................................................... 123
NS-MTA-MD5PasswordStorageSchemePlug-in....................................... 123
SHAPasswordStorageSchemePlug-in ............................................... 124
SSHAPasswordStorageSchemePlug-in .............................................. 124
PostalAddressStringSyntaxPlug-in.................................................. 125
PresencePlug-in.................................................................... 126
PTAPlug-in ....................................................................... 126
ReferentialIntegrityPostoperationPlug-in............................................. 127
RetroChangelogPlug-in ............................................................ 128
RolesPlug-in ...................................................................... 128
StateChangePlug-in................................................................ 129
TelephoneSyntaxPlug-in ........................................................... 129
UIDUniquenessPlug-in............................................................. 130
URISyntaxPlug-in ................................................................. 131
ListofAttributesCommontoAllPlug-ins................................................ 132
nsslapd-pluginPath ................................................................. 132

9
nsslapd-pluginInitfunc .............................................................. 132
nsslapd-pluginType ................................................................ 132
nsslapd-pluginEnabled.............................................................. 133
nsslapd-pluginId ................................................................... 133
nsslapd-pluginVersion .............................................................. 133
nsslapd-pluginVendor .............................................................. 134
nsslapd-pluginDescription........................................................... 134
AttributesAllowedbyCertainPlug-ins .................................................. 135
nsslapd-plugin-depends-on-type ..................................................... 135
nsslapd-plugin-depends-on-named ................................................... 135
DatabasePlug-inAttributes ............................................................ 136
Database Attributes Under cn=config,cn=ldbm database,cn=plugins,cn=config . . . . . . . . . . . . . 136
nsLookthroughLimit ............................................................. 137
nsslapd-allidsthreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
nsslapd-cache-autosize ........................................................... 138
nsslapd-cache-autosize-split....................................................... 138
nsslapd-dbcachesize.............................................................. 138
nsslapd-db-checkpoint-interval .................................................... 139
nsslapd-db-circular-logging ....................................................... 140
nsslapd-db-debug................................................................ 140
nsslapd-db-durable-transactions ................................................... 141
nsslapd-db-home-directory ....................................................... 141
nsslapd-db-idl-divisor ............................................................ 143
nsslapd-db-logbuf-size ........................................................... 143
nsslapd-db-logdirectory .......................................................... 144
nsslapd-db-logfile-size............................................................ 144
nsslapd-db-page-size............................................................. 145
nsslapd-db-spin-count............................................................ 145
nsslapd-db-transaction-batch-val .................................................. 145
nsslapd-db-transaction-logging .................................................... 146
nsslapd-db-trickle-percentage ..................................................... 147
nsslapd-db-verbose .............................................................. 147
nsslapd-dbncache................................................................ 147
nsslapd-import-cachesize ......................................................... 148
nsslapd-mode ................................................................... 148
Database Attributes Under cn=monitor,cn=ldbm database, cn=plugins,cn=config . . . . . . . . . . . 149
dbcachehits ..................................................................... 149
dbcachetries..................................................................... 149
dbcachehitratio .................................................................. 149
dbcachepagein .................................................................. 149
dbcachepageout ................................................................. 149
dbcacheroevict .................................................................. 149
dbcacherwevict.................................................................. 149

10 Netscape Directory Server Configuration, Command, and File Reference • May 2002
Database Attributes Under cn=NetscapeRoot,cn=ldbm database, cn=plugins,cn=config and
cn=UserRoot,cn=ldbmdatabase,cn=plugins,cn=config.................................. 150
nsslapd-cachesize ................................................................ 150
nsslapd-cachememsize ........................................................... 151
nsslapd-directory ................................................................ 151
nsslapd-readonly ................................................................ 151
nsslapd-require-index ............................................................ 152
nsslapd-suffix ................................................................... 152
Database Attributes Under cn=database,cn=monitor,cn=ldbm database, cn=plugins,cn=config 153
nsslapd-db-abort-rate ............................................................ 153
nsslapd-db-active-txns............................................................ 153
nsslapd-db-cache-hit ............................................................. 153
nsslapd-db-cache-try ............................................................. 153
nsslapd-db-cache-region-wait-rate ................................................. 153
nsslapd-db-cache-size-bytes ....................................................... 153
nsslapd-db-clean-pages........................................................... 153
nsslapd-db-commit-rate .......................................................... 153
nsslapd-db-deadlock-rate ......................................................... 154
nsslapd-db-dirty-pages ........................................................... 154
nsslapd-db-hash-buckets.......................................................... 154
nsslapd-db-hash-elements-examine-rate ............................................ 154
nsslapd-db-hash-search-rate....................................................... 154
nsslapd-db-lock-conflicts ......................................................... 154
nsslapd-db-lock-region-wait-rate .................................................. 154
nsslapd-db-lock-request-rate ...................................................... 154
nsslapd-db-lockers ............................................................... 154
nsslapd-db-log-bytes-since-checkpoint.............................................. 154
nsslapd-db-log-region-wait-rate ................................................... 154
nsslapd-db-log-write-rate ......................................................... 155
nsslapd-db-longest-chain-length ................................................... 155
nsslapd-db-page-create-rate ....................................................... 155
nsslapd-db-page-read-rate ........................................................ 155
nsslapd-db-page-ro-evict-rate ..................................................... 155
nsslapd-db-page-rw-evict-rate..................................................... 155
nsslapd-db-page-trickle-rate....................................................... 155
nsslapd-db-page-write-rate........................................................ 155
nsslapd-db-pages-in-use .......................................................... 155
nsslapd-db-txn-region-wait-rate ................................................... 155
Database Attributes Under cn=default indexes,cn=config,cn=ldbm database,
cn=plugins,cn=config ............................................................... 156
nsSystemIndex .................................................................. 156
nsIndexType .................................................................... 156
nsMatchingRule ................................................................. 157

11
cn.............................................................................. 157
description...................................................................... 158
Database Attributes Under cn=monitor,cn=Netscaperoot,cn=ldbm database,
cn=plugins,cn=config ............................................................... 158
dbfilenamenumber............................................................... 158
dbfilecachehit ................................................................... 158
dbfilecachemiss.................................................................. 158
dbfilepagein..................................................................... 158
dbfilepageout ................................................................... 159
Database Attributes Under cn=index,cn=Netscaperoot,cn=ldbm database, cn=plugins,cn=config
andcn=index,cn=UserRoot,cn=ldbmdatabase,cn=plugins,cn=config ..................... 159
DatabaseLinkPlug-inAttributes(chainingattributes) ..................................... 160
Database Link Attributes Under cn=config,cn=chaining database, cn=plugins,cn=config . . . . . 161
nsActiveChainingComponents .................................................... 161
nsMaxResponseDelay ............................................................ 161
nsMaxTestResponseDelay ........................................................ 162
nsTransmittedControls ........................................................... 162
Database Link Attributes Under cn=default instance config,cn=chaining database,
cn=plugins,cn=config ............................................................... 163
nsAbandonedSearchCheckInterval................................................. 163
nsBindConnectionsLimit.......................................................... 163
nsBindRetryLimit................................................................ 164
nsBindTimeout .................................................................. 164
nsCheckLocalACI................................................................ 164
nsConcurrentBindLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
nsConcurrentOperationsLimit ..................................................... 165
nsConnectionLife ................................................................ 165
nsOperationConnectionsLimit ..................................................... 166
nsProxiedAuthorization .......................................................... 166
nsReferralOnScopedSearch........................................................ 167
nsSizeLimit ..................................................................... 167
nsTimeLimit .................................................................... 167
Database Link Attributes Under cn=database link instance name,cn=chaining database,
cn=plugins,cn=config ............................................................... 168
nsFarmServerURL ............................................................... 168
nsMultiplexorBindDN............................................................ 168
nsMultiplexorCredentials ......................................................... 169
nshoplimit ...................................................................... 169
Database Link Attributes Under cn=monitor,cn=database instance name,
cn=chainingdatabase,cn=plugins,cn=config ........................................... 170
nsAddCount .................................................................... 170
nsDeleteCount .................................................................. 170
nsModifyCount.................................................................. 170

12 Netscape Directory Server Configuration, Command, and File Reference • May 2002
nsRenameCount ................................................................. 170
nsSearchBaseCount .............................................................. 170
nsSearchOneLevelCount.......................................................... 170
nsSearchSubtreeCount............................................................ 170
nsAbandonCount................................................................ 170
nsBindCount .................................................................... 170
nsUnbindCount ................................................................. 171
nsCompareCount ................................................................ 171
nsOperationConnectionCount ..................................................... 171
nsBindConnectionCount.......................................................... 171
RetroChangelogPlug-inAttributes...................................................... 171
nsslapd-changelogdir ............................................................ 171
nsslapd-changelogmaxage(MaxChangelogAge) .................................... 172
Chapter 4 ServerInstanceFileReference....................................... 173
OverviewofDirectoryServerFiles ...................................................... 173
BackupFiles.......................................................................... 175
ConfigurationFiles .................................................................... 175
DatabaseFiles ........................................................................ 175
ldifFiles ............................................................................. 176
LockFiles ............................................................................ 177
LogFiles ............................................................................. 177
Chapter 5 Access Log and Connection Code Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
AccessLogContent ................................................................... 179
AccessLoggingLevels .............................................................. 180
DefaultAccessLoggingContent...................................................... 181
ConnectionNumber.............................................................. 182
FileDescriptor................................................................... 182
SlotNumber .................................................................... 182
OperationNumber............................................................... 183
MethodType.................................................................... 183
VersionNumber................................................................. 183
ErrorNumber ................................................................... 183
TagNumber .................................................................... 183
NumberofEntries ............................................................... 184
ElapsedTime.................................................................... 184
LDAPRequestType.............................................................. 184
LDAPResponseType ............................................................ 185
UnindexedSearchIndicator ....................................................... 185
ExtendedOperationOID ......................................................... 185
ChangeSequenceNumber ........................................................ 186

13
AbandonMessage ............................................................... 187
MessageID ..................................................................... 187
SASLMulti-StageBindLogging ................................................... 187
AccessLogContentforAdditionalAccessLoggingLevels ............................... 188
ConnectionDescription........................................................... 189
OptionsDescription.............................................................. 189
CommonConnectionCodes ............................................................ 190
LDAPResultCodes ................................................................... 191
Chapter 6 Migration from Earlier Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Migrationfrom4.xDirectoryServerto6.x ................................................ 193
ServerAttributes ................................................................... 194
DatabaseAttributes................................................................. 197
UpgradefromDirectoryServer5.0to6.x ................................................. 198
GeneralServerConfigurationAttributes............................................... 198
DatabaseAttributes................................................................. 202
DatabaseLinkAttributes ............................................................ 203
SNMPAttributes ................................................................... 204
Chapter 7 Command-LineUtilities..............................................205
Finding and Executing Command-Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Command-Line Utilities Quick Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
UsingSpecialCharacters ............................................................... 207
ldapsearch ........................................................................... 208
ldapsearchOptions ................................................................. 208
CommonlyUsedldapsearchOptions ............................................... 208
SSLOptions..................................................................... 210
AdditionalldapsearchOptions .................................................... 211
ldapmodify........................................................................... 213
Syntax ............................................................................ 213
ldapmodifyOptions ................................................................ 214
CommonlyUsedldapmodifyOptions .............................................. 214
SSLOptions..................................................................... 215
AdditionalldapmodifyOptions ................................................... 216
ldapdelete............................................................................ 218
Syntax ............................................................................ 218
ldapdeleteOptions ................................................................. 218
CommonlyUsedldapdeleteOptions ............................................... 218
SSLOptions..................................................................... 219
AdditionalldapdeleteOptions..................................................... 220
ldif .................................................................................. 221
Syntax ............................................................................ 221

14 Netscape Directory Server Configuration, Command, and File Reference • May 2002
Options ........................................................................... 222
Chapter 8 Command-LineScripts ............................................. 223
FindingandExecutingCommand-LineScripts............................................ 223
Command-LineScriptsQuickReference ................................................. 224
ShellandBatchScripts................................................................. 226
bak2db(Restoredatabasefrombackup) ............................................... 227
Syntax.......................................................................... 227
db2bak(Createbackupofdatabase)................................................... 228
Syntax.......................................................................... 228
db2ldif(ExportdatabasecontentstoLDIF)............................................. 228
Syntax.......................................................................... 228
Options......................................................................... 229
db2dsml(ExportdatabasecontentstoDSML) .......................................... 229
Syntax.......................................................................... 230
Options......................................................................... 230
dsml2db(ImportDSMLdocumentcontentsintodatabase)............................... 230
Syntax.......................................................................... 230
Options......................................................................... 231
getpwenc(Printencryptedpassword) ................................................. 231
Syntax.......................................................................... 231
Options......................................................................... 231
ldif2db(Import) .................................................................... 231
Syntax.......................................................................... 232
Options......................................................................... 232
ldif2ldap(PerformimportoperationoverLDAP) ....................................... 233
Syntax.......................................................................... 233
Options......................................................................... 233
monitor(Retrievemonitoringinformation) ............................................ 234
Syntax.......................................................................... 234
Options......................................................................... 234
restart-slapd(RestarttheDirectoryServer)............................................. 234
Syntax.......................................................................... 234
Options......................................................................... 234
ExitStatus ...................................................................... 234
restoreconfig(RestoreAdministrationServerConfiguration) ............................. 235
Syntax.......................................................................... 235
Options......................................................................... 235
saveconfig(SaveAdministrationServerConfiguration).................................. 235
Syntax.......................................................................... 236
Options......................................................................... 236
start-slapd(StarttheDirectoryServer)................................................. 236
Syntax.......................................................................... 236

15
Options......................................................................... 236
ExitStatus ...................................................................... 236
stop-slapd(StoptheDirectoryServer)................................................. 237
Syntax.......................................................................... 237
Options......................................................................... 237
ExitStatus ...................................................................... 237
suffix2instance(MapSuffixtoBackendName) ......................................... 237
Syntax.......................................................................... 237
Options......................................................................... 237
vlvindex(Createvirtuallistview(VLV)indexes) ....................................... 238
Syntax.......................................................................... 238
Options......................................................................... 238
PerlScripts ........................................................................... 239
bak2db.pl(Restoredatabasefrombackup) ............................................. 239
Syntax.......................................................................... 239
Options......................................................................... 239
db2bak.pl(Createbackupofdatabase) ................................................ 240
Syntax.......................................................................... 240
Options......................................................................... 240
db2index.pl(Createandgenerateindexes) ............................................. 240
Syntax.......................................................................... 241
Options......................................................................... 241
db2ldif.pl(ExportdatabasecontentstoLDIF) .......................................... 241
Syntax.......................................................................... 241
Options......................................................................... 241
ldif2db.pl(Import).................................................................. 242
Syntax.......................................................................... 243
Options......................................................................... 243
migrateInstance6(MigratetoDirectoryServer6.x) ...................................... 244
Syntax.......................................................................... 244
Options......................................................................... 244
ns-accountstatus.pl(Establishaccountstatus) .......................................... 245
Syntax.......................................................................... 245
Options......................................................................... 245
ns-activate.pl(Activateanentryorgroupofentries) .................................... 246
Syntax.......................................................................... 246
Options......................................................................... 246
ns-inactivate.pl(Inactivateanentryorgroupofentries) ................................. 246
Syntax.......................................................................... 246
Options......................................................................... 247
Appendix A Using the ns-slapd and slapd.exe Command-Line Utilities . . . . . . . . . . . . . . . 249
Overviewofns-slapdandslapd.exeCommands .......................................... 249

16 Netscape Directory Server Configuration, Command, and File Reference • May 2002
ns-slapd(UNIX).................................................................... 250
slapd.exe(Windows)................................................................ 250
FindingandExecutingthens-slapdandslapd.exeCommand-LineUtilities................... 250
ns-slapd and slapd.exe Command-Line Utilities for Exporting Databases . . . . . . . . . . . . . . . . . . . . . 251
db2ldif ............................................................................ 251
ns-slapd and slapd.exe Command-Line Utilities for Restoring and Backing up Databases . . . . . . . 253
ldif2db ............................................................................ 253
archive2db ........................................................................ 255
db2archive ........................................................................ 255
ns-slapd and slapd.exe Command-Line Utilities for Creating and Regenerating Indexes . . . . . . . . 256
db2index .......................................................................... 256
Glossary .................................................................... 259
Index ....................................................................... 275

17
About This Reference Guide
Netscape Directory Server (Directory Server) is a powerful and scalable distributed
directory server based on the industry-standard Lightweight Directory Access
Protocol (LDAP). Directory Server is the cornerstone for building a centralized and
distributed data repository that can be used in your intranet, over your extranet
with your trading partners, or over the public Internet to reach your customers.
This Configuration, Command, and File Reference documents server configuration and
command-line utilities provided with Directory Server.
This preface contains the following sections:
• Directory Server Overview (page 17)
• Prerequisite Reading (page 18)
• What Is In This Reference Guide? (page 18)
• Conventions Used In This Reference Guide (page 19)
• Related Information (page 19)
Directory Server Overview
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.

Prerequisite Reading
18 Netscape Directory Server Configuration, Command, and File Reference • May 2002
•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.
Prerequisite Reading
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
this book before you attempt to administer the Directory Server.
What Is In This Reference Guide?
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.

Conventions Used In This Reference Guide
About This Reference Guide 19
Conventions Used In This Reference Guide
This section explains the conventions used in this book.
Monospaced font—Thistypefaceisusedforanytextthatappearsonthecomputer
screen or text that you should type. It is also used for filenames, functions, and
examples.
If you are using a Windows-based Directory Server, you should assume the
Windows equivalent file paths whenever UNIX file paths are shown in this book.
All 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 all paths specified in this book accordingly.
Related Information
The document set for Directory Server also contains the following guides:
•Netscape Directory Server Installation Guide. Procedures for installing Directory
Server as well as procedures for migrating your Directory Server.
•Netscape Directory Server Deployment Guide. Provides an overview for planning
your deployment of the Directory Server. Includes deployment examples.
•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.
For a list of documentation installed with Directory Server, open the
/usr/netscape/servers/manual/en/slapd/index.htm file.
NOTE Notes and Warnings mark important information. Make sure you
read the information before continuing with a task.

Related Information
20 Netscape Directory Server Configuration, Command, and File Reference • May 2002
For the latest information about Directory Server, including current release notes,
complete product documentation, technical notes, and deployment information,
checkthissite:http://enterprise.netscape.com/docs