User manual REDHAT NETSCAPE DIRECTORY SERVER 6.0 CONFIGURATION

[. . . ] Configuration, Command, and File Reference Netscape Directory Server Version 6. 0 December 2001 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. [. . . ] All of the values for these attributes are 32-bit integers. nsslapd-db-abort-rate Number of transactions that have been aborted. nsslapd-db-active-txns Number of transactions that are currently active. nsslapd-db-cache-hit Requested pages found in the cache. nsslapd-db-cache-try Total cache lookups. nsslapd-db-cache-region-wait-rate Number of times that a thread of control was forced to wait before obtaining the region lock. nsslapd-db-cache-size-bytes Total cache size in bytes. nsslapd-db-clean-pages Clean pages currently in the cache. Chapter 3 Plug-in Implemented Server Functionality Reference 149 Database Plug-in Attributes nsslapd-db-commit-rate Number of transactions that have been committed. nsslapd-db-deadlock-rate Number of deadlocks detected. nsslapd-db-dirty-pages Dirty pages currently in the cache. nsslapd-db-hash-buckets Number of hash buckets in buffer hash table. nsslapd-db-hash-elements-examine-rate Total number of hash elements traversed during hash table lookups. nsslapd-db-hash-search-rate Total number of buffer hash table lookups. nsslapd-db-lock-conflicts Total number of locks not immediately available due to conflicts. nsslapd-db-lock-region-wait-rate Number of times that a thread of control was forced to wait before obtaining the region lock. nsslapd-db-lock-request-rate Total number of locks requested. nsslapd-db-lockers Number of current lockers. nsslapd-db-log-bytes-since-checkpoint Number of bytes written to this log since the last checkpoint. 150 Netscape Directory Server Configuration, Command, and File Reference · December 2001 Database Plug-in Attributes nsslapd-db-log-region-wait-rate Number of times that a thread of control was forced to wait before obtaining the region lock. nsslapd-db-log-write-rate Number of megabytes and bytes written to this log. nsslapd-db-longest-chain-length Longest chain ever encountered in buffer hash table lookups. nsslapd-db-page-create-rate Pages created in the cache. nsslapd-db-page-read-rate Pages read into the cache. nsslapd-db-page-ro-evict-rate Clean pages forced from the cache. nsslapd-db-page-rw-evict-rate Dirty pages forced from the cache. nsslapd-db-page-trickle-rate Dirty pages written using the memp_trickle interface. nsslapd-db-page-write-rate Pages read into the cache. nsslapd-db-pages-in-use All pages, clean or dirty, currently in use. nsslapd-db-txn-region-wait-rate Number of times that a thread of control was force to wait before obtaining the region lock. Chapter 3 Plug-in Implemented Server Functionality Reference 151 Database Plug-in Attributes Database Attributes Under cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config The set of default indexes is stored here. Default indexes are configured per backend in order to optimize Directory Server functionality for the majority of set up scenarios. All indexes, except system essential ones, can be removed, but care should be taken so as not to cause unnecessary disruptions. This section presents four required indexing attributes and one optional indexing attribute. For further information on indexes see Chapter 10, "Managing Indexes" in the Netscape Directory Server Administrator's Guide. nsSystemIndex This mandatory attribute specifies whether or not the index is a system index, that is, an index which is vital for Directory Server 6. 0 operations. If this attribute has a value of true then it is system essential. System indexes should not be removed as this will seriously disrupt server functionality. Entry DN cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config true | false N/A DirectoryString nssystemindex: true Valid Range Default Value Syntax Example nsIndexType This optional multi valued, attribute specifies the type of index for Directory Server 6. 0 operations and takes the values of the attributes to be indexed. Each desired index type has to be entered on a separate line. Entry DN cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config 152 Netscape Directory Server Configuration, Command, and File Reference · December 2001 Database Plug-in Attributes Valid Range pres = presence index eq = equality index approx = approximate index sub = substring index matching rule = international index index browse = browsing index Default Value Syntax Example N/A DirectoryString nsindextype: eq nsMatchingRule This optional, multivalued attribute specifies the collation order object identifier (OID) required for the Directory Server to operate international indexing. Entry DN cn=default indexes, cn=monitor, cn=ldbm database, cn=plugins, cn=config Any valid collation order object identifier (OID) None DirectoryString cn: 2. 16. 840. 1. 113730. 3. 3. 2. 3. 1 (For Bulgarian) Valid Range Default Value Syntax Example cn Provides the name of the attribute you want to index Entry DN cn=default indexes, cn=monitor, cn=ldbm database, cn=plugins, cn=config Any valid index cn None DirectoryString cn: aci Valid Range Default Value Syntax Example Chapter 3 Plug-in Implemented Server Functionality Reference 153 Database Plug-in Attributes description This non-mandatory attribute provides a free-hand text description of what the index actually performs. Entry DN cn=default indexes, cn=monitor, cn=ldbm database, cn=plugins, cn=config N/A None DirectoryString description:substring index Valid Range Default Value Syntax Example Database Attributes Under cn=monitor, cn=Netscaperoot, cn=ldbm database, cn=plugins, cn=config Global, read-only entries for monitoring activity on the NetscapeRoot database. These attributes containing database statistics are given for each file that makes up your database. For further information see Chapter 12, "Monitoring Server and Database Activity" in the Netscape Directory Server Administrator's Guide. dbfilenamenumber This attribute indicates the name of the file and provides a sequential integer identifier (starting at 0) for the file. All associated statistics for the file are given this same numerical identifier. dbfilecachehit Number of times that a search requiring data from this file was performed and that the data was successfully obtained from the cache. dbfilecachemiss Number of times that a search requiring data from this file was performed and that the data could not be obtained from the cache. dbfilepagein Number of pages brought to the cache from this file. 154 Netscape Directory Server Configuration, Command, and File Reference · December 2001 Database Plug-in Attributes dbfilepageout Number of pages for this file written from cache to disk. Database Attributes Under cn=index, cn=Netscaperoot, cn=ldbm database, cn=plugins, cn=config and cn=index, cn=UserRoot, cn=ldbm database, cn=plugins, cn=config In addition to the set of default indexes that are stored under cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config, custom indexes can be created for o=Netscaperoot and o=UserRoot and are stored under the cn=index, cn=NetscapeRoot, cn=ldbm database, cn=plugins, cn=config, and cn=index, cn=UserRoot, cn=ldbm database, cn=plugins, cn=config, respectively. Each indexed attribute represents a subentry entry under the above cn=config information tree nodes, as shown in Figure 3-2. Figure 3-2 Indexed Attribute Representing a Subentry For example, the index file for the aci attribute under o=UserRoot will appear in the Directory Server as follows: Chapter 3 Plug-in Implemented Server Functionality Reference 155 Database Link Plug-in Attributes (chaining attributes) dn:cn=aci, cn=index, cn=UserRoot, cn=ldbm database, cn=plugins, cn=confi objectclass:top objectclass:nsIndex cn=aci nssystemindex:true nsindextype:pres For details regarding the five possible indexing attributes see the section "Database Attributes Under cn=default indexes, cn=config, cn=ldbm database, cn=plugins, cn=config, " on page 152. For further information about indexes see Chapter 10, "Managing Indexes" in the Netscape Directory Server Administrator's Guide. Database Link Plug-in Attributes (chaining attributes) The database link plug-in is also organized in an information tree as shown in Figure 3-3. Figure 3-3 Database Link Plug-In All plug-in technology used by the database link instances is stored in the cn=chaining database plug-in node. This section presents the additional attribute information for the three nodes marked in bold in the cn=chaining database, cn=plugins, cn=config information tree. 156 Netscape Directory Server Configuration, Command, and File Reference · December 2001 Database Link Plug-in Attributes (chaining attributes) Database Link Attributes Under cn=config, cn=chaining database, cn=plugins, cn=config Global configuration attributes common to all instances are stored in the cn=config, cn=chaining database, cn=plugins, cn=config tree node. nsActiveChainingComponents Lists the components using chaining. A component is any functional unit in the server. The value of this attribute overrides the value in the global configuration attribute. To disable chaining on a particular database instance, use the value None. This attribute also allows you to alter the components used to chain. By default no components are allowed to chain, which explains why this attribute will probably not appear in a list of cn=config, cn=chaining database, cn=config attributes, as LDAP considers empty attributes to be non-existent. Entry DN Valid Range Default Value Syntax Example cn=config, cn=chaining database, cn=plugins, cn=config Any valid component entry None DirectoryString nsActiveChainingComponents: cn=uid uniqueness, cn=plugins, cn=config nsMaxResponseDelay This error detection, performance related attribute specifies the maximum amount of time it can take a remote server to respond to an LDAP operation request made by a database link before an error is suspected. Once this delay period has been met, the database link tests the connection with the remote server. Entry DN Valid Range Default Value Syntax Example cn=config, cn=chaining database, cn=plugins, cn=config Any valid dealay period in seconds 60 seconds Integer nsMaxResponseDelay: 60 Chapter 3 Plug-in Implemented Server Functionality Reference 157 Database Link Plug-in Attributes (chaining attributes) nsMaxTestResponseDelay This error detection, performance related attribute specifies the duration of the test issued by the database link to check whether the remote server is responding. If a response from the remote server is not returned before this period has passed, the database link assumes the remote server is down and the connection is not used for subsequent operations. Entry DN Valid Range Default Value Syntax Example cn=config, cn=chaining database, cn=plugins, cn=config Any valid dealay period in seconds 15 seconds Integer nsMaxTestResponseDelay: 15 nsTransmittedControls This attribute, which can be both a global (and thus dynamic) configuration or an instance (i. e. cn=database link instance, cn=chaining database, cn=plugins, cn=config) configuration attribute, allows you to alter the controls the database link forwards. The following controls are forwarded by default by the database link: · · · Managed DSA, object identifier: 2. 16. 840. 1. 113730. 3. 4. 2. [. . . ] standard index sub suffix subagent Indexes that are maintained by default. A branch underneath a root suffix. See SNMP subagent. substring index Allows for efficient searching against substrings within entries. Substring indexes are limited to a minimum of two characters for each entry. suffix The name of the entry at the top of the directory tree, below which data is stored. [. . . ]