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

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