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

   1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapmodrdn \- LDAP rename entry tool
   7 .SH SYNOPSIS
   8 .B ldapmodrdn
   9 [\c
  10 .BR \-r ]
  11 [\c
  12 .BR \-n ]
  13 [\c
  14 .BR \-v ]
  15 [\c
  16 .BR \-k ]
  17 [\c
  18 .BR \-K ]
  19 [\c
  20 .BR \-c ]
  21 [\c
  22 .BR \-M[M] ]
  23 [\c
  24 .BI \-d \ debuglevel\fR]
  25 [\c
  26 .BI \-D \ binddn\fR]
  27 [\c
  28 .BR \-W ]
  29 [\c
  30 .BI \-w \ passwd\fR]
  31 [\c
  32 .BI \-y \ passwdfile\fR]
  33 [\c
  34 .BI \-H \ ldapuri\fR]
  35 [\c
  36 .BI \-h \ ldaphost\fR]
  37 [\c
  38 .BI \-p \ ldapport\fR]
  39 [\c
  40 .BI \-P \ 2\fR\||\|\fI3\fR]
  41 [\c
  42 .BR \-O \ security-properties ]
  43 [\c
  44 .BR \-I ]
  45 [\c
  46 .BR \-Q ]
  47 [\c
  48 .BI \-U \ authcid\fR]
  49 [\c
  50 .BI \-R \ realm\fR]
  51 [\c
  52 .BR \-x ]
  53 [\c
  54 .BI \-X \ authzid\fR]
  55 [\c
  56 .BI \-Y \ mech\fR]
  57 [\c
  58 .BR \-Z[Z] ]
  59 [\c
  60 .BI \-f \ file\fR]
  61 [\c
  62 .I dn  rdn\fR]
  63 .SH DESCRIPTION
  64 .B ldapmodrdn
  65 is a shell-accessible interface to the
  66 .BR ldap_modrdn2 (3)
  67 library call.
  68 .LP
  69 .B ldapmodrdn
  70 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
  71 The entry information is read from standard input, from \fIfile\fP through
  72 the use of the
  73 .RI \- f
  74 option, or from the command-line pair \fIdn\fP and
  75 \fIrdn\fP.
  76 .SH OPTIONS
  77 .TP
  78 .B \-r
  79 Remove old RDN values from the entry.  Default is to keep old values.
  80 .TP
  81 .B \-n
  82 Show what would be done, but don't actually change entries.  Useful for
  83 debugging in conjunction with -v.
  84 .TP
  85 .B \-v
  86 Use verbose mode, with many diagnostics written to standard output.
  87 .TP
  88 .B \-k
  89 Use Kerberos IV authentication instead of simple authentication.  It is
  90 assumed that you already have a valid ticket granting ticket.
  91 .B ldapmodrdn
  92 must be compiled with Kerberos support for this option to have effect.
  93 .TP
  94 .B \-K
  95 Same as \-k, but only does step 1 of the Kerberos IV bind.  This is useful
  96 when connecting to a slapd and there is no x500dsa.hostname principal
  97 registered with your Kerberos Domain Controller(s).
  98 .TP
  99 .B \-c
 100 Continuous operation mode.  Errors  are  reported,  but ldapmodify
 101 will  continue  with  modifications.   The default is to exit after
 102 reporting an error.
 103 .TP
 104 .B \-M[M]
 105 Enable manage DSA IT control.
 106 .B \-MM
 107 makes control critical.
 108 .TP
 109 .B \-d debuglevel
 110 Set the LDAP debugging level to \fIdebuglevel\fP.
 111 .B ldapmodrdn
 112 must be
 113 compiled with LDAP_DEBUG defined for this option to have any effect.
 114 .TP
 115 .B \-f file
 116 Read the entry modification information from \fIfile\fP instead of from
 117 standard input or the command-line.
 118 .TP
 119 .B \-x
 120 Use simple authentication instead of SASL.
 121 .TP
 122 .B \-D binddn
 123 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 124 .TP
 125 .B \-W
 126 Prompt for simple authentication.
 127 This is used instead of specifying the password on the command line.
 128 .TP
 129 .B \-w passwd
 130 Use \fIpasswd\fP as the password for simple authentication.
 131 .TP
 132 .BI \-y \ passwdfile
 133 Use complete contents of \fIpasswdfile\fP as the password for
 134 simple authentication.
 135 .TP
 136 .BI \-H \ ldapuri
 137 Specify URI(s) referring to the ldap server(s).
 138 .TP
 139 .BI \-h \ ldaphost
 140 Specify an alternate host on which the ldap server is running.
 141 Deprecated in favor of -H.
 142 .TP
 143 .BI \-p \ ldapport
 144 Specify an alternate TCP port where the ldap server is listening.
 145 Deprecated in favor of -H.
 146 .TP
 147 .BI \-P \ 2\fR\||\|\fI3
 148 Specify the LDAP protocol version to use.
 149 .TP
 150 .BI \-O \ security-properties
 151 Specify SASL security properties.
 152 .TP
 153 .B \-I
 154 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 155 only as needed.
 156 .TP
 157 .B \-Q
 158 Enable SASL Quiet mode.  Never prompt.
 159 .TP
 160 .BI \-U \ authcid
 161 Specify the authentication ID for SASL bind. The form of the ID
 162 depends on the actual SASL mechanism used.
 163 .TP
 164 .BI \-R \ realm
 165 Specify the realm of authentication ID for SASL bind. The form of the realm
 166 depends on the actual SASL mechanism used.
 167 .TP
 168 .BI \-X \ authzid
 169 Specify the requested authorization ID for SASL bind.
 170 .I authzid
 171 must be one of the following formats:
 172 .B dn:\c
 173 .I <distinguished name>
 174 or
 175 .B u:\c
 176 .I <username>
 177 .TP
 178 .BI \-Y \ mech
 179 Specify the SASL mechanism to be used for authentication. If it's not
 180 specified, the program will choose the best mechanism the server knows.
 181 .TP
 182 .B \-Z[Z]
 183 Issue StartTLS (Transport Layer Security) extended operation. If you use
 184 .B \-ZZ\c
 185 , the command will require the operation to be successful.
 186 .SH INPUT FORMAT
 187 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 188 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 189 .LP
 190 Otherwise, the contents of \fIfile\fP (or standard input if
 191 no
 192 .RI \- f
 193 flag is given) should consist of one or more entries.
 194 .LP
 195 .nf
 196     Distinguished Name (DN)
 197     Relative Distinguished Name (RDN)
 198 .fi
 199 .LP
 200 One or more blank lines may be used to separate each DN/RDN pair.
 201 .SH EXAMPLE
 202 Assuming that the file
 203 .B /tmp/entrymods
 204 exists and has the contents:
 205 .LP
 206 .nf
 207     cn=Modify Me,dc=example,dc=com
 208     cn=The New Me
 209 .fi
 210 .LP
 211 the command:
 212 .LP
 213 .nf
 214     ldapmodify -r -f /tmp/entrymods
 215 .fi
 216 .LP
 217 will change the RDN of the "Modify Me" entry from "Modify Me" to
 218 "The New Me" and the old cn, "Modify Me" will be removed.
 219 .LP
 220 .SH DIAGNOSTICS
 221 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 222 status and a diagnostic message being written to standard error.
 223 .SH "SEE ALSO"
 224 .BR ldapadd (1),
 225 .BR ldapdelete (1),
 226 .BR ldapmodify (1),
 227 .BR ldapsearch (1),
 228 .BR ldap.conf (5),
 229 .BR ldap (3),
 230 .BR ldap_modrdn2 (3)
 231 .SH AUTHOR
 232 The OpenLDAP Project <http://www.openldap.org/>
 233 .SH ACKNOWLEDGEMENTS
 234 .B OpenLDAP
 235 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 236 .B OpenLDAP
 237 is derived from University of Michigan LDAP 3.3 Release.