git.sur5r.net Git - openldap/blob - doc/man/man8/slapcat.8

   1 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slapcat \- SLAPD database to LDIF utility
   7 .SH SYNOPSIS
   8 .B SBINDIR/slapcat
   9 .B [\-a filter]
  10 .B [\-b suffix]
  11 .B [\-c]
  12 .B [\-d level]
  13 .B [\-f slapd.conf]
  14 .B [\-F confdir]
  15 .B [\-g]
  16 .B [\-l ldif-file]
  17 .B [\-n dbnum]
  18 .B [\-o name[=value]
  19 .B [\-s subtree-dn]
  20 .B [\-v]
  21 .B
  22 .LP
  23 .SH DESCRIPTION
  24 .LP
  25 .B Slapcat
  26 is used to generate an LDAP Directory Interchange Format
  27 (LDIF) output based upon the contents of a
  28 .BR slapd (8)
  29 database.
  30 It opens the given database determined by the database number or
  31 suffix and writes the corresponding LDIF to standard output or
  32 the specified file.
  33 Databases configured as
  34 .B subordinate
  35 of this one are also output, unless \fB-g\fP is specified.
  36 .LP
  37 The entry records are presented in database order, not superior first
  38 order.  The entry records will include all (user and operational)
  39 attributes stored in the database.  The entry records will not include
  40 dynamically generated attributes (such as subschemaSubentry).
  41 .LP
  42 The output of slapcat is intended to be used as input to
  43 .BR slapadd (8).
  44 The output of slapcat cannot generally be used as input to
  45 .BR ldapadd (1)
  46 or other LDAP clients without first editing the output.
  47 This editing would normally include reordering the records
  48 into superior first order and removing no-user-modification
  49 operational attributes.
  50 .SH OPTIONS
  51 .TP
  52 .BI \-a " filter"
  53 Only dump entries matching the asserted filter.
  54 For example
  55
  56 slapcat -a \\
  57     "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
  58
  59 will dump all but the "ou=People,dc=example,dc=com" subtree
  60 of the "dc=example,dc=com" database.
  61 .TP
  62 .BI \-b " suffix"
  63 Use the specified \fIsuffix\fR to determine which database to
  64 generate output for.  The \-b cannot be used in conjunction
  65 with the
  66 .B \-n
  67 option.
  68 .TP
  69 .B \-c
  70 Enable continue (ignore errors) mode.
  71 .TP
  72 .BI \-d " level"
  73 Enable debugging messages as defined by the specified
  74 .IR level .
  75 .TP
  76 .BI \-f " slapd.conf"
  77 Specify an alternative
  78 .BR slapd.conf (5)
  79 file.
  80 .TP
  81 .BI \-F " confdir"
  82 specify a config directory.
  83 If both
  84 .B -f
  85 and
  86 .B -F
  87 are specified, the config file will be read and converted to
  88 config directory format and written to the specified directory.
  89 If neither option is specified, an attempt to read the
  90 default config directory will be made before trying to use the default
  91 config file. If a valid config directory exists then the
  92 default config file is ignored.
  93 .TP
  94 .B \-g
  95 disable subordinate gluing.  Only the specified database will be
  96 processed, and not its glued subordinates (if any).
  97 .TP
  98 .BI \-l " ldif-file"
  99 Write LDIF to specified file instead of standard output.
 100 .TP
 101 .BI \-n " dbnum"
 102 Generate output for the \fIdbnum\fR\-th database listed in the
 103 configuration file.  The
 104 .B \-n
 105 cannot be used in conjunction with the
 106 .B \-b
 107 option.
 108 .TP
 109 .BI \-o " option[=value]"
 110 Specify an
 111 .BR option
 112 with a(n optional)
 113 .BR value .
 114 Possible generic options/values are:
 115 .LP
 116 .nf
 117               syslog=<subsystems>  (see `\-s' in slapd(8))
 118               syslog-level=<level> (see `\-S' in slapd(8))
 119               syslog-user=<user>   (see `\-l' in slapd(8))
 120
 121 .fi
 122 .TP
 123 .BI \-s " subtree-dn"
 124 Only dump entries in the subtree specified by this DN.
 125 Implies `-b subtree-dn' if no
 126 .B \-b
 127 or
 128 .B \-n
 129 option is given.
 130 .TP
 131 .B \-v
 132 Enable verbose mode.
 133 .SH LIMITATIONS
 134 In general, your
 135 .BR slapd (8)
 136 should not be running (at least, not in read-write
 137 mode) when you do this to ensure consistency of the database.
 138 .SH EXAMPLES
 139 To make a text backup of your SLAPD database and put it in a file called
 140 .BR ldif ,
 141 give the command:
 142 .LP
 143 .nf
 144 .ft tt
 145         SBINDIR/slapcat -l ldif
 146 .ft
 147 .fi
 148 .SH "SEE ALSO"
 149 .BR ldap (3),
 150 .BR ldif (5),
 151 .BR slapadd (8),
 152 .BR ldapadd (1),
 153 .BR slapd (8)
 154 .LP
 155 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 156 .SH ACKNOWLEDGEMENTS
 157 .B OpenLDAP
 158 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 159 .B OpenLDAP
 160 is derived from University of Michigan LDAP 3.3 Release.