# slapcat

## NAME



           slapcat - SLAPD database to LDIF utility
    


## SYNOPSIS



           **SBINDIR/slapcat**[**-a** _filter_] [**-b** _suffix_] [**-c**] [**-d** _debug-level_]
           [**-f** _slapd.conf_] [**-F** _confdir_] [**-g**] [**-H** _URI_] [**-l** _ldif-file_] [**-n** _dbnum_]
           [**-o** _option_[**=**_value_]] [**-s** _subtree-dn_] [**-v**]
    


## DESCRIPTION



           **Slapcat** is used to generate an LDAP Directory Interchange Format
           (LDIF) output based upon the contents of a slapd(8) database.  It
           opens the given database determined by the database number or
           suffix and writes the corresponding LDIF to standard output or the
           specified file.  Databases configured as **subordinate** of this one
           are also output, unless **-g** is specified.
    
           The entry records are presented in database order, not superior
           first order.  The entry records will include all (user and
           operational) attributes stored in the database.  The entry records
           will not include dynamically generated attributes (such as
           subschemaSubentry).
    
           The output of slapcat is intended to be used as input to
           slapadd(8).  The output of slapcat cannot generally be used as
           input to ldapadd(1) or other LDAP clients without first editing
           the output.  This editing would normally include reordering the
           records into superior first order and removing no-user-
           modification operational attributes.
    


## OPTIONS



           **-a** _filter_
                  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.  Deprecated; use **-H**
                  _ldap:///???(filter)_ instead.
    
           **-b** _suffix_
                  Use the specified _suffix_ to determine which database to
                  generate output for. By default, the first database that
                  supports the requested operation is used. The **-b** cannot be
                  used in conjunction with the **-n** option.
    
           **-c** Enable continue (ignore errors) mode.  Multiple occurrences
                  of **-c** make slapcat(8) try harder.
    
           **-d** _debug-level_
                  Enable debugging messages as defined by the specified
                  _debug-level_ ; see slapd(8) for details.
    
           **-f** _slapd.conf_
                  Specify an alternative slapd.conf(5) file.
    
           **-F** _confdir_
                  specify a config directory.  If both **-f** and **-F** are
                  specified, the config file will be read and converted to
                  config directory format and written to the specified
                  directory.  If neither option is specified, an attempt to
                  read the default config directory will be made before
                  trying to use the default config file. If a valid config
                  directory exists then the default config file is ignored.
    
           **-g** disable subordinate gluing.  Only the specified database
                  will be processed, and not its glued subordinates (if any).
    
           **-H  URI**
                  use dn, scope and filter from URI to only handle matching
                  entries.
    
           **-l** _ldif-file_
                  Write LDIF to specified file instead of standard output.
    
           **-n** _dbnum_
                  Generate output for the _dbnum_ -th database listed in the
                  configuration file. The config database slapd-config(5), is
                  always the first database, so use **-n 0** to select it.
    
                  The **-n** cannot be used in conjunction with the **-b** option.
    
           **-o** _option_[**=**_value_]
                  Specify an _option_ with a(n optional) _value_.  Possible
                  generic options/values are:
    
                         syslog=<subsystems>  (see `-s' in slapd(8))
                         syslog-level=<level> (see `-S' in slapd(8))
                         syslog-user=<user>   (see `-l' in slapd(8))
    
                         ldif_wrap={no|<n>}
    
                  _n_ is the number of columns allowed for the LDIF output
                  (_n_ equal to _0_ uses the default, corresponding to 78).
                  The minimum is 2, leaving space for one character and one
                  continuation character.
                  Use _no_ for no wrap.
    
           **-s** _subtree-dn_
                  Only dump entries in the subtree specified by this DN.
                  Implies **-b** _subtree-dn_ if no
                  **-b**
                  or
                  **-n**
                  option is given.
                  Deprecated; use **-H** _ldap:///subtree-dn_ instead.
    
           **-v** Enable verbose mode.
    


## LIMITATIONS



           For some backend types, your slapd(8) should not be running (at
           least, not in read-write mode) when you do this to ensure
           consistency of the database. It is always safe to run **slapcat** with
           the slapd-mdb(5), and slapd-null(5) backends.
    


## EXAMPLES



           To make a text backup of your SLAPD database and put it in a file
           called **ldif** , give the command:
    
                SBINDIR/slapcat -l ldif
    


## ACKNOWLEDGEMENTS



           **OpenLDAP Software** is developed and maintained by The OpenLDAP
           Project <http://www.openldap.org/>.  **OpenLDAP Software** is derived
           from the University of Michigan LDAP 3.3 Release.
    


* * *