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

   1 .TH SLAPADD 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 slapadd \- Add entries to a SLAPD database
   7 .SH SYNOPSIS
   8 .B SBINDIR/slapadd
   9 .B [\-b suffix]
  10 .B [\-c]
  11 .B [\-g]
  12 .B [\-d level]
  13 .B [\-f slapd.conf]
  14 .B [\-F confdir]
  15 .B [\-l ldif-file]
  16 .B [\-n dbnum]
  17 .B [\-o name[=value]
  18 .B [\-q]
  19 .B [\-u]
  20 .B [\-v]
  21 .B [\-w]
  22 .SH DESCRIPTION
  23 .LP
  24 .B Slapadd
  25 is used to add entries specified in LDAP Directory Interchange Format
  26 (LDIF) to a
  27 .BR slapd (8)
  28 database.
  29 It opens the given database determined by the database number or
  30 suffix and adds entries corresponding to the provided LDIF to
  31 the database.
  32 Databases configured as
  33 .B subordinate
  34 of this one are also updated, unless \fB-g\fP is specified.
  35 The LDIF input is read from standard input or the specified file.
  36 .LP
  37 As
  38 .B slapadd
  39 is designed to accept LDIF in database order, as produced by
  40 .BR slapcat (8),
  41 it does not verify that superior entries exist before
  42 adding an entry, does not perform all user and system
  43 schema checks, and does not maintain operational
  44 attributes (such as createTimeStamp and modifiersName).
  45 .SH OPTIONS
  46 .TP
  47 .BI \-b " suffix"
  48 Use the specified \fIsuffix\fR to determine which database to
  49 add entries to.  The \-b cannot be used in conjunction
  50 with the
  51 .B \-n
  52 option.
  53 .TP
  54 .B \-c
  55 enable continue (ignore errors) mode.
  56 .TP
  57 .BI \-d " level"
  58 enable debugging messages as defined by the specified
  59 .IR level .
  60 .TP
  61 .BI \-f " slapd.conf"
  62 specify an alternative
  63 .BR slapd.conf (5)
  64 file.
  65 .TP
  66 .BI \-F " confdir"
  67 specify a config directory.
  68 If both
  69 .B -f
  70 and
  71 .B -F
  72 are specified, the config file will be read and converted to
  73 config directory format and written to the specified directory.
  74 If neither option is specified, an attempt to read the
  75 default config directory will be made before trying to use the default
  76 config file. If a valid config directory exists then the
  77 default config file is ignored. If dryrun mode is also specified,
  78 no conversion will occur.
  79 .TP
  80 .B \-g
  81 disable subordinate gluing.  Only the specified database will be
  82 processed, and not its glued subordinates (if any).
  83 .TP
  84 .BI \-l " ldif-file"
  85 Read LDIF from the specified file instead of standard input.
  86 .TP
  87 .BI \-n " dbnum"
  88 Add entries to the \fIdbnum\fR\-th database listed in the
  89 configuration file.  The
  90 .B \-n
  91 cannot be used in conjunction with the
  92 .B \-b
  93 option.
  94 .TP
  95 .BI \-o " option[=value]"
  96 Specify an
  97 .BR option
  98 with a(n optional)
  99 .BR value .
 100 Possible generic options/values are:
 101 .LP
 102 .nf
 103               syslog=<subsystems>  (see `\-s' in slapd(8))
 104               syslog-level=<level> (see `\-S' in slapd(8))
 105               syslog-user=<user>   (see `\-l' in slapd(8))
 106
 107 .fi
 108 .TP
 109 .B \-q
 110 enable quick (fewer integrity checks) mode.  Does fewer consistency checks
 111 on the input data, and no consistency checks when writing the database.
 112 Improves the load time but if any errors or interruptions occur the resulting
 113 database will be unusable.
 114 .TP
 115 .B -s
 116 disable schema checking.  This option is intended to be used when loading
 117 databases containing special objects, such as fractional objects on a
 118 partial replica.  Loading normal objects which do not conform to
 119 schema may result in unexpected and ill behavior.
 120 .TP
 121 .B \-u
 122 enable dry-run (don't write to backend) mode.
 123 .TP
 124 .B \-v
 125 enable verbose mode.
 126 .TP
 127 .BI \-w
 128 write syncrepl context information.
 129 After all entries are added, the contextCSN
 130 will be updated with the greatest CSN in the database.
 131 .SH LIMITATIONS
 132 Your
 133 .BR slapd (8)
 134 should not be running
 135 when you do this to ensure consistency of the database.
 136 .LP
 137 .B slapadd
 138 may not provide naming or schema checks.  It is advisable to
 139 use
 140 .BR ldapadd (1)
 141 when adding new entries into an existing directory.
 142 .SH EXAMPLES
 143 To import the entries specified in file
 144 .B ldif
 145 into your
 146 .BR slapd (8)
 147 database give the command:
 148 .LP
 149 .nf
 150 .ft tt
 151         SBINDIR/slapadd -l ldif
 152 .ft
 153 .fi
 154 .SH "SEE ALSO"
 155 .BR ldap (3),
 156 .BR ldif (5),
 157 .BR slapcat (8),
 158 .BR ldapadd (1),
 159 .BR slapd (8)
 160 .LP
 161 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 162 .SH ACKNOWLEDGEMENTS
 163 .B OpenLDAP
 164 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 165 .B OpenLDAP
 166 is derived from University of Michigan LDAP 3.3 Release.