2001-08-25 04:17:23 +08:00
|
|
|
.TH LDAPMODRDN 1 "20 August 2001" "OpenLDAP LDVERSION"
|
1999-09-12 12:41:47 +08:00
|
|
|
.\" $OpenLDAP$
|
2000-05-13 10:47:56 +08:00
|
|
|
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
|
1999-09-12 12:41:47 +08:00
|
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
1998-08-09 08:43:13 +08:00
|
|
|
.SH NAME
|
1999-08-20 01:02:36 +08:00
|
|
|
ldapmodrdn \- LDAP rename entry tool
|
1998-08-09 08:43:13 +08:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.B ldapmodrdn
|
1998-12-06 12:09:55 +08:00
|
|
|
[\c
|
|
|
|
.BR \-r ]
|
|
|
|
[\c
|
|
|
|
.BR \-n ]
|
|
|
|
[\c
|
|
|
|
.BR \-v ]
|
|
|
|
[\c
|
|
|
|
.BR \-k ]
|
|
|
|
[\c
|
|
|
|
.BR \-K ]
|
|
|
|
[\c
|
|
|
|
.BR \-c ]
|
|
|
|
[\c
|
2000-06-26 04:29:20 +08:00
|
|
|
.BR \-C ]
|
|
|
|
[\c
|
1999-07-16 10:45:46 +08:00
|
|
|
.BR \-M[M] ]
|
|
|
|
[\c
|
1998-12-06 12:09:55 +08:00
|
|
|
.BI \-d \ debuglevel\fR]
|
|
|
|
[\c
|
|
|
|
.BI \-D \ binddn\fR]
|
|
|
|
[\c
|
1998-12-12 13:56:46 +08:00
|
|
|
.BR \-W ]
|
|
|
|
[\c
|
1998-12-06 12:09:55 +08:00
|
|
|
.BI \-w \ passwd\fR]
|
|
|
|
[\c
|
2000-08-25 13:31:59 +08:00
|
|
|
.BI \-H \ ldapuri\fR]
|
|
|
|
[\c
|
1998-12-06 12:09:55 +08:00
|
|
|
.BI \-h \ ldaphost\fR]
|
|
|
|
[\c
|
|
|
|
.BI \-p \ ldapport\fR]
|
|
|
|
[\c
|
1998-12-27 22:08:46 +08:00
|
|
|
.BI \-P \ 2\fR\||\|\fI3\fR]
|
|
|
|
[\c
|
2000-07-14 06:54:45 +08:00
|
|
|
.BR \-O \ security-properties ]
|
2000-04-20 17:23:51 +08:00
|
|
|
[\c
|
2000-07-17 10:43:41 +08:00
|
|
|
.BR \-I ]
|
|
|
|
[\c
|
|
|
|
.BR \-Q ]
|
|
|
|
[\c
|
2001-01-18 16:04:56 +08:00
|
|
|
.BI \-U \ authcid\fR]
|
2000-04-20 17:23:51 +08:00
|
|
|
[\c
|
2000-07-16 08:52:04 +08:00
|
|
|
.BR \-x ]
|
|
|
|
[\c
|
2000-04-20 17:23:51 +08:00
|
|
|
.BI \-X \ authzid\fR]
|
|
|
|
[\c
|
|
|
|
.BI \-Y \ mech\fR]
|
|
|
|
[\c
|
|
|
|
.BR \-Z[Z] ]
|
|
|
|
[\c
|
1998-12-06 12:09:55 +08:00
|
|
|
.BI \-f \ file\fR]
|
|
|
|
[\c
|
|
|
|
.I dn rdn\fR]
|
1998-08-09 08:43:13 +08:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.B ldapmodrdn
|
|
|
|
is a shell-accessible interface to the
|
|
|
|
.BR ldap_modrdn2 (3)
|
|
|
|
library call.
|
|
|
|
.LP
|
|
|
|
.B ldapmodrdn
|
|
|
|
opens a connection to an LDAP server, binds, and modifies the RDN of entries.
|
|
|
|
The entry information is read from standard input, from \fIfile\fP through
|
|
|
|
the use of the
|
|
|
|
.RI \- f
|
|
|
|
option, or from the command-line pair \fIdn\fP and
|
|
|
|
\fIrdn\fP.
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
|
|
.B \-r
|
|
|
|
Remove old RDN values from the entry. Default is to keep old values.
|
|
|
|
.TP
|
|
|
|
.B \-n
|
|
|
|
Show what would be done, but don't actually change entries. Useful for
|
|
|
|
debugging in conjunction with -v.
|
|
|
|
.TP
|
|
|
|
.B \-v
|
|
|
|
Use verbose mode, with many diagnostics written to standard output.
|
|
|
|
.TP
|
|
|
|
.B \-k
|
2001-08-25 04:17:23 +08:00
|
|
|
Use Kerberos IV authentication instead of simple authentication. It is
|
1998-08-09 08:43:13 +08:00
|
|
|
assumed that you already have a valid ticket granting ticket.
|
|
|
|
.B ldapmodrdn
|
2000-08-29 06:49:44 +08:00
|
|
|
must be compiled with Kerberos support for this option to have effect.
|
1998-08-09 08:43:13 +08:00
|
|
|
.TP
|
|
|
|
.B \-K
|
2001-08-25 04:17:23 +08:00
|
|
|
Same as \-k, but only does step 1 of the Kerberos IV bind. This is useful
|
1998-08-09 08:43:13 +08:00
|
|
|
when connecting to a slapd and there is no x500dsa.hostname principal
|
2001-08-25 04:17:23 +08:00
|
|
|
registered with your Kerberos Domain Controller(s).
|
1998-08-09 08:43:13 +08:00
|
|
|
.TP
|
2000-06-26 04:29:20 +08:00
|
|
|
.B \-C
|
|
|
|
Automatically chase referrals.
|
|
|
|
.TP
|
1998-08-09 08:43:13 +08:00
|
|
|
.B \-c
|
|
|
|
Continuous operation mode. Errors are reported, but ldapmodify
|
|
|
|
will continue with modifications. The default is to exit after
|
|
|
|
reporting an error.
|
|
|
|
.TP
|
1999-07-16 10:45:46 +08:00
|
|
|
.B \-M[M]
|
|
|
|
Enable manage DSA IT control.
|
|
|
|
.B \-MM
|
|
|
|
makes control critical.
|
|
|
|
.TP
|
1998-08-09 08:43:13 +08:00
|
|
|
.B \-d debuglevel
|
|
|
|
Set the LDAP debugging level to \fIdebuglevel\fP.
|
|
|
|
.B ldapmodrdn
|
|
|
|
must be
|
|
|
|
compiled with LDAP_DEBUG defined for this option to have any effect.
|
|
|
|
.TP
|
|
|
|
.B \-f file
|
|
|
|
Read the entry modification information from \fIfile\fP instead of from
|
|
|
|
standard input or the command-line.
|
|
|
|
.TP
|
2000-07-16 08:52:04 +08:00
|
|
|
.B \-x
|
|
|
|
Use simple authentication instead of SASL.
|
|
|
|
.TP
|
1998-08-09 08:43:13 +08:00
|
|
|
.B \-D binddn
|
2000-08-20 14:21:38 +08:00
|
|
|
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
|
1998-08-09 08:43:13 +08:00
|
|
|
.TP
|
1998-12-12 13:56:46 +08:00
|
|
|
.B \-W
|
|
|
|
Prompt for simple authentication.
|
|
|
|
This is used instead of specifying the password on the command line.
|
|
|
|
.TP
|
1998-08-09 08:43:13 +08:00
|
|
|
.B \-w passwd
|
|
|
|
Use \fIpasswd\fP as the password for simple authentication.
|
|
|
|
.TP
|
2000-08-25 13:31:59 +08:00
|
|
|
.BI \-H \ ldapuri
|
|
|
|
Specify URI(s) referring to the ldap server(s).
|
|
|
|
.TP
|
|
|
|
.BI \-h \ ldaphost
|
1998-08-09 08:43:13 +08:00
|
|
|
Specify an alternate host on which the ldap server is running.
|
2000-08-25 13:31:59 +08:00
|
|
|
Deprecated in favor of -H.
|
1998-08-09 08:43:13 +08:00
|
|
|
.TP
|
2000-08-25 13:31:59 +08:00
|
|
|
.BI \-p \ ldapport
|
1998-08-09 08:43:13 +08:00
|
|
|
Specify an alternate TCP port where the ldap server is listening.
|
2000-08-25 13:31:59 +08:00
|
|
|
Deprecated in favor of -H.
|
1998-12-27 22:08:46 +08:00
|
|
|
.TP
|
|
|
|
.BI \-P \ 2\fR\||\|\fI3
|
|
|
|
Specify the LDAP protocol version to use.
|
2000-04-20 17:23:51 +08:00
|
|
|
.TP
|
2000-07-14 06:54:45 +08:00
|
|
|
.BI \-O \ security-properties
|
|
|
|
Specify SASL security properties.
|
2000-04-20 17:23:51 +08:00
|
|
|
.TP
|
2000-07-17 10:43:41 +08:00
|
|
|
.B \-I
|
|
|
|
Enable SASL Interactive mode. Always prompt. Default is to prompt
|
|
|
|
only as needed.
|
|
|
|
.TP
|
|
|
|
.B \-Q
|
|
|
|
Enable SASL Quiet mode. Never prompt.
|
|
|
|
.TP
|
2001-01-18 16:04:56 +08:00
|
|
|
.BI \-U \ authcid
|
|
|
|
Specify the authentication ID for SASL bind. The form of the ID
|
|
|
|
depends on the actual SASL mechanism used.
|
2000-04-20 17:23:51 +08:00
|
|
|
.TP
|
|
|
|
.BI \-X \ authzid
|
|
|
|
Specify the requested authorization ID for SASL bind.
|
|
|
|
.I authzid
|
|
|
|
must be one of the following formats:
|
|
|
|
.B dn:\c
|
|
|
|
.I <distinguished name>
|
|
|
|
or
|
|
|
|
.B u:\c
|
|
|
|
.I <username>
|
|
|
|
.TP
|
|
|
|
.BI \-Y \ mech
|
|
|
|
Specify the SASL mechanism to be used for authentication. If it's not
|
|
|
|
specified, the program will choose the best mechanism the server knows.
|
|
|
|
.TP
|
|
|
|
.B \-Z[Z]
|
2000-06-14 10:35:42 +08:00
|
|
|
Issue StartTLS (Transport Layer Security) extended operation. If you use
|
2000-04-20 17:23:51 +08:00
|
|
|
.B \-ZZ\c
|
2000-06-14 10:35:42 +08:00
|
|
|
, the command will require the operation to be successful.
|
1998-08-09 08:43:13 +08:00
|
|
|
.SH INPUT FORMAT
|
|
|
|
If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
|
|
|
|
will replace the RDN of the entry specified by the DN, \fIdn\fP.
|
|
|
|
.LP
|
|
|
|
Otherwise, the contents of \fIfile\fP (or standard input if
|
|
|
|
no
|
|
|
|
.RI \- f
|
|
|
|
flag is given) should consist of one or more entries.
|
|
|
|
.LP
|
|
|
|
.nf
|
|
|
|
Distinguished Name (DN)
|
|
|
|
Relative Distinguished Name (RDN)
|
|
|
|
.fi
|
|
|
|
.LP
|
|
|
|
One or more blank lines may be used to separate each DN/RDN pair.
|
|
|
|
.SH EXAMPLE
|
|
|
|
Assuming that the file
|
|
|
|
.B /tmp/entrymods
|
|
|
|
exists and has the contents:
|
|
|
|
.LP
|
|
|
|
.nf
|
2001-09-04 10:41:53 +08:00
|
|
|
cn=Modify Me,dc=example,dc=com
|
1998-08-09 08:43:13 +08:00
|
|
|
cn=The New Me
|
|
|
|
.fi
|
|
|
|
.LP
|
|
|
|
the command:
|
|
|
|
.LP
|
|
|
|
.nf
|
|
|
|
ldapmodify -r -f /tmp/entrymods
|
|
|
|
.fi
|
|
|
|
.LP
|
|
|
|
will change the RDN of the "Modify Me" entry from "Modify Me" to
|
|
|
|
"The New Me" and the old cn, "Modify Me" will be removed.
|
|
|
|
.LP
|
|
|
|
.SH DIAGNOSTICS
|
|
|
|
Exit status is 0 if no errors occur. Errors result in a non-zero exit
|
|
|
|
status and a diagnostic message being written to standard error.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR ldapadd (1),
|
|
|
|
.BR ldapdelete (1),
|
|
|
|
.BR ldapmodify (1),
|
|
|
|
.BR ldapsearch (1),
|
1998-11-11 07:37:30 +08:00
|
|
|
.BR ldap.conf (5),
|
1998-08-09 08:43:13 +08:00
|
|
|
.BR ldap (3),
|
|
|
|
.BR ldap_modrdn2 (3)
|
2000-07-14 06:54:45 +08:00
|
|
|
.SH AUTHOR
|
|
|
|
The OpenLDAP Project <http://www.openldap.org/>
|
1998-10-25 09:41:42 +08:00
|
|
|
.SH ACKNOWLEDGEMENTS
|
|
|
|
.B OpenLDAP
|
|
|
|
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
|
|
|
|
.B OpenLDAP
|
|
|
|
is derived from University of Michigan LDAP 3.3 Release.
|