git.sur5r.net Git - openldap/blob - doc/man/man1/ldapdelete.1

   1 .TH LDAPDELETE 1 "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldapdelete \- ldap delete entry tool
   4 .SH SYNOPSIS
   5 .B ldapdelete
   6 .B [\-n]
   7 .B [\-v]
   8 .B [\-k]
   9 .B [\-K]
  10 .B [\-c]
  11 .B [\-d debuglevel]
  12 .B [\-f file]
  13 .B [\-D binddn]
  14 .B [\-w passwd]
  15 .B [\-h ldaphost]
  16 .B [\-p ldapport]
  17 .B [dn]...
  18 .SH DESCRIPTION
  19 .I ldapdelete
  20 is a shell-accessible interface to the
  21 .BR ldap_delete (3)
  22 library call.
  23 .LP
  24 .B ldapdelete
  25 opens a connection to an LDAP server, binds, and deletes one or more
  26 entries.  If one or more \fIdn\fP arguments are provided, entries with
  27 those Distinguished Names are deleted.  Each \fIdn\fP should be a
  28 string-represented DN as defined in RFC 1779.  If no \fIdn\fP arguments
  29 are provided, a list of DNs is read from standard input (or from
  30 \fIfile\fP if the -f flag is used).
  31 .SH OPTIONS
  32 .TP
  33 .B \-n
  34 Show what would be done, but don't actually delete entries.  Useful for
  35 debugging in conjunction with -v.
  36 .TP
  37 .B \-v
  38 Use verbose mode, with many diagnostics written to standard output.
  39 .TP
  40 .B \-k
  41 Use Kerberos authentication instead of simple authentication.  It is
  42 assumed that you already have a valid ticket granting ticket. This option
  43 only has effect if
  44 . B ldapdelete
  45 is compiled with KERBEROS defined.
  46 .TP
  47 .B \-K
  48 Same as \-k, but only does step 1 of the kerberos bind.  This is useful
  49 when connecting to a slapd and there is no x500dsa.hostname principal
  50 registered with your kerberos servers.
  51 .TP
  52 .B \-c
  53 Continuous operation mode.  Errors  are  reported,  but
  54 .B ldapdelete
  55 will  continue  with  deletions.   The default is to exit after
  56 reporting an error.
  57 .TP
  58 .B \-d debuglevel
  59 Set the LDAP debugging level to \fIdebuglevel\fP.
  60 .B ldapdelete
  61 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  62 .TP
  63 .B \-f file
  64 Read a series of lines from \fIfile\fP, performing one LDAP search for
  65 each line.  In this case, the \fIfilter\fP given on the command line
  66 is treated as a pattern where the first occurrence of \fB%s\fP is
  67 replaced with a line from \fIfile\fP.
  68 .TP
  69 .B \-D binddn
  70 Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be
  71 a string-represented DN as defined in RFC 1779.
  72 .TP
  73 .B \-w passwd
  74 Use \fIpasswd\fP as the password for simple authentication.
  75 .TP
  76 .B \-h ldaphost
  77 Specify an alternate host on which the ldap server is running.
  78 .TP
  79 .B \-p ldapport
  80 Specify an alternate TCP port where the ldap server is listening.
  81 .SH EXAMPLE
  82 The following command:
  83 .LP
  84 .nf
  85     ldapdelete "cn=Delete Me, o=University of Michigan, c=US"
  86 .fi
  87 .LP
  88 will attempt to delete the entry named with commonName "Delete Me"
  89 directly below the University of Michigan organizational entry.  Of
  90 course it would probably be necessary to supply a \fIbinddn\fP and
  91 \fIpasswd\fP for deletion to be allowed (see the -D and -w options).
  92 .SH DIAGNOSTICS
  93 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
  94 status and a diagnostic message being written to standard error.
  95 .SH "SEE ALSO"
  96 .BR ldapadd (1),
  97 .BR ldapmodify (1),
  98 .BR ldapmodrdn (1),
  99 .BR ldapsearch (1),
 100 .BR ldap (3),
 101 .BR ldap_delete (3)
 102 .LP
 103 Kille, S.,
 104 .IR "A String Representation of Distinguished Names",
 105 .SM RFC
 106 1779,
 107 ISODE Consortium, March 1995.
 108 .SH BUGS
 109 There is no interactive mode, but there probably should be.
 110 .SH ACKNOWLEDGEMENTS
 111 .B      OpenLDAP
 112 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 113 .B      OpenLDAP
 114 is derived from University of Michigan LDAP 3.3 Release.