1SLAPINDEX(8C)                                                    SLAPINDEX(8C)
2
3
4

NAME

6       slapindex - Reindex entries in a SLAPD database
7

SYNOPSIS

9       /usr/sbin/slapindex  [-b suffix]  [-c] [-d debug-level] [-f slapd.conf]
10       [-F confdir]  [-g]  [-n dbnum]  [-o option[=value]]  [-q]   [-t]   [-v]
11       [attr[...]]
12

DESCRIPTION

14       Slapindex is used to regenerate slapd(8) indices based upon the current
15       contents of a database.  It opens the given database determined by  the
16       database number or suffix and updates the indices for all values of all
17       attributes of all entries. If a list of specific attributes is provided
18       on  the  command  line,  only  the indices for those attributes will be
19       regenerated.  Databases configured as subordinate of this one are  also
20       re-indexed, unless -g is specified.
21
22       All  files  eventually created by slapindex will belong to the identity
23       slapindex is run as, so make sure you either  run  slapindex  with  the
24       same  identity  slapd(8) will be run as (see option -u in slapd(8)), or
25       change file ownership before running slapd(8).
26

OPTIONS

28       -b suffix
29              Use the specified suffix to determine which database to generate
30              output  for.   The  -b cannot be used in conjunction with the -n
31              option.
32
33       -c     enable continue (ignore errors) mode.
34
35       -d debug-level
36              enable debugging messages as defined  by  the  specified  debug-
37              level; see slapd(8) for details.
38
39       -f slapd.conf
40              specify an alternative slapd.conf(5) file.
41
42       -F confdir
43              specify  a  config  directory.  If both -f and -F are specified,
44              the config file will be read and converted to  config  directory
45              format  and  written  to  the  specified  directory.  If neither
46              option is specified, an  attempt  to  read  the  default  config
47              directory  will  be made before trying to use the default config
48              file. If a valid config directory exists then the default config
49              file is ignored.
50
51       -g     disable subordinate gluing.  Only the specified database will be
52              processed, and not its glued subordinates (if any).
53
54       -n dbnum
55              Generate output for the dbnum-th database listed in the configu‐
56              ration  file. The config database slapd-config(5), is always the
57              first database, so use -n 0
58
59              The -n cannot be used in conjunction with the -b option.
60
61       -o option[=value]
62              Specify an option with a(n optional)  value.   Possible  generic
63              options/values are:
64
65                     syslog=<subsystems>  (see `-s' in slapd(8))
66                     syslog-level=<level> (see `-S' in slapd(8))
67                     syslog-user=<user>   (see `-l' in slapd(8))
68
69
70       -q     enable  quick (fewer integrity checks) mode. Performs no consis‐
71              tency checks when writing the database. Improves indexing  time,
72              however  the database will most likely be unusable if any errors
73              or interruptions occur.
74
75       -t     enable truncate mode.  Truncates  (empties)  an  index  database
76              before  indexing any entries. For back-bdb/hdb, may only be used
77              with quick mode. For back-mdb it  is  usable  with  and  without
78              quick mode.
79
80       -v     enable verbose mode.
81

LIMITATIONS

83       Your  slapd(8) should not be running (at least, not in read-write mode)
84       when you do this to ensure consistency of the database.
85
86       This command provides ample opportunity for  the  user  to  obtain  and
87       drink their favorite beverage.
88

EXAMPLES

90       To reindex your SLAPD database, give the command:
91
92            /usr/sbin/slapindex
93       To regenerate the index for only a specific attribute, e.g. "uid", give
94       the command:
95
96            /usr/sbin/slapindex uid
97

SEE ALSO

99       ldap(3), ldif(5), slapadd(8), ldapadd(1), slapd(8)
100
101       "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
102

ACKNOWLEDGEMENTS

104       OpenLDAP Software is developed and maintained by The  OpenLDAP  Project
105       <http://www.openldap.org/>.  OpenLDAP Software is derived from the Uni‐
106       versity of Michigan LDAP 3.3 Release.
107
108
109
110OpenLDAP 2.4.50                   2020/04/28                     SLAPINDEX(8C)
Impressum