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