1 .TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2009 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 .BI \-p \ ldapport\fR]
38 .BI \-O \ security-properties\fR]
56 .BI \-z \ sizelimit\fR]
63 is a shell-accessible interface to the
64 .BR ldap_delete_ext (3)
68 opens a connection to an LDAP server, binds, and deletes one or more
69 entries. If one or more \fIDN\fP arguments are provided, entries with
70 those Distinguished Names are deleted. Each \fIDN\fP should be provided
71 using the LDAPv3 string representation as defined in RFC 4514.
72 If no \fIDN\fP arguments
73 are provided, a list of DNs is read from standard input (or from
74 \fIfile\fP if the \fB\-f\fP flag is used).
78 Show what would be done, but don't actually delete entries. Useful for
79 debugging in conjunction with \fB\-v\fP.
82 Use verbose mode, with many diagnostics written to standard output.
85 Continuous operation mode. Errors are reported, but
87 will continue with deletions. The default is to exit after
91 Enable manage DSA IT control.
93 makes control critical.
96 Set the LDAP debugging level to \fIdebuglevel\fP.
98 must be compiled with LDAP_DEBUG defined for this option to have any effect.
101 Read a series of DNs from \fIfile\fP, one per line, performing an
102 LDAP delete for each.
105 Use simple authentication instead of SASL.
108 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
109 For SASL binds, the server is expected to ignore this value.
112 Prompt for simple authentication.
113 This is used instead of specifying the password on the command line.
116 Use \fIpasswd\fP as the password for simple authentication.
119 Use complete contents of \fIpasswdfile\fP as the password for
120 simple authentication.
123 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
124 fields are allowed; a list of URI, separated by whitespace or commas
128 Specify an alternate host on which the ldap server is running.
129 Deprecated in favor of \fB\-H\fP.
132 Specify an alternate TCP port where the ldap server is listening.
133 Deprecated in favor of \fB\-H\fP.
135 .BR \-P \ { 2 \||\| 3 }
136 Specify the LDAP protocol version to use.
139 Do a recursive delete. If the DN specified isn't a leaf, its
140 children, and all their children are deleted down the tree. No
141 verification is done, so if you add this switch, ldapdelete will
142 happily delete large portions of your tree. Use with care.
145 Use \fIsizelimit\fP when searching for children DN to delete,
146 to circumvent any server-side size limit. Only useful in conjunction
149 .BI \-O \ security-properties
150 Specify SASL security properties.
153 Enable SASL Interactive mode. Always prompt. Default is to prompt
157 Enable SASL Quiet mode. Never prompt.
160 Specify the authentication ID for SASL bind. The form of the identity depends on the
161 actual SASL mechanism used.
164 Specify the realm of authentication ID for SASL bind. The form of the realm
165 depends on the actual SASL mechanism used.
168 Specify the requested authorization ID for SASL bind.
170 must be one of the following formats:
171 .BI dn: "<distinguished name>"
176 Specify the SASL mechanism to be used for authentication. If it's not
177 specified, the program will choose the best mechanism the server knows.
180 Issue StartTLS (Transport Layer Security) extended operation. If you use
181 \fB\-ZZ\fP, the command will require the operation to be successful.
183 The following command:
186 ldapdelete "cn=Delete Me,dc=example,dc=com"
189 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
190 Of course it would probably be necessary to supply authentication
193 Exit status is 0 if no errors occur. Errors result in a non-zero exit
194 status and a diagnostic message being written to standard error.
202 .BR ldap_delete_ext (3)
204 The OpenLDAP Project <http://www.openldap.org/>