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

   1 .TH LDAPMODRDN 1 "17 August 1999" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-1999 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 \-h \ ldaphost\fR]
  33 [\c
  34 .BI \-p \ ldapport\fR]
  35 [\c
  36 .BI \-P \ 2\fR\||\|\fI3\fR]
  37 [\c
  38 .BR \-E[E] ]
  39 [\c
  40 .BR \-I[I] ]
  41 [\c
  42 .BI \-U \ username\fR]
  43 [\c
  44 .BI \-X \ authzid\fR]
  45 [\c
  46 .BI \-Y \ mech\fR]
  47 [\c
  48 .BR \-Z[Z] ]
  49 [\c
  50 .BI \-f \ file\fR]
  51 [\c
  52 .I dn  rdn\fR]
  53 .SH DESCRIPTION
  54 .B ldapmodrdn
  55 is a shell-accessible interface to the
  56 .BR ldap_modrdn2 (3)
  57 library call.
  58 .LP
  59 .B ldapmodrdn
  60 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
  61 The entry information is read from standard input, from \fIfile\fP through
  62 the use of the
  63 .RI \- f
  64 option, or from the command-line pair \fIdn\fP and
  65 \fIrdn\fP.
  66 .SH OPTIONS
  67 .TP
  68 .B \-r
  69 Remove old RDN values from the entry.  Default is to keep old values.
  70 .TP
  71 .B \-n
  72 Show what would be done, but don't actually change entries.  Useful for
  73 debugging in conjunction with -v.
  74 .TP
  75 .B \-v
  76 Use verbose mode, with many diagnostics written to standard output.
  77 .TP
  78 .B \-k
  79 Use Kerberos authentication instead of simple authentication.  It is
  80 assumed that you already have a valid ticket granting ticket.
  81 .B ldapmodrdn
  82 must be compiled with KERBEROS defined for this option to have effect.
  83 .TP
  84 .B \-K
  85 Same as \-k, but only does step 1 of the kerberos bind.  This is useful
  86 when connecting to a slapd and there is no x500dsa.hostname principal
  87 registered with your kerberos servers.
  88 .TP
  89 .B \-c
  90 Continuous operation mode.  Errors  are  reported,  but ldapmodify
  91 will  continue  with  modifications.   The default is to exit after
  92 reporting an error.
  93 .TP
  94 .B \-M[M]
  95 Enable manage DSA IT control.
  96 .B \-MM
  97 makes control critical.
  98 .TP
  99 .B \-d debuglevel
 100 Set the LDAP debugging level to \fIdebuglevel\fP.
 101 .B ldapmodrdn
 102 must be
 103 compiled with LDAP_DEBUG defined for this option to have any effect.
 104 .TP
 105 .B \-f file
 106 Read the entry modification information from \fIfile\fP instead of from
 107 standard input or the command-line.
 108 .TP
 109 .B \-D binddn
 110 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
 111 a string-represented DN as defined in RFC 1779.
 112 .TP
 113 .B \-W
 114 Prompt for simple authentication.
 115 This is used instead of specifying the password on the command line.
 116 .TP
 117 .B \-w passwd
 118 Use \fIpasswd\fP as the password for simple authentication.
 119 .TP
 120 .B \-h ldaphost
 121 Specify an alternate host on which the ldap server is running.
 122 .TP
 123 .B \-p ldapport
 124 Specify an alternate TCP port where the ldap server is listening.
 125 .TP
 126 .BI \-P \ 2\fR\||\|\fI3
 127 Specify the LDAP protocol version to use.
 128 .TP
 129 .B \-E[E]
 130 Requset the use of SASL privacy (encryption). If the server allows it, data
 131 sent between the client and the server will be encrypted. If the server
 132 requires the use of encryption and this flag is not specified, the command
 133 will fail. If you use
 134 .B \-EE\c
 135 , the command will fail if the server does not support encryption.
 136 .B \-E[E]
 137 implies
 138 .B \-I[I]
 139 .TP
 140 .B \-I[I]
 141 Request the use of SASL integrity checking. It protects data sent between the
 142 client and the server from being modified along the way, but it does not
 143 prevent sniffing. If the server requires the use of integrity checking and
 144 this flag is not specified, the command will fail.If you use
 145 .B \-II\c
 146 , the command will fail if the server does not support this function.
 147 .TP
 148 .BI \-U \ username
 149 Specify the username for SASL bind. The syntax of the username depends on the
 150 actual SASL mechanism used.
 151 .TP
 152 .BI \-X \ authzid
 153 Specify the requested authorization ID for SASL bind.
 154 .I authzid
 155 must be one of the following formats:
 156 .B dn:\c
 157 .I <distinguished name>
 158 or
 159 .B u:\c
 160 .I <username>
 161 .TP
 162 .BI \-Y \ mech
 163 Specify the SASL mechanism to be used for authentication. If it's not
 164 specified, the program will choose the best mechanism the server knows.
 165 .TP
 166 .B \-Z[Z]
 167 Request the use of TLS (Transport Layer Security). If you use
 168 .B \-ZZ\c
 169 , the command will fail if TLS negotiation does not succeed for some reason.
 170 .SH INPUT FORMAT
 171 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 172 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 173 .LP
 174 Otherwise, the contents of \fIfile\fP (or standard input if
 175 no
 176 .RI \- f
 177 flag is given) should consist of one or more entries.
 178 .LP
 179 .nf
 180     Distinguished Name (DN)
 181     Relative Distinguished Name (RDN)
 182 .fi
 183 .LP
 184 One or more blank lines may be used to separate each DN/RDN pair.
 185 .SH EXAMPLE
 186 Assuming that the file
 187 .B /tmp/entrymods
 188 exists and has the contents:
 189 .LP
 190 .nf
 191     cn=Modify Me, dc=OpenLDAP, dc=org
 192     cn=The New Me
 193 .fi
 194 .LP
 195 the command:
 196 .LP
 197 .nf
 198     ldapmodify -r -f /tmp/entrymods
 199 .fi
 200 .LP
 201 will change the RDN of the "Modify Me" entry from "Modify Me" to
 202 "The New Me" and the old cn, "Modify Me" will be removed.
 203 .LP
 204 .SH DIAGNOSTICS
 205 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 206 status and a diagnostic message being written to standard error.
 207 .SH "SEE ALSO"
 208 .BR ldapadd (1),
 209 .BR ldapdelete (1),
 210 .BR ldapmodify (1),
 211 .BR ldapsearch (1),
 212 .BR ldap.conf (5),
 213 .BR ldap (3),
 214 .BR ldap_modrdn2 (3)
 215 .LP
 216 Kille, S.,
 217 .IR "A String Representation of Distinguished Names",
 218 .SM RFC
 219 1779,
 220 ISODE Consortium, March 1995.
 221 .SH BUGS
 222 There is no interactive mode, but there probably should be.
 223 .SH ACKNOWLEDGEMENTS
 224 .B      OpenLDAP
 225 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 226 .B      OpenLDAP
 227 is derived from University of Michigan LDAP 3.3 Release.