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

   1 .TH LDAPDELETE 1 "20 August 2001" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapdelete \- LDAP delete entry tool
   7 .SH SYNOPSIS
   8 .B ldapdelete
   9 [\c
  10 .BR \-n ]
  11 [\c
  12 .BR \-v ]
  13 [\c
  14 .BR \-k ]
  15 [\c
  16 .BR \-K ]
  17 [\c
  18 .BR \-c ]
  19 [\c
  20 .BR \-C ]
  21 [\c
  22 .BR \-M[M] ]
  23 [\c
  24 .BI \-d \ debuglevel\fR]
  25 [\c
  26 .BI \-f \ file\fR]
  27 [\c
  28 .BI \-D \ binddn\fR]
  29 [\c
  30 .BR \-W ]
  31 [\c
  32 .BI \-w \ passwd\fR]
  33 [\c
  34 .BI \-H \ ldapuri\fR]
  35 [\c
  36 .BI \-h \ ldaphost\fR]
  37 [\c
  38 .BI \-P \ 2\fR\||\|\fI3\fR]
  39 [\c
  40 .BI \-p \ ldapport\fR]
  41 [\c
  42 .BR \-O \ security-properties ]
  43 [\c
  44 .BI \-U \ authcid\fR]
  45 [\c
  46 .BR \-x ]
  47 [\c
  48 .BR \-I ]
  49 [\c
  50 .BR \-Q ]
  51 [\c
  52 .BI \-X \ authzid\fR]
  53 [\c
  54 .BI \-Y \ mech\fR]
  55 [\c
  56 .BR \-Z[Z] ]
  57 [\c
  58 .IR dn ]...
  59 .SH DESCRIPTION
  60 .I ldapdelete
  61 is a shell-accessible interface to the
  62 .BR ldap_delete (3)
  63 library call.
  64 .LP
  65 .B ldapdelete
  66 opens a connection to an LDAP server, binds, and deletes one or more
  67 entries.  If one or more \fIDN\fP arguments are provided, entries with
  68 those Distinguished Names are deleted.  Each \fIDN\fP should be provided
  69 using the LDAPv3 string representation as defined in RFC 2253.
  70 If no \fIdn\fP arguments
  71 are provided, a list of DNs is read from standard input (or from
  72 \fIfile\fP if the -f flag is used).
  73 .SH OPTIONS
  74 .TP
  75 .B \-n
  76 Show what would be done, but don't actually delete entries.  Useful for
  77 debugging in conjunction with -v.
  78 .TP
  79 .B \-v
  80 Use verbose mode, with many diagnostics written to standard output.
  81 .TP
  82 .B \-k
  83 Use Kerberos IV authentication instead of simple authentication.  It is
  84 assumed that you already have a valid ticket granting ticket. This option
  85 only has effect if
  86 . B ldapdelete
  87 is compiled with Kerberos support.
  88 .TP
  89 .B \-K
  90 Same as \-k, but only does step 1 of the Kerberos IV bind.  This is useful
  91 when connecting to a slapd and there is no x500dsa.hostname principal
  92 registered with your Kerberos Domain Controller(s).
  93 .TP
  94 .B \-C
  95 Automatically chase referrals.
  96 .TP
  97 .B \-c
  98 Continuous operation mode.  Errors  are  reported,  but
  99 .B ldapdelete
 100 will  continue  with  deletions.   The default is to exit after
 101 reporting an error.
 102 .TP
 103 .B \-M[M]
 104 Enable manage DSA IT control.
 105 .B \-MM
 106 makes control critical.
 107 .TP
 108 .BI \-d \ debuglevel
 109 Set the LDAP debugging level to \fIdebuglevel\fP.
 110 .B ldapdelete
 111 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 112 .TP
 113 .BI \-f \ file
 114 Read a series of lines from \fIfile\fP, performing one LDAP search for
 115 each line.  In this case, the \fIfilter\fP given on the command line
 116 is treated as a pattern where the first occurrence of \fB%s\fP is
 117 replaced with a line from \fIfile\fP.
 118 .TP
 119 .B \-x
 120 Use simple authentication instead of SASL.
 121 .TP
 122 .BI \-D \ binddn
 123 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 124 .TP
 125 .B \-W
 126 Prompt for simple authentication.
 127 This is used instead of specifying the password on the command line.
 128 .TP
 129 .BI \-w \ passwd
 130 Use \fIpasswd\fP as the password for simple authentication.
 131 .TP
 132 .BI \-H \ ldapuri
 133 Specify URI(s) referring to the ldap server(s).
 134 .TP
 135 .BI \-h \ ldaphost
 136 Specify an alternate host on which the ldap server is running.
 137 Deprecated in favor of -H.
 138 .TP
 139 .BI \-p \ ldapport
 140 Specify an alternate TCP port where the ldap server is listening.
 141 Deprecated in favor of -H.
 142 .TP
 143 .BI \-P \ 2\fR\||\|\fI3
 144 Specify the LDAP protocol version to use.
 145 .TP
 146 .B \-r
 147 Do a recursive delete.  If the DN specified isn't a leaf, its
 148 children, and all their children are deleted down the tree.  No
 149 verification is done, so if you add this switch, ldapdelete will
 150 happily delete large portions of your tree.  Use with care.
 151 .TP
 152 .BI \-O \ security-properties
 153 Specify SASL security properties.
 154 .TP
 155 .B \-I
 156 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 157 only as needed.
 158 .TP
 159 .B \-Q
 160 Enable SASL Quiet mode.  Never prompt.
 161 .TP
 162 .BI \-U \ authcid
 163 Specify the authentication ID for SASL bind. The form of the identity depends on the
 164 actual SASL mechanism used.
 165 .TP
 166 .BI \-X \ authzid
 167 Specify the requested authorization ID for SASL bind.
 168 .I authzid
 169 must be one of the following formats:
 170 .B dn:\c
 171 .I <distinguished name>
 172 or
 173 .B u:\c
 174 .I <username>
 175 .TP
 176 .BI \-Y \ mech
 177 Specify the SASL mechanism to be used for authentication. If it's not
 178 specified, the program will choose the best mechanism the server knows.
 179 .TP
 180 .B \-Z[Z]
 181 Issue StartTLS (Transport Layer Security) extended operation. If you use
 182 .B \-ZZ\c
 183 , the command will require the operation to be successful.
 184 .SH EXAMPLE
 185 The following command:
 186 .LP
 187 .nf
 188     ldapdelete "cn=Delete Me,dc=example,dc=com"
 189 .fi
 190 .LP
 191 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
 192 Of course it would probably be necessary to supply authentication
 193 credentials.
 194 .SH DIAGNOSTICS
 195 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 196 status and a diagnostic message being written to standard error.
 197 .SH "SEE ALSO"
 198 .BR ldap.conf (5),
 199 .BR ldapadd (1),
 200 .BR ldapmodify (1),
 201 .BR ldapmodrdn (1),
 202 .BR ldapsearch (1),
 203 .BR ldap (3),
 204 .BR ldap_delete (3)
 205 .SH AUTHOR
 206 The OpenLDAP Project <http://www.openldap.org/>
 207 .SH ACKNOWLEDGEMENTS
 208 .B      OpenLDAP
 209 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 210 .B      OpenLDAP
 211 is derived from University of Michigan LDAP 3.3 Release.