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 see
  62 .BR slapd (8)
  63 for details.
  64 .TP
  65 .BI \-f " slapd.conf"
  66 specify an alternative
  67 .BR slapd.conf (5)
  68 file.
  69 .TP
  70 .BI \-F " confdir"
  71 specify a config directory.
  72 If both
  73 .B -f
  74 and
  75 .B -F
  76 are specified, the config file will be read and converted to
  77 config directory format and written to the specified directory.
  78 If neither option is specified, an attempt to read the
  79 default config directory will be made before trying to use the default
  80 config file. If a valid config directory exists then the
  81 default config file is ignored. If dryrun mode is also specified,
  82 no conversion will occur.
  83 .TP
  84 .B \-g
  85 disable subordinate gluing.  Only the specified database will be
  86 processed, and not its glued subordinates (if any).
  87 .TP
  88 .BI \-j " lineno"
  89 Jump to the specified line number in the LDIF file before processing
  90 any entries. This allows a load that was aborted due to errors in the
  91 input LDIF to be resumed after the errors are corrected.
  92 .TP
  93 .BI \-l " ldif-file"
  94 Read LDIF from the specified file instead of standard input.
  95 .TP
  96 .BI \-n " dbnum"
  97 Add entries to the \fIdbnum\fR\-th database listed in the
  98 configuration file.  The
  99 .B \-n
 100 cannot be used in conjunction with the
 101 .B \-b
 102 option.
 103 .TP
 104 .BI \-o " option[=value]"
 105 Specify an
 106 .BR option
 107 with a(n optional)
 108 .BR value .
 109 Possible generic options/values are:
 110 .LP
 111 .nf
 112               syslog=<subsystems>  (see `\-s' in slapd(8))
 113               syslog-level=<level> (see `\-S' in slapd(8))
 114               syslog-user=<user>   (see `\-l' in slapd(8))
 115
 116 .fi
 117 .TP
 118 .B \-q
 119 enable quick (fewer integrity checks) mode.  Does fewer consistency checks
 120 on the input data, and no consistency checks when writing the database.
 121 Improves the load time but if any errors or interruptions occur the resulting
 122 database will be unusable.
 123 .TP
 124 .B -s
 125 disable schema checking.  This option is intended to be used when loading
 126 databases containing special objects, such as fractional objects on a
 127 partial replica.  Loading normal objects which do not conform to
 128 schema may result in unexpected and ill behavior.
 129 .TP
 130 .B \-u
 131 enable dry-run (don't write to backend) mode.
 132 .TP
 133 .B \-v
 134 enable verbose mode.
 135 .TP
 136 .BI \-w
 137 write syncrepl context information.
 138 After all entries are added, the contextCSN
 139 will be updated with the greatest CSN in the database.
 140 .SH LIMITATIONS
 141 Your
 142 .BR slapd (8)
 143 should not be running
 144 when you do this to ensure consistency of the database.
 145 .LP
 146 .B slapadd
 147 may not provide naming or schema checks.  It is advisable to
 148 use
 149 .BR ldapadd (1)
 150 when adding new entries into an existing directory.
 151 .SH EXAMPLES
 152 To import the entries specified in file
 153 .B ldif
 154 into your
 155 .BR slapd (8)
 156 database give the command:
 157 .LP
 158 .nf
 159 .ft tt
 160         SBINDIR/slapadd -l ldif
 161 .ft
 162 .fi
 163 .SH "SEE ALSO"
 164 .BR ldap (3),
 165 .BR ldif (5),
 166 .BR slapcat (8),
 167 .BR ldapadd (1),
 168 .BR slapd (8)
 169 .LP
 170 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 171 .SH ACKNOWLEDGEMENTS
 172 .so ../Project