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

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