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