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

   1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 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 \-C ]
  23 [\c
  24 .BR \-M[M] ]
  25 [\c
  26 .BI \-d \ debuglevel\fR]
  27 [\c
  28 .BI \-D \ binddn\fR]
  29 [\c
  30 .BR \-W ]
  31 [\c
  32 .BI \-w \ passwd\fR]
  33 [\c
  34 .BI \-y \ passwdfile\fR]
  35 [\c
  36 .BI \-H \ ldapuri\fR]
  37 [\c
  38 .BI \-h \ ldaphost\fR]
  39 [\c
  40 .BI \-p \ ldapport\fR]
  41 [\c
  42 .BI \-P \ 2\fR\||\|\fI3\fR]
  43 [\c
  44 .BR \-O \ security-properties ]
  45 [\c
  46 .BR \-I ]
  47 [\c
  48 .BR \-Q ]
  49 [\c
  50 .BI \-U \ authcid\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 Automatically chase referrals.
 101 .TP
 102 .B \-c
 103 Continuous operation mode.  Errors  are  reported,  but ldapmodify
 104 will  continue  with  modifications.   The default is to exit after
 105 reporting an error.
 106 .TP
 107 .B \-M[M]
 108 Enable manage DSA IT control.
 109 .B \-MM
 110 makes control critical.
 111 .TP
 112 .B \-d debuglevel
 113 Set the LDAP debugging level to \fIdebuglevel\fP.
 114 .B ldapmodrdn
 115 must be
 116 compiled with LDAP_DEBUG defined for this option to have any effect.
 117 .TP
 118 .B \-f file
 119 Read the entry modification information from \fIfile\fP instead of from
 120 standard input or the command-line.
 121 .TP
 122 .B \-x
 123 Use simple authentication instead of SASL.
 124 .TP
 125 .B \-D binddn
 126 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 127 .TP
 128 .B \-W
 129 Prompt for simple authentication.
 130 This is used instead of specifying the password on the command line.
 131 .TP
 132 .B \-w passwd
 133 Use \fIpasswd\fP as the password for simple authentication.
 134 .TP
 135 .BI \-y \ passwdfile
 136 Use complete contents of \fIpasswdfile\fP as the password for
 137 simple authentication.
 138 .TP
 139 .BI \-H \ ldapuri
 140 Specify URI(s) referring to the ldap server(s).
 141 .TP
 142 .BI \-h \ ldaphost
 143 Specify an alternate host on which the ldap server is running.
 144 Deprecated in favor of -H.
 145 .TP
 146 .BI \-p \ ldapport
 147 Specify an alternate TCP port where the ldap server is listening.
 148 Deprecated in favor of -H.
 149 .TP
 150 .BI \-P \ 2\fR\||\|\fI3
 151 Specify the LDAP protocol version to use.
 152 .TP
 153 .BI \-O \ security-properties
 154 Specify SASL security properties.
 155 .TP
 156 .B \-I
 157 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 158 only as needed.
 159 .TP
 160 .B \-Q
 161 Enable SASL Quiet mode.  Never prompt.
 162 .TP
 163 .BI \-U \ authcid
 164 Specify the authentication ID for SASL bind. The form of the ID
 165 depends on the actual SASL mechanism used.
 166 .TP
 167 .BI \-X \ authzid
 168 Specify the requested authorization ID for SASL bind.
 169 .I authzid
 170 must be one of the following formats:
 171 .B dn:\c
 172 .I <distinguished name>
 173 or
 174 .B u:\c
 175 .I <username>
 176 .TP
 177 .BI \-Y \ mech
 178 Specify the SASL mechanism to be used for authentication. If it's not
 179 specified, the program will choose the best mechanism the server knows.
 180 .TP
 181 .B \-Z[Z]
 182 Issue StartTLS (Transport Layer Security) extended operation. If you use
 183 .B \-ZZ\c
 184 , the command will require the operation to be successful.
 185 .SH INPUT FORMAT
 186 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 187 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 188 .LP
 189 Otherwise, the contents of \fIfile\fP (or standard input if
 190 no
 191 .RI \- f
 192 flag is given) should consist of one or more entries.
 193 .LP
 194 .nf
 195     Distinguished Name (DN)
 196     Relative Distinguished Name (RDN)
 197 .fi
 198 .LP
 199 One or more blank lines may be used to separate each DN/RDN pair.
 200 .SH EXAMPLE
 201 Assuming that the file
 202 .B /tmp/entrymods
 203 exists and has the contents:
 204 .LP
 205 .nf
 206     cn=Modify Me,dc=example,dc=com
 207     cn=The New Me
 208 .fi
 209 .LP
 210 the command:
 211 .LP
 212 .nf
 213     ldapmodify -r -f /tmp/entrymods
 214 .fi
 215 .LP
 216 will change the RDN of the "Modify Me" entry from "Modify Me" to
 217 "The New Me" and the old cn, "Modify Me" will be removed.
 218 .LP
 219 .SH DIAGNOSTICS
 220 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 221 status and a diagnostic message being written to standard error.
 222 .SH "SEE ALSO"
 223 .BR ldapadd (1),
 224 .BR ldapdelete (1),
 225 .BR ldapmodify (1),
 226 .BR ldapsearch (1),
 227 .BR ldap.conf (5),
 228 .BR ldap (3),
 229 .BR ldap_modrdn2 (3)
 230 .SH AUTHOR
 231 The OpenLDAP Project <http://www.openldap.org/>
 232 .SH ACKNOWLEDGEMENTS
 233 .B      OpenLDAP
 234 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 235 .B      OpenLDAP
 236 is derived from University of Michigan LDAP 3.3 Release.