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