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

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