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 \-M[M]
 155 Enable manage DSA IT control.
 156 .B \-MM
 157 makes control critical.
 158 .TP
 159 .BI \-d \ debuglevel
 160 Set the LDAP debugging level to \fIdebuglevel\fP.
 161 .B ldapmodify
 162 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 163 .TP
 164 .BI \-f \ file
 165 Read the entry modification information from \fIfile\fP instead of from
 166 standard input.
 167 .TP
 168 .B \-x
 169 Use simple authentication instead of SASL.
 170 .TP
 171 .BI \-D \ binddn
 172 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 173 For SASL Binds, the server is expected to ignore this value.
 174 .TP
 175 .B \-W
 176 Prompt for simple authentication.
 177 This is used instead of specifying the password on the command line.
 178 .TP
 179 .BI \-w \ passwd
 180 Use \fIpasswd\fP as the password for simple authentication.
 181 .TP
 182 .BI \-y \ passwdfile
 183 Use complete contents of \fIpasswdfile\fP as the password for
 184 simple authentication.
 185 .TP
 186 .BI \-H \ ldapuri
 187 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 188 fields are allowed; a list of URI, separated by whitespace or commas
 189 is expected.
 190 .TP
 191 .BI \-h \ ldaphost
 192 Specify an alternate host on which the ldap server is running.
 193 Deprecated in favor of -H.
 194 .TP
 195 .BI \-p \ ldapport
 196 Specify an alternate TCP port where the ldap server is listening.
 197 Deprecated in favor of -H.
 198 .TP
 199 .BI \-P \ 2\fR\||\|\fI3
 200 Specify the LDAP protocol version to use.
 201 .TP
 202 .BI \-O \ security-properties
 203 Specify SASL security properties.
 204 .TP
 205 .B \-I
 206 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 207 only as needed.
 208 .TP
 209 .B \-Q
 210 Enable SASL Quiet mode.  Never prompt.
 211 .TP
 212 .BI \-U \ authcid
 213 Specify the authentication ID for SASL bind. The form of the ID
 214 depends on the actual SASL mechanism used.
 215 .TP
 216 .BI \-R \ realm
 217 Specify the realm of authentication ID for SASL bind. The form of the realm
 218 depends on the actual SASL mechanism used.
 219 .TP
 220 .BI \-X \ authzid
 221 Specify the requested authorization ID for SASL bind.
 222 .I authzid
 223 must be one of the following formats:
 224 .B dn:\c
 225 .I <distinguished name>
 226 or
 227 .B u:\c
 228 .I <username>
 229 .TP
 230 .BI \-Y \ mech
 231 Specify the SASL mechanism to be used for authentication. If it's not
 232 specified, the program will choose the best mechanism the server knows.
 233 .TP
 234 .B \-Z[Z]
 235 Issue StartTLS (Transport Layer Security) extended operation. If you use
 236 .B \-ZZ\c
 237 , the command will require the operation to be successful.
 238 .SH INPUT FORMAT
 239 The contents of \fIfile\fP (or standard input if no \-f flag is given on
 240 the command line) must conform to the format defined in
 241 .BR ldif (5)
 242 (LDIF as defined in RFC 2849).
 243 .SH EXAMPLES
 244 Assuming that the file
 245 .B /tmp/entrymods
 246 exists and has the contents:
 247 .LP
 248 .nf
 249     dn: cn=Modify Me,dc=example,dc=com
 250     changetype: modify
 251     replace: mail
 252     mail: modme@example.com
 253     -
 254     add: title
 255     title: Grand Poobah
 256     -
 257     add: jpegPhoto
 258     jpegPhoto:< file:///tmp/modme.jpeg
 259     -
 260     delete: description
 261     -
 262 .fi
 263 .LP
 264 the command:
 265 .LP
 266 .nf
 267     ldapmodify -f /tmp/entrymods
 268 .fi
 269 .LP
 270 will replace the contents of the "Modify Me" entry's
 271 .I mail
 272 attribute with the value "modme@example.com", add a
 273 .I title
 274 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
 275 as a
 276 .IR jpegPhoto ,
 277 and completely remove the
 278 .I description
 279 attribute.
 280 .LP
 281 Assuming that the file
 282 .B /tmp/newentry
 283 exists and has the contents:
 284 .LP
 285 .nf
 286     dn: cn=Barbara Jensen,dc=example,dc=com
 287     objectClass: person
 288     cn: Barbara Jensen
 289     cn: Babs Jensen
 290     sn: Jensen
 291     title: the world's most famous mythical manager
 292     mail: bjensen@example.com
 293     uid: bjensen
 294 .fi
 295 .LP
 296 the command:
 297 .LP
 298 .nf
 299     ldapadd -f /tmp/newentry
 300 .fi
 301 .LP
 302 will add a new entry for Babs Jensen, using the values from the
 303 file
 304 .B /tmp/newentry.
 305 .LP
 306 Assuming that the file
 307 .B /tmp/entrymods
 308 exists and has the contents:
 309 .LP
 310 .nf
 311     dn: cn=Barbara Jensen,dc=example,dc=com
 312     changetype: delete
 313 .fi
 314 .LP
 315 the command:
 316 .LP
 317 .nf
 318     ldapmodify -f /tmp/entrymods
 319 .fi
 320 .LP
 321 will remove Babs Jensen's entry.
 322 .SH DIAGNOSTICS
 323 Exit status is zero if no errors occur.  Errors result in a non-zero
 324 exit status and a diagnostic message being written to standard error.
 325 .SH "SEE ALSO"
 326 .BR ldapadd (1),
 327 .BR ldapdelete (1),
 328 .BR ldapmodrdn (1),
 329 .BR ldapsearch (1),
 330 .BR ldap.conf (5),
 331 .BR ldap (3),
 332 .BR ldap_add_ext (3),
 333 .BR ldap_delete_ext (3),
 334 .BR ldap_modify_ext (3),
 335 .BR ldap_modrdn_ext (3),
 336 .BR ldif (5),
 337 .BR slapd.replog (5)
 338 .SH AUTHOR
 339 The OpenLDAP Project <http://www.openldap.org/>
 340 .SH ACKNOWLEDGEMENTS
 341 .so ../Project