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

   1 .TH LDAPMODRDN 1 "10 November 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldapmodrdn \- ldap modify entry RDN tool
   4 .SH SYNOPSIS
   5 .B ldapmodrdn
   6 [\c
   7 .BR \-r ]
   8 [\c
   9 .BR \-n ]
  10 [\c
  11 .BR \-v ]
  12 [\c
  13 .BR \-k ]
  14 [\c
  15 .BR \-K ]
  16 [\c
  17 .BR \-c ]
  18 [\c
  19 .BR \-M[M] ]
  20 [\c
  21 .BI \-d \ debuglevel\fR]
  22 [\c
  23 .BI \-D \ binddn\fR]
  24 [\c
  25 .BR \-W ]
  26 [\c
  27 .BI \-w \ passwd\fR]
  28 [\c
  29 .BI \-h \ ldaphost\fR]
  30 [\c
  31 .BI \-p \ ldapport\fR]
  32 [\c
  33 .BI \-P \ 2\fR\||\|\fI3\fR]
  34 [\c
  35 .BI \-f \ file\fR]
  36 [\c
  37 .I dn  rdn\fR]
  38 .SH DESCRIPTION
  39 .B ldapmodrdn
  40 is a shell-accessible interface to the
  41 .BR ldap_modrdn2 (3)
  42 library call.
  43 .LP
  44 .B ldapmodrdn
  45 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
  46 The entry information is read from standard input, from \fIfile\fP through
  47 the use of the
  48 .RI \- f
  49 option, or from the command-line pair \fIdn\fP and
  50 \fIrdn\fP.
  51 .SH OPTIONS
  52 .TP
  53 .B \-r
  54 Remove old RDN values from the entry.  Default is to keep old values.
  55 .TP
  56 .B \-n
  57 Show what would be done, but don't actually change entries.  Useful for
  58 debugging in conjunction with -v.
  59 .TP
  60 .B \-v
  61 Use verbose mode, with many diagnostics written to standard output.
  62 .TP
  63 .B \-k
  64 Use Kerberos authentication instead of simple authentication.  It is
  65 assumed that you already have a valid ticket granting ticket.
  66 .B ldapmodrdn
  67 must be compiled with KERBEROS defined for this option to have effect.
  68 .TP
  69 .B \-K
  70 Same as \-k, but only does step 1 of the kerberos bind.  This is useful
  71 when connecting to a slapd and there is no x500dsa.hostname principal
  72 registered with your kerberos servers.
  73 .TP
  74 .B \-c
  75 Continuous operation mode.  Errors  are  reported,  but ldapmodify
  76 will  continue  with  modifications.   The default is to exit after
  77 reporting an error.
  78 .TP
  79 .B \-M[M]
  80 Enable manage DSA IT control.
  81 .B \-MM
  82 makes control critical.
  83 .TP
  84 .B \-d debuglevel
  85 Set the LDAP debugging level to \fIdebuglevel\fP.
  86 .B ldapmodrdn
  87 must be
  88 compiled with LDAP_DEBUG defined for this option to have any effect.
  89 .TP
  90 .B \-f file
  91 Read the entry modification information from \fIfile\fP instead of from
  92 standard input or the command-line.
  93 .TP
  94 .B \-D binddn
  95 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
  96 a string-represented DN as defined in RFC 1779.
  97 .TP
  98 .B \-W
  99 Prompt for simple authentication.
 100 This is used instead of specifying the password on the command line.
 101 .TP
 102 .B \-w passwd
 103 Use \fIpasswd\fP as the password for simple authentication.
 104 .TP
 105 .B \-h ldaphost
 106 Specify an alternate host on which the ldap server is running.
 107 .TP
 108 .B \-p ldapport
 109 Specify an alternate TCP port where the ldap server is listening.
 110 .TP
 111 .BI \-P \ 2\fR\||\|\fI3
 112 Specify the LDAP protocol version to use.
 113 .SH INPUT FORMAT
 114 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 115 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 116 .LP
 117 Otherwise, the contents of \fIfile\fP (or standard input if
 118 no
 119 .RI \- f
 120 flag is given) should consist of one or more entries.
 121 .LP
 122 .nf
 123     Distinguished Name (DN)
 124     Relative Distinguished Name (RDN)
 125 .fi
 126 .LP
 127 One or more blank lines may be used to separate each DN/RDN pair.
 128 .SH EXAMPLE
 129 Assuming that the file
 130 .B /tmp/entrymods
 131 exists and has the contents:
 132 .LP
 133 .nf
 134     cn=Modify Me, o=University of Michigan, c=US
 135     cn=The New Me
 136 .fi
 137 .LP
 138 the command:
 139 .LP
 140 .nf
 141     ldapmodify -r -f /tmp/entrymods
 142 .fi
 143 .LP
 144 will change the RDN of the "Modify Me" entry from "Modify Me" to
 145 "The New Me" and the old cn, "Modify Me" will be removed.
 146 .LP
 147 .SH DIAGNOSTICS
 148 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 149 status and a diagnostic message being written to standard error.
 150 .SH "SEE ALSO"
 151 .BR ldapadd (1),
 152 .BR ldapdelete (1),
 153 .BR ldapmodify (1),
 154 .BR ldapsearch (1),
 155 .BR ldap.conf (5),
 156 .BR ldap (3),
 157 .BR ldap_modrdn2 (3)
 158 .LP
 159 Kille, S.,
 160 .IR "A String Representation of Distinguished Names",
 161 .SM RFC
 162 1779,
 163 ISODE Consortium, March 1995.
 164 .SH BUGS
 165 There is no interactive mode, but there probably should be.
 166 .SH ACKNOWLEDGEMENTS
 167 .B      OpenLDAP
 168 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 169 .B      OpenLDAP
 170 is derived from University of Michigan LDAP 3.3 Release.