db2index(8)

db2index8

Directory server script for indexing attributes

Usage

db2index [-Z serverID] [{-n backend | -s includeSuffix * -t attribute [:indextypes [:matchingrules]] -T vlvTag}] [-v] [-h]

Overview

Reindexes the database index files. The Directory Server must be stopped prior to running this script.

Options

A summary of options is included below:

-Z Server Identifier

The server ID of the Directory Server instance. If there is only one instance on the system, this option can be skipped.

-n Backend Name

The name of the LDBM database to reindex. Example: userRoot

-s includeSuffix

Specifies suffixes to be included or the subtrees to be included

-t attributeName[:indextypes[:matchingrules]]

The attribute to index. Optionally you can specify a comma separated list of index types: eq, sub, pres, and approx. An optional matching rule OID can also be set.

-T vlvTag

This is the name of the vlv index entry under cn=config.

-v

Display version

-h

Display the usage.

Examples

db2index -n userRoot -t uid:eq,sub:1.3.6.1.4.1.42.2.27.9.4.76.1 -t cn:eq,pres
db2index -Z instance2 -s 'dc=example,dc=com' -t uid:eq:pres:sub -t sn
db2index -Z instance3

Diagnostics

Exit status is zero if no errors occur. Errors result in a non-zero exit status and a diagnostic message being written to standard error.

Releases

3 releases since Debian 8 (Jessie); the text changed 2 times.

  1. 8
  2. 9
  3. 10

-v since Debian 10 (Buster).

Author

db2index was written by the 389 Project.

Reporting bugs

Report bugs to https://pagure.io/389-ds-base/new_issue

From 389-ds-base-legacy-tools 1.4.0.21-1 in Debian 10 (Buster). Parsed by carta from the page's man source.