slapcat.8 2.69 KB
Newer Older
1
.TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" $OpenLDAP$
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
4
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
5
6
7
8
9
.SH NAME
slapcat \- SLAPD database to LDIF utility
.SH SYNOPSIS
.B SBINDIR/slapcat
.B [\-v]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
10
.B [\-c]
11
12
13
.B [\-d level]
.B [\-b suffix]
.B [\-n dbnum]
14
.B [\-a filter]
15
.B [\-s subtree-dn]
16
17
18
19
20
21
22
23
24
25
26
27
.B [\-f slapd.conf]
.B [\-l ldif-file]
.B 
.LP
.SH DESCRIPTION
.LP
.B Slapcat
is used to generate an LDAP Directory Interchange Format
(LDIF) output based upon the contents of a
.BR slapd (8)
database.
It opens the given database determined by the database number or
28
suffix and writes the corresponding LDIF to standard output or
29
the specified file.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
30
31
32
Databases configured as
.B subordinate
of this one are also output.
33
34
35
.LP
The LDIF generated by this tool is suitable for use with
.BR slapadd (8).
36
37
As the entries are in database order, not superior first order,
they cannot be loaded with
Hallvard Furuseth's avatar
Hallvard Furuseth committed
38
39
.BR ldapadd (1)
without first being reordered.
40
41
42
.SH OPTIONS
.TP
.B \-v
43
Enable verbose mode.
44
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
45
.B \-c
46
47
Enable continue (ignore errors) mode.
.TP
48
.BI \-d " level"
49
Enable debugging messages as defined by the specified
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.IR level .
.TP
.BI \-b " suffix" 
Use the specified \fIsuffix\fR to determine which database to
generate output for.  The \-b cannot be used in conjunction
with the
.B \-n
option.
.TP
.BI \-n " dbnum"
Generate output for the \fIdbnum\fR\-th database listed in the
configuration file.  The
.B \-n
cannot be used in conjunction with the
.B \-b
option.
.TP
67
.BI \-a " filter"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
68
69
70
71
72
73
74
75
Only dump entries matching the asserted filter.
For example

slapcat -a \\
    "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"

will dump all but the "ou=People,dc=example,dc=com" subtree
of the "dc=example,dc=com" database.
76
.TP
77
78
79
80
81
82
83
84
.BI \-s " subtree-dn"
Only dump entries in the subtree specified by this DN.
Implies `-b subtree-dn' if no
.B \-b
or
.B \-n
option is given.
.TP
85
.BI \-f " slapd.conf"
86
Specify an alternative
87
88
89
90
91
.BR slapd.conf (5)
file.
.TP
.BI \-l " ldif-file"
Write LDIF to specified file instead of standard output.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
92
93
.SH LIMITATIONS
In general, your
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
.BR slapd (8)
should not be running (at least, not in read-write
mode) when you do this to ensure consistency of the database.
.SH EXAMPLES
To make a text backup of your SLAPD database and put it in a file called
.BR ldif ,
give the command:
.LP
.nf
.ft tt
	SBINDIR/slapcat -l ldif
.ft
.fi
.SH "SEE ALSO"
.BR ldap (3),
.BR ldif (5),
.BR slapadd (8),
.BR ldapadd (1),
.BR slapd (8)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
113
.LP
114
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
115
.SH ACKNOWLEDGEMENTS
116
.B OpenLDAP
117
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
118
.B OpenLDAP
119
is derived from University of Michigan LDAP 3.3 Release.