1DB2INDEX.PL(8) System Manager's Manual DB2INDEX.PL(8)
2
3
4
6 db2index.pl - Directory Server perl script for indexing a database
7
9 db2index.pl [-Z serverID] [-D rootdn] { -w password | -w - | -j file‐
10 name } [-n backendname] [-P protocol] [-t attributeName[:index‐
11 types[:matchingrules]]] [-T vlvTag] [-h]
12
14 Indexes attributes in the specified database. If no attributes are
15 specified, then all the attribute indexes will be regenerated. The
16 Directory Server must be started prior to running this script.
17
19 A summary of options is included below:
20
21 -Z Server Identifier
22 The server ID of the Directory Server instance. If there is
23 only one instance on the system, this option can be skipped.
24
25 -D Root DN
26 The Directory Manager DN, or root DN. If not specified, the
27 script will search the server instance configuration for the
28 value.
29
30 -w password
31 The rootdn password.
32
33 -w -
34 Prompt for the rootdn password.
35
36 -j password filename
37 The name of the file that contains the root DN password.
38
39 -n Backend Name
40 The name of the LDBM database to restore. Example: userRoot
41
42 -t attributeName[:indextypes[:matchingrules]]
43 The attribute to index. Optionally you can specify a comma sep‐
44 arated list of index types: eq, sub, pres, and approx. An
45 optional matching rule OID can also be set.
46
47 -T vlvTag
48 This is the name of the vlv index entry under cn=config.
49
50 -P Protocol
51 The connection protocol to connect to the Directory Server.
52 Protocols are STARTTLS, LDAPS, LDAPI, and LDAP. If this option
53 is skipped, the most secure protocol that is available is used.
54 For LDAPI, AUTOBIND is also available for the root user.
55
56 -h
57 Display usage
58
60 db2index.pl -n userRoot -D 'cn=directory manager' -w password -t
61 uid:eq,pres,sub:1.3.6.1.4.1.42.2.27.9.4.76.1 -t cn:eq,pres
62
63 db2index.pl -Z instance3
64
65 db2index.pl -Z instance2 -w password -s 'dc=example,dc=com' -t
66 uid:eq:pres:sub -t sn -P STARTTLS
67
68 Note: security must be enabled to use protocol STARTTLS. If
69 STARTTLS is not available it will default to next strong‐
70 est/available protocol automatically.
71
73 Exit status is zero if no errors occur. Errors result in a non-zero
74 exit status and a diagnostic message being written to standard error.
75
77 db2index.pl was written by the 389 Project.
78
80 Report bugs to https://pagure.io/389-ds-base/new_issue
81
83 Copyright © 2017 Red Hat, Inc.
84
85
86
87 March 31, 2017 DB2INDEX.PL(8)