This manual page is for Mac OS X version 10.6.3

Reading manual pages

LDAPMODRDN(1)                                                                                  LDAPMODRDN(1)



NAME
       ldapmodrdn - LDAP rename entry tool

SYNOPSIS
       ldapmodrdn  [-r]  [-s newsup]  [-n]  [-v]  [-c]  [-M[M]] [-d debuglevel] [-D binddn] [-W] [-w passwd]
       [-y passwdfile] [-H ldapuri] [-h ldaphost] [-p ldapport] [-P 2|3] [-O security-properties] [-I]  [-Q]
       [-U authcid] [-R realm] [-x] [-X authzid] [-Y mech] [-Z[Z]] [-f file] [dn rdn]

DESCRIPTION
       ldapmodrdn is a shell-accessible interface to the ldap_rename(3) library call.

       ldapmodrdn  opens  a connection to an LDAP server, binds, and modifies the RDN of entries.  The entry
       information is read from standard input, from file through the use of the -f option, or from the com-mand-line command-line
       mand-line pair dn and rdn.

OPTIONS
       -r     Remove old RDN values from the entry.  Default is to keep old values.

       -s newsup
              Specify  a  new  superior  entry.  (I.e., move the target entry and make it a child of the new
              superior.)  This option is not supported in LDAPv2.

       -n     Show what would be done, but don't actually change entries.  Useful for debugging in  conjunc-tion conjunction
              tion with -v.

       -v     Use verbose mode, with many diagnostics written to standard output.

       -c     Continuous operation mode.  Errors  are  reported,  but ldapmodrdn will  continue  with  modi-fications. modifications.
              fications.   The default is to exit after reporting an error.

       -M[M]  Enable manage DSA IT control.  -MM makes control critical.

       -d debuglevel
              Set the LDAP debugging level to debuglevel.   ldapmodrdn  must  be  compiled  with  LDAP_DEBUG
              defined for this option to have any effect.

       -f file
              Read  the  entry modification information from file instead of from standard input or the com-mand-line. command-line.
              mand-line.

       -x     Use simple authentication instead of SASL.

       -D binddn
              Use the Distinguished Name binddn to bind to the LDAP directory.

       -W     Prompt for simple authentication.  This is used instead of specifying the password on the com-mand command
              mand line.

       -w passwd
              Use passwd as the password for simple authentication.

       -y passwdfile
              Use complete contents of passwdfile as the password for simple authentication.

       -H ldapuri
              Specify  URI(s)  referring  to  the  ldap  server(s);  only  the protocol/host/port fields are
              allowed; a list of URI, separated by whitespace or commas is expected.

       -h ldaphost
              Specify an alternate host on which the ldap server is running.  Deprecated in favor of -H.

       -p ldapport
              Specify an alternate TCP port where the ldap server is listening.  Deprecated in favor of  -H.

       -P 2|3 Specify the LDAP protocol version to use.

       -O security-properties
              Specify SASL security properties.

       -I     Enable SASL Interactive mode.  Always prompt.  Default is to prompt only as needed.

       -Q     Enable SASL Quiet mode.  Never prompt.

       -U authcid
              Specify  the  authentication  ID  for SASL bind. The form of the ID depends on the actual SASL
              mechanism used.

       -R realm
              Specify the realm of authentication ID for SASL bind. The form of the  realm  depends  on  the
              actual SASL mechanism used.

       -X authzid
              Specify  the  requested  authorization ID for SASL bind.  authzid must be one of the following
              formats: dn:<distinguished name> or u:<username>

       -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.

       -Z[Z]  Issue StartTLS (Transport Layer Security) extended operation. If you use -ZZ, the command will
              require the operation to be successful.

INPUT FORMAT
       If the command-line arguments dn and rdn are given, rdn will replace the RDN of the  entry  specified
       by the DN, dn.

       Otherwise,  the  contents of file (or standard input if no -f flag is given) should consist of one or
       more entries.

           Distinguished Name (DN)
           Relative Distinguished Name (RDN)

       One or more blank lines may be used to separate each DN/RDN pair.

EXAMPLE
       Assuming that the file /tmp/entrymods exists and has the contents:

           cn=Modify Me,dc=example,dc=com
           cn=The New Me

       the command:

           ldapmodrdn -r -f /tmp/entrymods

       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.


DIAGNOSTICS
       Exit  status  is 0 if no errors occur.  Errors result in a non-zero exit status and a diagnostic mes-sage message
       sage being written to standard error.

SEE ALSO
       ldapadd(1), ldapdelete(1), ldapmodify(1), ldapsearch(1), ldap.conf(5), ldap(3), ldap_rename(3)

AUTHOR
       The OpenLDAP Project <http://www.openldap.org/>

ACKNOWLEDGEMENTS
       OpenLDAP Software is developed and maintained by  The  OpenLDAP  Project  <http://www.openldap.org/>.
       OpenLDAP Software is derived from University of Michigan LDAP 3.3 Release.



OpenLDAP 2.4.11                                  2008/07/16                                    LDAPMODRDN(1)