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