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