1 .TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapdelete \- LDAP delete entry tool
18 .BI \-d \ debuglevel\fR]
28 .BI \-y \ passwdfile\fR]
32 .BI \-h \ ldaphost\fR]
34 .BR \-P \ { 2 \||\| 3 }]
36 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
38 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
40 .BI \-p \ ldapport\fR]
42 .BI \-O \ security-properties\fR]
60 .BI \-z \ sizelimit\fR]
67 is a shell-accessible interface to the
68 .BR ldap_delete_ext (3)
72 opens a connection to an LDAP server, binds, and deletes one or more
73 entries. If one or more \fIDN\fP arguments are provided, entries with
74 those Distinguished Names are deleted. Each \fIDN\fP should be provided
75 using the LDAPv3 string representation as defined in RFC 4514.
76 If no \fIDN\fP arguments
77 are provided, a list of DNs is read from standard input (or from
78 \fIfile\fP if the \fB\-f\fP flag is used).
82 Show what would be done, but don't actually delete entries. Useful for
83 debugging in conjunction with \fB\-v\fP.
86 Use verbose mode, with many diagnostics written to standard output.
89 Continuous operation mode. Errors are reported, but
91 will continue with deletions. The default is to exit after
95 Enable manage DSA IT control.
97 makes control critical.
100 Set the LDAP debugging level to \fIdebuglevel\fP.
102 must be compiled with LDAP_DEBUG defined for this option to have any effect.
105 Read a series of DNs from \fIfile\fP, one per line, performing an
106 LDAP delete for each.
109 Use simple authentication instead of SASL.
112 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
113 For SASL binds, the server is expected to ignore this value.
116 Prompt for simple authentication.
117 This is used instead of specifying the password on the command line.
120 Use \fIpasswd\fP as the password for simple authentication.
123 Use complete contents of \fIpasswdfile\fP as the password for
124 simple authentication.
127 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
128 fields are allowed; a list of URI, separated by whitespace or commas
132 Specify an alternate host on which the ldap server is running.
133 Deprecated in favor of \fB\-H\fP.
136 Specify an alternate TCP port where the ldap server is listening.
137 Deprecated in favor of \fB\-H\fP.
139 .BR \-P \ { 2 \||\| 3 }
140 Specify the LDAP protocol version to use.
142 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
144 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
146 Specify general extensions with \fB\-e\fP and delete extensions with \fB\-E\fP.
147 \'\fB!\fP\' indicates criticality.
151 [!]assert=<filter> (an RFC 4515 Filter)
152 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
153 [!]bauthzid (RFC 3829 authzid control)
154 [!]chaining[=<resolve>[/<cont>]]
158 [!]postread[=<attrs>] (a comma-separated attribute list)
159 [!]preread[=<attrs>] (a comma-separated attribute list)
161 sessiontracking[=<username>]
162 abandon,cancel,ignore (SIGINT sends abandon/cancel,
163 or ignores response; if critical, doesn't wait for SIGINT.
173 Do a recursive delete. If the DN specified isn't a leaf, its
174 children, and all their children are deleted down the tree. No
175 verification is done, so if you add this switch, ldapdelete will
176 happily delete large portions of your tree. Use with care.
179 Use \fIsizelimit\fP when searching for children DN to delete,
180 to circumvent any server-side size limit. Only useful in conjunction
183 .BI \-O \ security-properties
184 Specify SASL security properties.
187 Enable SASL Interactive mode. Always prompt. Default is to prompt
191 Enable SASL Quiet mode. Never prompt.
194 Specify the authentication ID for SASL bind. The form of the identity depends on the
195 actual SASL mechanism used.
198 Specify the realm of authentication ID for SASL bind. The form of the realm
199 depends on the actual SASL mechanism used.
202 Specify the requested authorization ID for SASL bind.
204 must be one of the following formats:
205 .BI dn: "<distinguished name>"
210 Specify the SASL mechanism to be used for authentication. If it's not
211 specified, the program will choose the best mechanism the server knows.
214 Issue StartTLS (Transport Layer Security) extended operation. If you use
215 \fB\-ZZ\fP, the command will require the operation to be successful.
217 The following command:
220 ldapdelete "cn=Delete Me,dc=example,dc=com"
223 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
224 Of course it would probably be necessary to supply authentication
227 Exit status is 0 if no errors occur. Errors result in a non-zero exit
228 status and a diagnostic message being written to standard error.
236 .BR ldap_delete_ext (3)
238 The OpenLDAP Project <http://www.openldap.org/>