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