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

   1 .TH SLAPADD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2007 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 [\-d level]
  12 .B [\-f slapd.conf]
  13 .B [\-F confdir]
  14 .B [\-g]
  15 .B [\-j lineno]
  16 .B [\-l ldif-file]
  17 .B [\-n dbnum]
  18 .B [\-o name[=value]
  19 .B [\-q]
  20 .B [\-s]
  21 .B [\-S SID]
  22 .B [\-u]
  23 .B [\-v]
  24 .B [\-w]
  25 .SH DESCRIPTION
  26 .LP
  27 .B Slapadd
  28 is used to add entries specified in LDAP Directory Interchange Format
  29 (LDIF) to a
  30 .BR slapd (8)
  31 database.
  32 It opens the given database determined by the database number or
  33 suffix and adds entries corresponding to the provided LDIF to
  34 the database.
  35 Databases configured as
  36 .B subordinate
  37 of this one are also updated, unless \fB-g\fP is specified.
  38 The LDIF input is read from standard input or the specified file.
  39 .SH OPTIONS
  40 .TP
  41 .BI \-b " suffix"
  42 Use the specified \fIsuffix\fR to determine which database to
  43 add entries to.  The \-b cannot be used in conjunction
  44 with the
  45 .B \-n
  46 option.
  47 .TP
  48 .B \-c
  49 enable continue (ignore errors) mode.
  50 .TP
  51 .BI \-d " level"
  52 enable debugging messages as defined by the specified
  53 .IR level ;
  54 see
  55 .BR slapd (8)
  56 for details.
  57 .TP
  58 .BI \-f " slapd.conf"
  59 specify an alternative
  60 .BR slapd.conf (5)
  61 file.
  62 .TP
  63 .BI \-F " confdir"
  64 specify a config directory.
  65 If both
  66 .B -f
  67 and
  68 .B -F
  69 are specified, the config file will be read and converted to
  70 config directory format and written to the specified directory.
  71 If neither option is specified, an attempt to read the
  72 default config directory will be made before trying to use the default
  73 config file. If a valid config directory exists then the
  74 default config file is ignored. If dryrun mode is also specified,
  75 no conversion will occur.
  76 .TP
  77 .B \-g
  78 disable subordinate gluing.  Only the specified database will be
  79 processed, and not its glued subordinates (if any).
  80 .TP
  81 .BI \-j " lineno"
  82 Jump to the specified line number in the LDIF file before processing
  83 any entries. This allows a load that was aborted due to errors in the
  84 input LDIF to be resumed after the errors are corrected.
  85 .TP
  86 .BI \-l " ldif-file"
  87 Read LDIF from the specified file instead of standard input.
  88 .TP
  89 .BI \-n " dbnum"
  90 Add entries to the \fIdbnum\fR\-th database listed in the
  91 configuration file.  The
  92 .B \-n
  93 cannot be used in conjunction with the
  94 .B \-b
  95 option.
  96 .TP
  97 .BI \-o " option[=value]"
  98 Specify an
  99 .BR option
 100 with a(n optional)
 101 .BR value .
 102 Possible generic options/values are:
 103 .LP
 104 .nf
 105               syslog=<subsystems>  (see `\-s' in slapd(8))
 106               syslog-level=<level> (see `\-S' in slapd(8))
 107               syslog-user=<user>   (see `\-l' in slapd(8))
 108
 109 .fi
 110 .TP
 111 .B \-q
 112 enable quick (fewer integrity checks) mode.  Does fewer consistency checks
 113 on the input data, and no consistency checks when writing the database.
 114 Improves the load time but if any errors or interruptions occur the resulting
 115 database will be unusable.
 116 .TP
 117 .B -s
 118 disable schema checking.  This option is intended to be used when loading
 119 databases containing special objects, such as fractional objects on a
 120 partial replica.  Loading normal objects which do not conform to
 121 schema may result in unexpected and ill behavior.
 122 .TP
 123 .B \-S " SID"
 124 Server ID to use in generated entryCSN.  Also used for contextCSN
 125 if `\-w' is set as well.  Defaults to 0.
 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 .so ../Project