git.sur5r.net Git - openldap/blob - doc/man/man1/ldapmodify.1

   1 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
   7 .SH SYNOPSIS
   8 .B ldapmodify
   9 [\c
  10 .BR \-a ]
  11 [\c
  12 .BR \-c ]
  13 [\c
  14 .BI \-S \ file\fR]
  15 [\c
  16 .BR \-n ]
  17 [\c
  18 .BR \-v ]
  19 [\c
  20 .BR \-M[M] ]
  21 [\c
  22 .BI \-d \ debuglevel\fR]
  23 [\c
  24 .BI \-D \ binddn\fR]
  25 [\c
  26 .BR \-W ]
  27 [\c
  28 .BI \-w \ passwd\fR]
  29 [\c
  30 .BI \-y \ passwdfile\fR]
  31 [\c
  32 .BI \-H \ ldapuri\fR]
  33 [\c
  34 .BI \-h \ ldaphost\fR]
  35 [\c
  36 .BI \-p \ ldapport\fR]
  37 [\c
  38 .BI \-P \ 2\fR\||\|\fI3\fR]
  39 [\c
  40 .BR \-O \ security-properties ]
  41 [\c
  42 .BR \-I ]
  43 [\c
  44 .BR \-Q ]
  45 [\c
  46 .BI \-U \ authcid\fR]
  47 [\c
  48 .BI \-R \ realm\fR]
  49 [\c
  50 .BR \-x ]
  51 [\c
  52 .BI \-X \ authzid\fR]
  53 [\c
  54 .BI \-Y \ mech\fR]
  55 [\c
  56 .BR \-Z[Z] ]
  57 [\c
  58 .BI \-f \ file\fR]
  59 .LP
  60 .B ldapadd
  61 [\c
  62 .BR \-c ]
  63 [\c
  64 .BI \-S \ file\fR]
  65 [\c
  66 .BR \-n ]
  67 [\c
  68 .BR \-v ]
  69 [\c
  70 .BR \-M[M] ]
  71 [\c
  72 .BI \-d \ debuglevel\fR]
  73 [\c
  74 .BI \-D \ binddn\fR]
  75 [\c
  76 .BR \-W ]
  77 [\c
  78 .BI \-w \ passwd\fR]
  79 [\c
  80 .BI \-y \ passwdfile\fR]
  81 [\c
  82 .BI \-H \ ldapuri\fR]
  83 [\c
  84 .BI \-h \ ldaphost\fR]
  85 [\c
  86 .BI \-p \ ldapport\fR]
  87 [\c
  88 .BI \-P \ 2\fR\||\|\fI3\fR]
  89 [\c
  90 .BR \-O \ security-properties ]
  91 [\c
  92 .BR \-I ]
  93 [\c
  94 .BR \-Q ]
  95 [\c
  96 .BI \-U \ authcid\fR]
  97 [\c
  98 .BI \-R \ realm\fR]
  99 [\c
 100 .BR \-x ]
 101 [\c
 102 .BI \-X \ authzid\fR]
 103 [\c
 104 .BI \-Y \ mech\fR]
 105 [\c
 106 .BR \-Z[Z] ]
 107 [\c
 108 .BI \-f \ file\fR]
 109 .SH DESCRIPTION
 110 .B ldapmodify
 111 is a shell-accessible interface to the
 112 .BR ldap_add_ext (3),
 113 .BR ldap_modify_ext (3),
 114 .BR ldap_delete_ext (3)
 115 and
 116 .BR ldap_rename (3).
 117 library calls.
 118 .B ldapadd
 119 is implemented as a hard link to the ldapmodify tool.  When invoked as
 120 .B ldapadd
 121 the -a (add new entry) flag is turned on automatically.
 122 .LP
 123 .B ldapmodify
 124 opens a connection to an LDAP server, binds, and modifies or adds entries.
 125 The entry information is read from standard input or from \fIfile\fP through
 126 the use of the -f option.
 127 .SH OPTIONS
 128 .TP
 129 .B \-a
 130 Add new entries.  The default for
 131 .B ldapmodify
 132 is to modify existing entries.  If invoked as
 133 .BR ldapadd ,
 134 this flag is always set.
 135 .TP
 136 .B \-c
 137 Continuous operation mode.  Errors are reported, but
 138 .B ldapmodify
 139 will continue with modifications.  The default is to exit after
 140 reporting an error.
 141 .TP
 142 .BI \-S \ file
 143 Add or change records which where skipped due to an error are written to \fIfile\fP
 144 and the error message returned by the server is added as a comment. Most useful in
 145 conjunction with -c.
 146 .TP
 147 .B \-n
 148 Show what would be done, but don't actually modify entries.  Useful for
 149 debugging in conjunction with -v.
 150 .TP
 151 .B \-v
 152 Use verbose mode, with many diagnostics written to standard output.
 153 .TP
 154 .B \-F
 155 Force application of all changes regardless of the contents of input
 156 lines that begin with
 157 .I replica:
 158 (by default, replica: lines are compared against the LDAP server host
 159 and port in use to decide if a replog record should actually be applied).
 160 .TP
 161 .B \-M[M]
 162 Enable manage DSA IT control.
 163 .B \-MM
 164 makes control critical.
 165 .TP
 166 .BI \-d \ debuglevel
 167 Set the LDAP debugging level to \fIdebuglevel\fP.
 168 .B ldapmodify
 169 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 170 .TP
 171 .BI \-f \ file
 172 Read the entry modification information from \fIfile\fP instead of from
 173 standard input.
 174 .TP
 175 .B \-x
 176 Use simple authentication instead of SASL.
 177 .TP
 178 .BI \-D \ binddn
 179 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 180 .TP
 181 .B \-W
 182 Prompt for simple authentication.
 183 This is used instead of specifying the password on the command line.
 184 .TP
 185 .BI \-w \ passwd
 186 Use \fIpasswd\fP as the password for simple authentication.
 187 .TP
 188 .BI \-y \ passwdfile
 189 Use complete contents of \fIpasswdfile\fP as the password for
 190 simple authentication.
 191 .TP
 192 .BI \-H \ ldapuri
 193 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 194 fields are allowed; a list of URI, separated by whitespace or commas
 195 is expected.
 196 .TP
 197 .BI \-h \ ldaphost
 198 Specify an alternate host on which the ldap server is running.
 199 Deprecated in favor of -H.
 200 .TP
 201 .BI \-p \ ldapport
 202 Specify an alternate TCP port where the ldap server is listening.
 203 Deprecated in favor of -H.
 204 .TP
 205 .BI \-P \ 2\fR\||\|\fI3
 206 Specify the LDAP protocol version to use.
 207 .TP
 208 .BI \-O \ security-properties
 209 Specify SASL security properties.
 210 .TP
 211 .B \-I
 212 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 213 only as needed.
 214 .TP
 215 .B \-Q
 216 Enable SASL Quiet mode.  Never prompt.
 217 .TP
 218 .BI \-U \ authcid
 219 Specify the authentication ID for SASL bind. The form of the ID
 220 depends on the actual SASL mechanism used.
 221 .TP
 222 .BI \-R \ realm
 223 Specify the realm of authentication ID for SASL bind. The form of the realm
 224 depends on the actual SASL mechanism used.
 225 .TP
 226 .BI \-X \ authzid
 227 Specify the requested authorization ID for SASL bind.
 228 .I authzid
 229 must be one of the following formats:
 230 .B dn:\c
 231 .I <distinguished name>
 232 or
 233 .B u:\c
 234 .I <username>
 235 .TP
 236 .BI \-Y \ mech
 237 Specify the SASL mechanism to be used for authentication. If it's not
 238 specified, the program will choose the best mechanism the server knows.
 239 .TP
 240 .B \-Z[Z]
 241 Issue StartTLS (Transport Layer Security) extended operation. If you use
 242 .B \-ZZ\c
 243 , the command will require the operation to be successful.
 244 .SH INPUT FORMAT
 245 The contents of \fIfile\fP (or standard input if no \-f flag is given on
 246 the command line) must conform to the format defined in
 247 .BR ldif (5)
 248 (LDIF as defined RFC 2849).
 249 .SH EXAMPLES
 250 Assuming that the file
 251 .B /tmp/entrymods
 252 exists and has the contents:
 253 .LP
 254 .nf
 255     dn: cn=Modify Me,dc=example,dc=com
 256     changetype: modify
 257     replace: mail
 258     mail: modme@example.com
 259     -
 260     add: title
 261     title: Grand Poobah
 262     -
 263     add: jpegPhoto
 264     jpegPhoto:< file:///tmp/modme.jpeg
 265     -
 266     delete: description
 267     -
 268 .fi
 269 .LP
 270 the command:
 271 .LP
 272 .nf
 273     ldapmodify -f /tmp/entrymods
 274 .fi
 275 .LP
 276 will replace the contents of the "Modify Me" entry's
 277 .I mail
 278 attribute with the value "modme@example.com", add a
 279 .I title
 280 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
 281 as a
 282 .IR jpegPhoto ,
 283 and completely remove the
 284 .I description
 285 attribute.
 286 .LP
 287 Assuming that the file
 288 .B /tmp/newentry
 289 exists and has the contents:
 290 .LP
 291 .nf
 292     dn: cn=Barbara Jensen,dc=example,dc=com
 293     objectClass: person
 294     cn: Barbara Jensen
 295     cn: Babs Jensen
 296     sn: Jensen
 297     title: the world's most famous mythical manager
 298     mail: bjensen@example.com
 299     uid: bjensen
 300 .fi
 301 .LP
 302 the command:
 303 .LP
 304 .nf
 305     ldapadd -f /tmp/newentry
 306 .fi
 307 .LP
 308 will add a new entry for Babs Jensen, using the values from the
 309 file
 310 .B /tmp/newentry.
 311 .LP
 312 Assuming that the file
 313 .B /tmp/entrymods
 314 exists and has the contents:
 315 .LP
 316 .nf
 317     dn: cn=Barbara Jensen,dc=example,dc=com
 318     changetype: delete
 319 .fi
 320 .LP
 321 the command:
 322 .LP
 323 .nf
 324     ldapmodify -f /tmp/entrymods
 325 .fi
 326 .LP
 327 will remove Babs Jensen's entry.
 328 .SH DIAGNOSTICS
 329 Exit status is zero if no errors occur.  Errors result in a non-zero
 330 exit status and a diagnostic message being written to standard error.
 331 .SH "SEE ALSO"
 332 .BR ldapadd (1),
 333 .BR ldapdelete (1),
 334 .BR ldapmodrdn (1),
 335 .BR ldapsearch (1),
 336 .BR ldap.conf (5),
 337 .BR ldap (3),
 338 .BR ldap_add_ext (3),
 339 .BR ldap_delete_ext (3),
 340 .BR ldap_modify_ext (3),
 341 .BR ldap_modrdn_ext (3),
 342 .BR ldif (5),
 343 .BR slapd.replog (5)
 344 .SH AUTHOR
 345 The OpenLDAP Project <http://www.openldap.org/>
 346 .SH ACKNOWLEDGEMENTS
 347 .so ../Project