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