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

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