1 .TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2018 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapdelete \- LDAP delete entry tool
12 .BI \-d \ debuglevel\fR]
24 .BI \-z \ sizelimit\fR]
36 .BI \-y \ passwdfile\fR]
40 .BI \-h \ ldaphost\fR]
42 .BI \-p \ ldapport\fR]
44 .BR \-P \ { 2 \||\| 3 }]
46 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
48 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
50 .BI \-o \ opt \fR[= optparam \fR]]
52 .BI \-O \ security-properties\fR]
73 is a shell-accessible interface to the
74 .BR ldap_delete_ext (3)
78 opens a connection to an LDAP server, binds, and deletes one or more
79 entries. If one or more \fIDN\fP arguments are provided, entries with
80 those Distinguished Names are deleted. Each \fIDN\fP should be provided
81 using the LDAPv3 string representation as defined in RFC 4514.
82 If no \fIDN\fP arguments
83 are provided, a list of DNs is read from standard input (or from
84 \fIfile\fP if the \fB\-f\fP flag is used).
89 If \fB\-VV\fP is given, only the version information is printed.
92 Set the LDAP debugging level to \fIdebuglevel\fP.
94 must be compiled with LDAP_DEBUG defined for this option to have any effect.
97 Show what would be done, but don't actually delete entries. Useful for
98 debugging in conjunction with \fB\-v\fP.
101 Use verbose mode, with many diagnostics written to standard output.
104 Continuous operation mode. Errors are reported, but
106 will continue with deletions. The default is to exit after
110 Read a series of DNs from \fIfile\fP, one per line, performing an
111 LDAP delete for each.
114 Do a recursive delete. If the DN specified isn't a leaf, its
115 children, and all their children are deleted down the tree. No
116 verification is done, so if you add this switch, ldapdelete will
117 happily delete large portions of your tree. Use with care.
120 Use \fIsizelimit\fP when searching for children DN to delete,
121 to circumvent any server-side size limit. Only useful in conjunction
125 Enable manage DSA IT control.
127 makes control critical.
130 Use simple authentication instead of SASL.
133 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
134 For SASL binds, the server is expected to ignore this value.
137 Prompt for simple authentication.
138 This is used instead of specifying the password on the command line.
141 Use \fIpasswd\fP as the password for simple authentication.
144 Use complete contents of \fIpasswdfile\fP as the password for
145 simple authentication.
148 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
149 fields are allowed; a list of URI, separated by whitespace or commas
153 Specify an alternate host on which the ldap server is running.
154 Deprecated in favor of \fB\-H\fP.
157 Specify an alternate TCP port where the ldap server is listening.
158 Deprecated in favor of \fB\-H\fP.
160 .BR \-P \ { 2 \||\| 3 }
161 Specify the LDAP protocol version to use.
163 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
165 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
167 Specify general extensions with \fB\-e\fP and delete extensions with \fB\-E\fP.
168 \'\fB!\fP\' indicates criticality.
172 [!]assert=<filter> (an RFC 4515 Filter)
173 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
174 [!]bauthzid (RFC 3829 authzid control)
175 [!]chaining[=<resolve>[/<cont>]]
179 [!]postread[=<attrs>] (a comma-separated attribute list)
180 [!]preread[=<attrs>] (a comma-separated attribute list)
182 sessiontracking[=<username>]
183 abandon,cancel,ignore (SIGINT sends abandon/cancel,
184 or ignores response; if critical, doesn't wait for SIGINT.
193 .BI \-o \ opt \fR[= optparam \fR]
197 option or one of the following:
199 nettimeout=<timeout> (in seconds, or "none" or "max")
200 ldif_wrap=<width> (in columns, or "no" for no wrapping)
204 .BI \-O \ security-properties
205 Specify SASL security properties.
208 Enable SASL Interactive mode. Always prompt. Default is to prompt
212 Enable SASL Quiet mode. Never prompt.
215 Do not use reverse DNS to canonicalize SASL host name.
218 Specify the authentication ID for SASL bind. The form of the identity depends on the
219 actual SASL mechanism used.
222 Specify the realm of authentication ID for SASL bind. The form of the realm
223 depends on the actual SASL mechanism used.
226 Specify the requested authorization ID for SASL bind.
228 must be one of the following formats:
229 .BI dn: "<distinguished name>"
234 Specify the SASL mechanism to be used for authentication. If it's not
235 specified, the program will choose the best mechanism the server knows.
238 Issue StartTLS (Transport Layer Security) extended operation. If you use
239 \fB\-ZZ\fP, the command will require the operation to be successful.
241 The following command:
244 ldapdelete "cn=Delete Me,dc=example,dc=com"
247 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
248 Of course it would probably be necessary to supply authentication
251 Exit status is 0 if no errors occur. Errors result in a non-zero exit
252 status and a diagnostic message being written to standard error.
260 .BR ldap_delete_ext (3)
262 The OpenLDAP Project <http://www.openldap.org/>