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