Netscape NETSCAPE DIRECTORY SERVER 6.1 - DEPLOYMENT User manual

Configuration, Command, and
File Reference
Netscape Directory Server
Version6.1
August 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DirectoryServerOverview .............................................................. 19
PrerequisiteReading ................................................................... 20
WhatIsInThisReferenceGuide? ........................................................ 20
ConventionsUsedInThisReferenceGuide................................................ 21
RelatedInformation .................................................................... 21
Chapter 1 Introduction ........................................................23
OverviewofDirectoryServerManagement................................................ 23
DirectoryServerConfiguration .......................................................... 24
DirectoryServerInstanceFileReference................................................... 24
MigratingDirectoryServer .............................................................. 24
UsingDirectoryServerCommand-LineUtilities............................................ 24
UsingDirectoryServerCommand-LineScripts............................................. 25
Chapter 2 CoreServerConfigurationReference ...................................27
ServerConfiguration-Overview......................................................... 27
LDIFConfigurationFiles-Location.................................................... 29
SchemaConfigurationFiles-Location.................................................. 29
HowtheServerConfigurationisOrganized............................................. 29
ConfigurationAttributes........................................................... 29
ConfigurationofPlug-inFunctionality............................................... 30
ConfigurationofDatabases ........................................................ 31
ConfigurationofIndexes........................................................... 31
MigrationofPre-DirectoryServer6.xConfigurationFilestoLDIFFormat................... 32
AccessingandModifyingServerConfiguration ............................................ 32
AccessControlForConfigurationEntries............................................... 32
ChangingConfigurationAttributes .................................................... 33
ModifyingConfigurationEntriesUsingLDAP........................................ 34
RestrictionstoModifyingConfigurationEntriesandAttributes ......................... 35

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

5
nsslapd-errorlog-logexpirationtime(ErrorLogExpirationTime) ........................ 58
nsslapd-errorlog-logexpirationtimeunit (Error Log Expiration Time Unit) . . . . . . . . . . . . . . . . 58
nsslapd-errorlog-logging-enabled(EnableErrorLogging) .............................. 58
nsslapd-errorlog-logmaxdiskspace(ErrorLogMaximumDiskSpace).................... 59
nsslapd-errorlog-logminfreediskspace (Error Log Minimum Free Disk Space) . . . . . . . . . . . . . 59
nsslapd-errorlog-logrotationsync-enabled (Error Log Rotation Sync Enabled) . . . . . . . . . . . . . 60
nsslapd-errorlog-logrotationsynchour(ErrorLogRotationSyncHour)................... 60
nsslapd-errorlog-logrotationsyncmin(ErrorLogRotationSyncMinute).................. 61
nsslapd-errorlog-logrotationtime(ErrorLogRotationTime) ............................ 61
nsslapd-errorlog-logrotationtime(ErrorLogRotationTime) ............................ 62
nsslapd-errorlog-logrotationtimeunit(ErrorLogRotationTimeUnit) .................... 62
nsslapd-errorlog-maxlogsize(MaximumErrorLogSize) ............................... 63
nsslapd-errorlog-maxlogsperdir(MaximumNumberofErrorLogFiles) ................. 63
nsslapd-groupevalnestlevel ........................................................ 64
nsslapd-idletimeout(DefaultIdleTimeout)........................................... 64
nsslapd-instancedir(InstanceDirectory) ............................................. 65
nsslapd-ioblocktimeout(IOBlockTimeOut) ......................................... 65
nsslapd-lastmod(TrackModificationTime) .......................................... 65
nsslapd-listenhost(ListentoIPAddress)............................................. 66
nsslapd-localhost(LocalHost) ...................................................... 66
nsslapd-localuser(LocalUser) ...................................................... 67
nsslapd-maxbersize(MaximumMessageSize)........................................ 67
nsslapd-maxdescriptors(MaximumFileDescriptors) .................................. 67
nsslapd-maxthreadsperconn(MaximumThreadsPerConnection)....................... 69
nsslapd-nagle .................................................................... 69
nsslapd-outbound-ldap-io-timeout.................................................. 69
nsslapd-plug-in................................................................... 70
nsslapd-port(PortNumber) ........................................................ 70
nsslapd-privatenamespaces ........................................................ 70
nsslapd-readonly(ReadOnly) ...................................................... 71
nsslapd-referral(Referral).......................................................... 71
nsslapd-referralmode(ReferralMode) ............................................... 72
nsslapd-reservedescriptors(ReservedFileDescriptors) ................................ 72
nsslapd-return-exact-case(ReturnExactCase) ........................................ 74
nsslapd-rootdn(ManagerDN)...................................................... 74
nsslapd-rootpw(RootPassword) ................................................... 75
nsslapd-rootpwstoragescheme(RootPasswordStorageScheme) ........................ 75
nsslapd-schemacheck(SchemaChecking) ............................................ 76
nsslapd-schemareplace ............................................................ 77
nsslapd-securelistenhost ........................................................... 77
nsslapd-securePort(EncryptedPortNumber) ........................................ 77
nsslapd-security(Security) ......................................................... 78
nsslapd-sizelimit(SizeLimit) ....................................................... 78

6 Netscape Directory Server Configuration, Command, and File Reference • August 2002
nsslapd-ssl-check-hostname (Verify Hostname for Outbound Connections) . . . . . . . . . . . . . . . 79
nsslapd-threadnumber(ThreadNumber) ............................................ 80
nsslapd-timelimit(TimeLimit) ..................................................... 80
nsslapd-versionstring ............................................................. 81
passwordChange(PasswordChange) ............................................... 81
passwordCheckSyntax(CheckPasswordSyntax) ..................................... 81
passwordExp(PasswordExpiration) ................................................ 82
passwordHistory(PasswordHistory)................................................ 82
passwordInHistory(NumberofPasswordstoRemember) ............................. 83
passwordLockout(AccountLockout)................................................ 83
passwordLockoutDuration(LockoutDuration) ....................................... 84
passwordMaxAge(PasswordMaximumAge) ........................................ 84
passwordMaxFailure(MaximumPasswordFailures) .................................. 85
passwordMinAge(PasswordMinimumAge)......................................... 85
passwordMinLength(PasswordMinimumLength) ................................... 85
passwordMustChange(PasswordMustChange)...................................... 86
passwordResetFailureCount(ResetPasswordFailureCountAfter) ...................... 86
passwordStorageScheme(PasswordStorageScheme).................................. 87
passwordUnlock(UnlockAccount) ................................................. 87
passwordWarning(SendWarning).................................................. 88
cn=changelog5 ...................................................................... 88
nsslapd-changelogdir ............................................................. 89
nsslapd-changelogmaxage(MaxChangelogAge) ..................................... 90
nsslapd-changelogmaxentries(MaxChangelogRecords)............................... 90
cn=encryption ...................................................................... 91
nssslsessiontimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
nssslclientauth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
nsssl2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ............. 92
nsssl3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ............. 92
nsssl3ciphers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
cn=features ......................................................................... 94
cn=mappingtree .................................................................... 94
Suffix Configuration Attributes Under cn="suffixName"................................... 95
nsslapd-state ..................................................................... 95
nsslapd-backend.................................................................. 95
Replication Attributes Under cn=replica, cn=“suffixName”,cn=mappingtree,cn=config....... 96
cn............................................................................... 96
nsDS5Flags ...................................................................... 96
nsDS5ReplicaBindDN ............................................................. 97
nsDS5ReplicaChangeCount ........................................................ 97
nsDS5ReplicaId................................................................... 98
nsDS5ReplicaLegacyConsumer ..................................................... 98
nsDS5ReplicaName ............................................................... 98

7
nsDS5ReplicaPurgeDelay .......................................................... 99
nsDS5ReplicaReferral ............................................................. 99
nsDS5ReplicaRoot ................................................................ 99
nsDS5ReplicaTombstonePurgeInterval ............................................. 100
nsDS5ReplicaType ............................................................... 100
nsState ......................................................................... 101
Replication Attributes Under cn=ReplicationAgreementName,cn=replica, cn="suffixName",
cn=mappingtree,cn=config .......................................................... 101
description...................................................................... 101
nsDS5ReplicaBindDN ............................................................ 101
nsDS5ReplicaBindMethod ........................................................ 102
nsDS5ReplicaChangesSentSinceStartup ............................................. 102
nsDS5ReplicaCredentials ......................................................... 103
nsDS5ReplicaHost ............................................................... 103
nsDS5ReplicaLastInitEnd ......................................................... 103
nsDS5ReplicaLastInitStart......................................................... 104
nsDS5ReplicaLastInitStatus ....................................................... 104
nsDS5ReplicaLastUpdateEnd...................................................... 105
nsDS5ReplicaLastUpdateStart ..................................................... 105
nsDS5ReplicaLastUpdateStatus.................................................... 105
nsDS5ReplicaPort................................................................ 106
nsDS5ReplicaReapActive ......................................................... 106
nsDS5ReplicaRefresh............................................................. 106
nsDS5ReplicaRoot ............................................................... 107
nsDS5ReplicaTimeout ............................................................ 107
nsDS5ReplicaTransportInfo ....................................................... 108
nsDS5ReplicaUpdateInProgress ................................................... 108
nsDS5ReplicaUpdateSchedule ..................................................... 108
nsDS50ruv ...................................................................... 109
cn=monitor ........................................................................ 109
connection ...................................................................... 109
currentConnections .............................................................. 109
totalConnections................................................................. 109
dTableSize ...................................................................... 109
readWaiters ..................................................................... 110
opsInitiated ..................................................................... 110
opsCompleted................................................................... 110
entriesSent ...................................................................... 110
bytesSent ....................................................................... 110
currentTime..................................................................... 110
startTime ....................................................................... 110
nbackEnds ...................................................................... 110
backendMonitorDN.............................................................. 110

8 Netscape Directory Server Configuration, Command, and File Reference • August 2002
cn=replication...................................................................... 111
cn=SNMP ......................................................................... 111
nssnmpenabled.................................................................. 111
nssnmporganization ............................................................. 111
nssnmplocation.................................................................. 112
nssnmpcontact .................................................................. 112
nssnmpdescription............................................................... 112
nssnmpmasterhost ............................................................... 113
nssnmpmasterport ............................................................... 113
cn=tasks........................................................................... 113
cn=uniqueidgenerator .............................................................. 113
nsstate.......................................................................... 114
ConfigurationQuickReferenceTables ................................................... 114
LDIFConfigurationFiles ............................................................ 114
ConfigurationChangesRequiringServerRestart ....................................... 117
Chapter 3 Plug-in Implemented Server Functionality Reference . . . . . . . . . . . . . . . . . . . . 119
Overview ............................................................................ 119
ObjectClassesforPlug-InConfiguration .............................................. 120
ServerPlug-inFunctionalityReference ................................................... 120
7-bitcheckPlug-in.................................................................. 121
ACLPlug-in ....................................................................... 121
ACLpreoperationPlug-in ........................................................... 122
BinarySyntaxPlug-in ............................................................... 122
BooleanSyntaxPlug-in.............................................................. 123
CaseExactStringSyntaxPlug-in ..................................................... 123
CaseIgnoreStringSyntaxPlug-in .................................................... 124
ChainingdatabasePlug-in........................................................... 124
ClassofServicePlug-in ............................................................. 125
CountryStringSyntaxPlug-in ....................................................... 125
DistinguishedNameSyntaxPlug-in .................................................. 126
GeneralizedTimeSyntaxPlug-in ..................................................... 126
HTTPClientPlug-in ................................................................ 127
IntegerSyntaxPlug-in .............................................................. 127
InternationalizationPlug-in.......................................................... 128
ldbmdatabasePlug-in .............................................................. 128
LegacyReplicationPlug-in .......................................................... 129
MultimasterReplicationPlug-in...................................................... 129
OctetStringSyntaxPlug-in .......................................................... 130
CLEARPasswordStoragePlug-in .................................................... 131
CRYPTPasswordStoragePlug-in .................................................... 131
NS-MTA-MD5PasswordStorageSchemePlug-in....................................... 132
SHAPasswordStorageSchemePlug-in ............................................... 132

9
SSHAPasswordStorageSchemePlug-in .............................................. 133
PostalAddressStringSyntaxPlug-in.................................................. 133
PresencePlug-in ................................................................... 134
PTAPlug-in ....................................................................... 134
ReferentialIntegrityPostoperationPlug-in............................................. 135
RetroChangelogPlug-in ............................................................ 136
RolesPlug-in ...................................................................... 137
SpaceInsensitiveStringSyntaxPlug-in................................................ 137
StateChangePlug-in................................................................ 138
TelephoneSyntaxPlug-in ........................................................... 139
UIDUniquenessPlug-in............................................................. 139
URISyntaxPlug-in ................................................................. 140
ListofAttributesCommontoAllPlug-ins................................................ 141
nsslapd-pluginPath ................................................................. 141
nsslapd-pluginInitfunc .............................................................. 141
nsslapd-pluginType ................................................................ 142
nsslapd-pluginEnabled.............................................................. 142
nsslapd-pluginId ................................................................... 143
nsslapd-pluginVersion .............................................................. 143
nsslapd-pluginVendor .............................................................. 143
nsslapd-pluginDescription........................................................... 144
AttributesAllowedbyCertainPlug-ins .................................................. 144
nsslapd-plugin-depends-on-type ..................................................... 144
nsslapd-plugin-depends-on-named ................................................... 145
DatabasePlug-inAttributes ............................................................ 145
Database Attributes Under cn=config,cn=ldbm database,cn=plugins,cn=config . . . . . . . . . . . . . 146
nsLookthroughLimit ............................................................. 146
nsslapd-allidsthreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
nsslapd-cache-autosize ........................................................... 147
nsslapd-cache-autosize-split....................................................... 147
nsslapd-dbcachesize.............................................................. 148
nsslapd-db-checkpoint-interval .................................................... 148
nsslapd-db-circular-logging ....................................................... 149
nsslapd-db-debug................................................................ 150
nsslapd-db-durable-transactions ................................................... 150
nsslapd-db-home-directory ....................................................... 151
nsslapd-db-idl-divisor ............................................................ 152
nsslapd-db-logbuf-size ........................................................... 153
nsslapd-db-logdirectory .......................................................... 153
nsslapd-db-logfile-size............................................................ 154
nsslapd-db-page-size............................................................. 154
nsslapd-db-spin-count............................................................ 155
nsslapd-db-transaction-batch-val .................................................. 155

10 Netscape Directory Server Configuration, Command, and File Reference • August 2002
nsslapd-db-transaction-logging .................................................... 156
nsslapd-db-trickle-percentage ..................................................... 156
nsslapd-db-verbose .............................................................. 157
nsslapd-dbncache................................................................ 157
nsslapd-import-cachesize ......................................................... 158
nsslapd-mode ................................................................... 158
Database Attributes Under cn=monitor,cn=ldbm database, cn=plugins,cn=config . . . . . . . . . . . 159
dbcachehits ..................................................................... 159
dbcachetries..................................................................... 159
dbcachehitratio .................................................................. 159
dbcachepagein .................................................................. 159
dbcachepageout ................................................................. 159
dbcacheroevict .................................................................. 159
dbcacherwevict.................................................................. 159
Database Attributes Under cn=NetscapeRoot,cn=ldbm database, cn=plugins,cn=config and
cn=UserRoot,cn=ldbmdatabase,cn=plugins,cn=config.................................. 160
nsslapd-cachesize ................................................................ 160
nsslapd-cachememsize ........................................................... 161
nsslapd-directory ................................................................ 161
nsslapd-readonly ................................................................ 161
nsslapd-require-index ............................................................ 162
nsslapd-suffix ................................................................... 162
Database Attributes Under cn=database,cn=monitor,cn=ldbm database, cn=plugins,cn=config 163
nsslapd-db-abort-rate ............................................................ 163
nsslapd-db-active-txns............................................................ 163
nsslapd-db-cache-hit ............................................................. 163
nsslapd-db-cache-try ............................................................. 163
nsslapd-db-cache-region-wait-rate ................................................. 163
nsslapd-db-cache-size-bytes ....................................................... 163
nsslapd-db-clean-pages........................................................... 163
nsslapd-db-commit-rate .......................................................... 163
nsslapd-db-deadlock-rate ......................................................... 164
nsslapd-db-dirty-pages ........................................................... 164
nsslapd-db-hash-buckets.......................................................... 164
nsslapd-db-hash-elements-examine-rate ............................................ 164
nsslapd-db-hash-search-rate....................................................... 164
nsslapd-db-lock-conflicts ......................................................... 164
nsslapd-db-lock-region-wait-rate .................................................. 164
nsslapd-db-lock-request-rate ...................................................... 164
nsslapd-db-lockers ............................................................... 164
nsslapd-db-log-bytes-since-checkpoint.............................................. 164
nsslapd-db-log-region-wait-rate ................................................... 164
nsslapd-db-log-write-rate ......................................................... 165

11
nsslapd-db-longest-chain-length ................................................... 165
nsslapd-db-page-create-rate ....................................................... 165
nsslapd-db-page-read-rate ........................................................ 165
nsslapd-db-page-ro-evict-rate ..................................................... 165
nsslapd-db-page-rw-evict-rate..................................................... 165
nsslapd-db-page-trickle-rate....................................................... 165
nsslapd-db-page-write-rate ....................................................... 165
nsslapd-db-pages-in-use .......................................................... 165
nsslapd-db-txn-region-wait-rate ................................................... 165
DatabaseAttributesUndercn=defaultindexes,cn=config,cn=ldbmdatabase,cn=plugins,cn=config
166
nsSystemIndex .................................................................. 166
nsIndexType .................................................................... 166
nsMatchingRule ................................................................. 167
cn.............................................................................. 167
description...................................................................... 168
Database Attributes Under cn=monitor,cn=Netscaperoot,cn=ldbm database,cn=plugins,cn=config
168
dbfilenamenumber............................................................... 168
dbfilecachehit ................................................................... 168
dbfilecachemiss.................................................................. 168
dbfilepagein..................................................................... 168
dbfilepageout ................................................................... 169
Database Attributes Under cn=index,cn=Netscaperoot,cn=ldbm database, cn=plugins,cn=config
andcn=index,cn=UserRoot,cn=ldbmdatabase,cn=plugins,cn=config ..................... 169
DatabaseLinkPlug-inAttributes(chainingattributes) ..................................... 170
Database Link Attributes Under cn=config,cn=chaining database, cn=plugins,cn=config . . . . . 171
nsActiveChainingComponents .................................................... 171
nsMaxResponseDelay ............................................................ 171
nsMaxTestResponseDelay ........................................................ 172
nsTransmittedControls ........................................................... 172
DatabaseLinkAttributesUndercn=defaultinstanceconfig,cn=chainingdatabase,cn=plugins,cn=config
173
nsAbandonedSearchCheckInterval................................................. 173
nsBindConnectionsLimit.......................................................... 173
nsBindRetryLimit................................................................ 174
nsBindTimeout .................................................................. 174
nsCheckLocalACI................................................................ 174
nsConcurrentBindLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
nsConcurrentOperationsLimit ..................................................... 175
nsConnectionLife ................................................................ 175
nsOperationConnectionsLimit ..................................................... 176
nsProxiedAuthorization .......................................................... 176

12 Netscape Directory Server Configuration, Command, and File Reference • August 2002
nsReferralOnScopedSearch........................................................ 177
nsSizeLimit ..................................................................... 177
nsTimeLimit .................................................................... 177
DatabaseLinkAttributesUndercn=databaselinkinstancename,cn=chainingdatabase,cn=plugins,cn=config
178
nsFarmServerURL ............................................................... 178
nsMultiplexorBindDN............................................................ 178
nsMultiplexorCredentials ......................................................... 179
nshoplimit ...................................................................... 179
DatabaseLinkAttributesUndercn=monitor,cn=databaseinstancename,cn=chainingdatabase,cn=plugins,cn=config
180
nsAddCount .................................................................... 180
nsDeleteCount .................................................................. 180
nsModifyCount.................................................................. 180
nsRenameCount ................................................................. 180
nsSearchBaseCount .............................................................. 180
nsSearchOneLevelCount.......................................................... 180
nsSearchSubtreeCount............................................................ 180
nsAbandonCount................................................................ 180
nsBindCount .................................................................... 180
nsUnbindCount ................................................................. 181
nsCompareCount ................................................................ 181
nsOperationConnectionCount ..................................................... 181
nsBindConnectionCount.......................................................... 181
RetroChangelogPlug-inAttributes...................................................... 181
nsslapd-changelogdir ............................................................ 181
nsslapd-changelogmaxage(MaxChangelogAge) .................................... 182
Chapter 4 ServerInstanceFileReference....................................... 183
OverviewofDirectoryServerFiles ...................................................... 183
BackupFiles.......................................................................... 185
ConfigurationFiles .................................................................... 185
DatabaseFiles ........................................................................ 185
ldifFiles ............................................................................. 186
LockFiles ............................................................................ 187
LogFiles ............................................................................. 187
Chapter 5 Access Log and Connection Code Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
AccessLogContent ................................................................... 189
AccessLoggingLevels .............................................................. 190
DefaultAccessLoggingContent...................................................... 191
ConnectionNumber.............................................................. 192

13
FileDescriptor................................................................... 192
SlotNumber .................................................................... 192
OperationNumber............................................................... 193
MethodType.................................................................... 193
VersionNumber................................................................. 193
ErrorNumber ................................................................... 193
TagNumber .................................................................... 193
NumberofEntries ............................................................... 194
ElapsedTime.................................................................... 194
LDAPRequestType.............................................................. 194
LDAPResponseType ............................................................ 195
UnindexedSearchIndicator ....................................................... 195
VLV-RelatedEntries ............................................................. 195
SearchScope .................................................................... 196
ExtendedOperationOID ......................................................... 196
ChangeSequenceNumber ........................................................ 197
AbandonMessage ............................................................... 197
MessageID ..................................................................... 198
SASLMulti-StageBindLogging ................................................... 198
AccessLogContentforAdditionalAccessLoggingLevels ............................... 199
ConnectionDescription........................................................... 200
OptionsDescription.............................................................. 200
CommonConnectionCodes ............................................................ 201
LDAPResultCodes ................................................................... 202
Chapter 6 Migration from Earlier Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Migrationfrom4.xDirectoryServerto6.x ................................................ 205
ServerAttributes ................................................................... 206
DatabaseAttributes................................................................. 209
UpgradefromDirectoryServer5.xto6.x ................................................. 210
GeneralServerConfigurationAttributes............................................... 210
DatabaseAttributes................................................................. 214
DatabaseLinkAttributes ............................................................ 215
SNMPAttributes ................................................................... 216
Chapter 7 Command-LineUtilities..............................................217
Finding and Executing Command-Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Command-Line Utilities Quick Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
UsingSpecialCharacters ............................................................... 219
SyntaxforUsingSpecialCharacters................................................... 219
ldapsearch ........................................................................... 220
ldapsearchOptions ................................................................. 220

14 Netscape Directory Server Configuration, Command, and File Reference • August 2002
CommonlyUsedldapsearchOptions ............................................... 220
SSLOptions..................................................................... 222
AdditionalldapsearchOptions .................................................... 223
ldapmodify........................................................................... 225
Syntax ............................................................................ 225
ldapmodifyOptions ................................................................ 226
CommonlyUsedldapmodifyOptions .............................................. 226
SSLOptions..................................................................... 227
AdditionalldapmodifyOptions ................................................... 228
ldapdelete............................................................................ 230
Syntax ............................................................................ 230
ldapdeleteOptions ................................................................. 230
CommonlyUsedldapdeleteOptions ............................................... 230
SSLOptions..................................................................... 231
AdditionalldapdeleteOptions..................................................... 232
ldif .................................................................................. 233
Syntax ............................................................................ 233
Options ........................................................................... 234
dbscan............................................................................... 234
Syntax ............................................................................ 234
Options ........................................................................... 234
Chapter 8 Command-LineScripts ............................................. 237
FindingandExecutingCommand-LineScripts............................................ 237
Command-LineScriptsQuickReference ................................................. 238
ShellandBatchScripts................................................................. 241
bak2db(Restoredatabasefrombackup) ............................................... 242
Syntax.......................................................................... 242
db2bak(Createbackupofdatabase)................................................... 242
Syntax.......................................................................... 242
db2ldif(ExportdatabasecontentstoLDIF)............................................. 243
Syntax.......................................................................... 243
Options......................................................................... 243
db2dsml(ExportdatabasecontentstoDSML) .......................................... 244
Syntax.......................................................................... 244
Options......................................................................... 244
db2index(Reindexdatabaseindexfiles) ............................................... 245
Syntax.......................................................................... 245
Usage .......................................................................... 245
Options......................................................................... 245
dsml2db(ImportDSMLdocumentcontentsintodatabase)............................... 246
Syntax.......................................................................... 246
Options......................................................................... 246

15
getpwenc(Printencryptedpassword)................................................. 246
Syntax.......................................................................... 246
Options......................................................................... 247
ldif2db(Import) .................................................................... 247
Syntax.......................................................................... 247
Options......................................................................... 248
ldif2ldap(PerformimportoperationoverLDAP) ....................................... 249
Syntax.......................................................................... 249
Options......................................................................... 249
monitor(Retrievemonitoringinformation) ............................................ 249
Syntax.......................................................................... 249
Options......................................................................... 249
restart-slapd(RestarttheDirectoryServer)............................................. 250
Syntax.......................................................................... 250
Options......................................................................... 250
ExitStatus ...................................................................... 250
restoreconfig(RestoreAdministrationServerConfiguration) ............................. 250
Syntax.......................................................................... 251
Options......................................................................... 251
saveconfig(SaveAdministrationServerConfiguration).................................. 251
Syntax.......................................................................... 251
Options......................................................................... 251
start-slapd(StarttheDirectoryServer) ................................................ 251
Syntax.......................................................................... 252
Options......................................................................... 252
ExitStatus ...................................................................... 252
stop-slapd(StoptheDirectoryServer)................................................. 252
Syntax.......................................................................... 252
Options......................................................................... 252
ExitStatus ...................................................................... 252
suffix2instance(MapSuffixtoBackendName) ......................................... 253
Syntax.......................................................................... 253
Options......................................................................... 253
vlvindex(Createvirtuallistviewindexes) ............................................. 253
Syntax.......................................................................... 253
Options......................................................................... 254
PerlScripts ........................................................................... 254
bak2db.pl(Restoredatabasefrombackup) ............................................. 255
Syntax.......................................................................... 255
Options......................................................................... 255
db2bak.pl(Createbackupofdatabase) ................................................ 255
Syntax.......................................................................... 256
Options......................................................................... 256

16 Netscape Directory Server Configuration, Command, and File Reference • August 2002
db2index.pl(Createandgenerateindexes) ............................................. 256
Syntax.......................................................................... 256
Options......................................................................... 257
db2ldif.pl(ExportdatabasecontentstoLDIF) .......................................... 257
Syntax.......................................................................... 257
Options......................................................................... 257
ldif2db.pl(Import).................................................................. 258
Syntax.......................................................................... 259
Options......................................................................... 259
logconv.pl(Logconverter)........................................................... 260
Syntax.......................................................................... 262
Options......................................................................... 263
migrateInstance6(MigratetoDirectoryServer6.x) ...................................... 265
Syntax.......................................................................... 265
Options......................................................................... 265
ns-accountstatus.pl(Establishaccountstatus) .......................................... 266
Syntax.......................................................................... 266
Options......................................................................... 266
ns-activate.pl(Activateanentryorgroupofentries) .................................... 267
Syntax.......................................................................... 267
Options......................................................................... 267
ns-inactivate.pl(Inactivateanentryorgroupofentries) ................................. 267
Syntax.......................................................................... 268
Options......................................................................... 268
template-cl-dump.pl(Dumpanddecodechangelog) .................................... 268
Syntax.......................................................................... 268
Options......................................................................... 269
template-repl-monitor.pl(Monitorreplicationstatus) ................................... 269
Syntax.......................................................................... 270
Options......................................................................... 270
ConfigurationFileFormat......................................................... 271
Appendix A Using the ns-slapd and slapd.exe Command-Line Utilities . . . . . . . . . . . . . . 273
Overviewofns-slapdandslapd.exeCommands .......................................... 273
ns-slapd(UNIX).................................................................... 274
slapd.exe(Windows)................................................................ 274
FindingandExecutingthens-slapdandslapd.exeCommand-LineUtilities................... 274
ns-slapd and slapd.exe Command-Line Utilities for Exporting Databases . . . . . . . . . . . . . . . . . . . . . 275
db2ldif ............................................................................ 275
Syntax.......................................................................... 275
Options......................................................................... 275
ns-slapd and slapd.exe Command-Line Utilities for Restoring and Backing up Databases . . . . . . . 277
ldif2db ............................................................................ 277

17
Syntax.......................................................................... 277
Options......................................................................... 277
archive2db ........................................................................ 279
Syntax.......................................................................... 279
Options......................................................................... 280
db2archive ........................................................................ 280
Syntax.......................................................................... 280
Options......................................................................... 280
ns-slapd and slapd.exe Command-Line Utilities for Creating and Regenerating Indexes . . . . . . . . 281
db2index .......................................................................... 281
Syntax.......................................................................... 281
Options......................................................................... 281
Glossary.....................................................................283
Index........................................................................299

18 Netscape Directory Server Configuration, Command, and File Reference • August 2002

19
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 19)
• Prerequisite Reading (page 20)
• What Is In This Reference Guide? (page 20)
• Conventions Used In This Reference Guide (page 21)
• Related Information (page 21)
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
20 Netscape Directory Server Configuration, Command, and File Reference • August 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.