| blob | 1ddf8f83b580794b4e6977adae72ae056339e85d |
1 .TH LDAPDELETE 1 "2008/07/16" "OpenLDAP 2.4.11"
2 .\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapdelete.1,v 1.42.2.5 2008/02/11 23:26:39 kurt Exp $
3 .\" Copyright 1998-2008 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 \-c ]
15 [\c
16 .BR \-M[M] ]
17 [\c
18 .BI \-d \ debuglevel\fR]
19 [\c
20 .BI \-f \ file\fR]
21 [\c
22 .BI \-D \ binddn\fR]
23 [\c
24 .BR \-W ]
25 [\c
26 .BI \-w \ passwd\fR]
27 [\c
28 .BI \-y \ passwdfile\fR]
29 [\c
30 .BI \-H \ ldapuri\fR]
31 [\c
32 .BI \-h \ ldaphost\fR]
33 [\c
34 .BI \-P \ 2\fR\||\|\fI3\fR]
35 [\c
36 .BI \-p \ ldapport\fR]
37 [\c
38 .BR \-O \ security-properties ]
39 [\c
40 .BI \-U \ authcid\fR]
41 [\c
42 .BI \-R \ realm\fR]
43 [\c
44 .BR \-r ]
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 .BI \-z \ sizelimit\fR]
57 [\c
58 .BR \-Z[Z] ]
59 [\c
60 .IR dn ]...
61 .SH DESCRIPTION
62 .I ldapdelete
63 is a shell-accessible interface to the
64 .BR ldap_delete_ext (3)
65 library call.
66 .LP
67 .B ldapdelete
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 -f flag is used).
75 .SH OPTIONS
76 .TP
77 .B \-n
78 Show what would be done, but don't actually delete entries. Useful for
79 debugging in conjunction with -v.
80 .TP
81 .B \-v
82 Use verbose mode, with many diagnostics written to standard output.
83 .TP
84 .B \-c
85 Continuous operation mode. Errors are reported, but
86 .B ldapdelete
87 will continue with deletions. The default is to exit after
88 reporting an error.
89 .TP
90 .B \-M[M]
91 Enable manage DSA IT control.
92 .B \-MM
93 makes control critical.
94 .TP
95 .BI \-d \ debuglevel
96 Set the LDAP debugging level to \fIdebuglevel\fP.
97 .B ldapdelete
98 must be compiled with LDAP_DEBUG defined for this option to have any effect.
99 .TP
100 .BI \-f \ file
101 Read a series of DNs from \fIfile\fP, one per line, performing an
102 LDAP delete for each.
103 .TP
104 .B \-x
105 Use simple authentication instead of SASL.
106 .TP
107 .BI \-D \ binddn
108 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
109 .TP
110 .B \-W
111 Prompt for simple authentication.
112 This is used instead of specifying the password on the command line.
113 .TP
114 .BI \-w \ passwd
115 Use \fIpasswd\fP as the password for simple authentication.
116 .TP
117 .BI \-y \ passwdfile
118 Use complete contents of \fIpasswdfile\fP as the password for
119 simple authentication.
120 .TP
121 .BI \-H \ ldapuri
122 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
123 fields are allowed; a list of URI, separated by whitespace or commas
124 is expected.
125 .TP
126 .BI \-h \ ldaphost
127 Specify an alternate host on which the ldap server is running.
128 Deprecated in favor of -H.
129 .TP
130 .BI \-p \ ldapport
131 Specify an alternate TCP port where the ldap server is listening.
132 Deprecated in favor of -H.
133 .TP
134 .BI \-P \ 2\fR\||\|\fI3
135 Specify the LDAP protocol version to use.
136 .TP
137 .B \-r
138 Do a recursive delete. If the DN specified isn't a leaf, its
139 children, and all their children are deleted down the tree. No
140 verification is done, so if you add this switch, ldapdelete will
141 happily delete large portions of your tree. Use with care.
142 .TP
143 .BI \-z \ sizelimit
144 Use \fIsizelimit\fP when searching for children DN to delete,
145 to circumvent any server-side size limit. Only useful in conjunction
146 with \-r.
147 .TP
148 .BI \-O \ security-properties
149 Specify SASL security properties.
150 .TP
151 .B \-I
152 Enable SASL Interactive mode. Always prompt. Default is to prompt
153 only as needed.
154 .TP
155 .B \-Q
156 Enable SASL Quiet mode. Never prompt.
157 .TP
158 .BI \-U \ authcid
159 Specify the authentication ID for SASL bind. The form of the identity depends on the
160 actual SASL mechanism used.
161 .TP
162 .BI \-R \ realm
163 Specify the realm of authentication ID for SASL bind. The form of the realm
164 depends on the 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_ext (3)
205 .SH AUTHOR
206 The OpenLDAP Project <http://www.openldap.org/>
207 .SH ACKNOWLEDGEMENTS
208 .\" Shared Project Acknowledgement Text
209 .B "OpenLDAP Software"
210 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
211 .B "OpenLDAP Software"
212 is derived from University of Michigan LDAP 3.3 Release.