external/bsd/openldap/man/ldapmodrdn.1

   1 .TH LDAPMODRDN 1 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapmodrdn.1,v 1.38.2.4 2008/02/11 23:26:39 kurt Exp $
   3 .\" Copyright 1998-2008 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 .BI \-s \ newsup\fR]
  13 [\c
  14 .BR \-n ]
  15 [\c
  16 .BR \-v ]
  17 [\c
  18 .BR \-c ]
  19 [\c
  20 .BR \-M[M] ]
  21 [\c
  22 .BI \-d \ debuglevel\fR]
  23 [\c
  24 .BI \-D \ binddn\fR]
  25 [\c
  26 .BR \-W ]
  27 [\c
  28 .BI \-w \ passwd\fR]
  29 [\c
  30 .BI \-y \ passwdfile\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 .BI \-R \ realm\fR]
  49 [\c
  50 .BR \-x ]
  51 [\c
  52 .BI \-X \ authzid\fR]
  53 [\c
  54 .BI \-Y \ mech\fR]
  55 [\c
  56 .BR \-Z[Z] ]
  57 [\c
  58 .BI \-f \ file\fR]
  59 [\c
  60 .I dn  rdn\fR]
  61 .SH DESCRIPTION
  62 .B ldapmodrdn
  63 is a shell-accessible interface to the
  64 .BR ldap_rename (3)
  65 library call.
  66 .LP
  67 .B ldapmodrdn
  68 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
  69 The entry information is read from standard input, from \fIfile\fP through
  70 the use of the
  71 .RI \- f
  72 option, or from the command-line pair \fIdn\fP and
  73 \fIrdn\fP.
  74 .SH OPTIONS
  75 .TP
  76 .B \-r
  77 Remove old RDN values from the entry.  Default is to keep old values.
  78 .TP
  79 .BI \-s \ newsup
  80 Specify a new superior entry. (I.e., move the target entry and make it a
  81 child of the new superior.)  This option is not supported in LDAPv2.
  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 \-c
  91 Continuous operation mode.  Errors  are  reported,  but ldapmodrdn
  92 will  continue  with  modifications.   The default is to exit after
  93 reporting an error.
  94 .TP
  95 .B \-M[M]
  96 Enable manage DSA IT control.
  97 .B \-MM
  98 makes control critical.
  99 .TP
 100 .B \-d debuglevel
 101 Set the LDAP debugging level to \fIdebuglevel\fP.
 102 .B ldapmodrdn
 103 must be
 104 compiled with LDAP_DEBUG defined for this option to have any effect.
 105 .TP
 106 .B \-f file
 107 Read the entry modification information from \fIfile\fP instead of from
 108 standard input or the command-line.
 109 .TP
 110 .B \-x
 111 Use simple authentication instead of SASL.
 112 .TP
 113 .B \-D binddn
 114 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 115 .TP
 116 .B \-W
 117 Prompt for simple authentication.
 118 This is used instead of specifying the password on the command line.
 119 .TP
 120 .B \-w passwd
 121 Use \fIpasswd\fP as the password for simple authentication.
 122 .TP
 123 .BI \-y \ passwdfile
 124 Use complete contents of \fIpasswdfile\fP as the password for
 125 simple authentication.
 126 .TP
 127 .BI \-H \ ldapuri
 128 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 129 fields are allowed; a list of URI, separated by whitespace or commas
 130 is expected.
 131 .TP
 132 .BI \-h \ ldaphost
 133 Specify an alternate host on which the ldap server is running.
 134 Deprecated in favor of -H.
 135 .TP
 136 .BI \-p \ ldapport
 137 Specify an alternate TCP port where the ldap server is listening.
 138 Deprecated in favor of -H.
 139 .TP
 140 .BI \-P \ 2\fR\||\|\fI3
 141 Specify the LDAP protocol version to use.
 142 .TP
 143 .BI \-O \ security-properties
 144 Specify SASL security properties.
 145 .TP
 146 .B \-I
 147 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 148 only as needed.
 149 .TP
 150 .B \-Q
 151 Enable SASL Quiet mode.  Never prompt.
 152 .TP
 153 .BI \-U \ authcid
 154 Specify the authentication ID for SASL bind. The form of the ID
 155 depends on the actual SASL mechanism used.
 156 .TP
 157 .BI \-R \ realm
 158 Specify the realm of authentication ID for SASL bind. The form of the realm
 159 depends on the actual SASL mechanism used.
 160 .TP
 161 .BI \-X \ authzid
 162 Specify the requested authorization ID for SASL bind.
 163 .I authzid
 164 must be one of the following formats:
 165 .B dn:\c
 166 .I <distinguished name>
 167 or
 168 .B u:\c
 169 .I <username>
 170 .TP
 171 .BI \-Y \ mech
 172 Specify the SASL mechanism to be used for authentication. If it's not
 173 specified, the program will choose the best mechanism the server knows.
 174 .TP
 175 .B \-Z[Z]
 176 Issue StartTLS (Transport Layer Security) extended operation. If you use
 177 .B \-ZZ\c
 178 , the command will require the operation to be successful.
 179 .SH INPUT FORMAT
 180 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 181 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 182 .LP
 183 Otherwise, the contents of \fIfile\fP (or standard input if
 184 no
 185 .RI \- f
 186 flag is given) should consist of one or more entries.
 187 .LP
 188 .nf
 189     Distinguished Name (DN)
 190     Relative Distinguished Name (RDN)
 191 .fi
 192 .LP
 193 One or more blank lines may be used to separate each DN/RDN pair.
 194 .SH EXAMPLE
 195 Assuming that the file
 196 .B /tmp/entrymods
 197 exists and has the contents:
 198 .LP
 199 .nf
 200     cn=Modify Me,dc=example,dc=com
 201     cn=The New Me
 202 .fi
 203 .LP
 204 the command:
 205 .LP
 206 .nf
 207     ldapmodrdn -r -f /tmp/entrymods
 208 .fi
 209 .LP
 210 will change the RDN of the "Modify Me" entry from "Modify Me" to
 211 "The New Me" and the old cn, "Modify Me" will be removed.
 212 .LP
 213 .SH DIAGNOSTICS
 214 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 215 status and a diagnostic message being written to standard error.
 216 .SH "SEE ALSO"
 217 .BR ldapadd (1),
 218 .BR ldapdelete (1),
 219 .BR ldapmodify (1),
 220 .BR ldapsearch (1),
 221 .BR ldap.conf (5),
 222 .BR ldap (3),
 223 .BR ldap_rename (3)
 224 .SH AUTHOR
 225 The OpenLDAP Project <http://www.openldap.org/>
 226 .SH ACKNOWLEDGEMENTS
 227 .\" Shared Project Acknowledgement Text
 228 .B "OpenLDAP Software"
 229 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
 230 .B "OpenLDAP Software"
 231 is derived from University of Michigan LDAP 3.3 Release.