mirror of
https://git.openldap.org/openldap/openldap.git
synced 2024-12-21 03:10:25 +08:00
241 lines
6.2 KiB
Groff
241 lines
6.2 KiB
Groff
.TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
|
|
.\" $OpenLDAP$
|
|
.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
|
.SH NAME
|
|
ldapdelete \- LDAP delete entry tool
|
|
.SH SYNOPSIS
|
|
.B ldapdelete
|
|
[\c
|
|
.BR \-n ]
|
|
[\c
|
|
.BR \-v ]
|
|
[\c
|
|
.BR \-c ]
|
|
[\c
|
|
.BR \-M [ M ]]
|
|
[\c
|
|
.BI \-d \ debuglevel\fR]
|
|
[\c
|
|
.BI \-f \ file\fR]
|
|
[\c
|
|
.BI \-D \ binddn\fR]
|
|
[\c
|
|
.BR \-W ]
|
|
[\c
|
|
.BI \-w \ passwd\fR]
|
|
[\c
|
|
.BI \-y \ passwdfile\fR]
|
|
[\c
|
|
.BI \-H \ ldapuri\fR]
|
|
[\c
|
|
.BI \-h \ ldaphost\fR]
|
|
[\c
|
|
.BR \-P \ { 2 \||\| 3 }]
|
|
[\c
|
|
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
|
|
[\c
|
|
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
|
|
[\c
|
|
.BI \-p \ ldapport\fR]
|
|
[\c
|
|
.BI \-O \ security-properties\fR]
|
|
[\c
|
|
.BI \-U \ authcid\fR]
|
|
[\c
|
|
.BI \-R \ realm\fR]
|
|
[\c
|
|
.BR \-r ]
|
|
[\c
|
|
.BR \-x ]
|
|
[\c
|
|
.BR \-I ]
|
|
[\c
|
|
.BR \-Q ]
|
|
[\c
|
|
.BI \-X \ authzid\fR]
|
|
[\c
|
|
.BI \-Y \ mech\fR]
|
|
[\c
|
|
.BI \-z \ sizelimit\fR]
|
|
[\c
|
|
.BR \-Z [ Z ]]
|
|
[\c
|
|
.IR DN \ [ ... ]]
|
|
.SH DESCRIPTION
|
|
.I ldapdelete
|
|
is a shell-accessible interface to the
|
|
.BR ldap_delete_ext (3)
|
|
library call.
|
|
.LP
|
|
.B ldapdelete
|
|
opens a connection to an LDAP server, binds, and deletes one or more
|
|
entries. If one or more \fIDN\fP arguments are provided, entries with
|
|
those Distinguished Names are deleted. Each \fIDN\fP should be provided
|
|
using the LDAPv3 string representation as defined in RFC 4514.
|
|
If no \fIDN\fP arguments
|
|
are provided, a list of DNs is read from standard input (or from
|
|
\fIfile\fP if the \fB\-f\fP flag is used).
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-n
|
|
Show what would be done, but don't actually delete entries. Useful for
|
|
debugging in conjunction with \fB\-v\fP.
|
|
.TP
|
|
.B \-v
|
|
Use verbose mode, with many diagnostics written to standard output.
|
|
.TP
|
|
.B \-c
|
|
Continuous operation mode. Errors are reported, but
|
|
.B ldapdelete
|
|
will continue with deletions. The default is to exit after
|
|
reporting an error.
|
|
.TP
|
|
.BR \-M [ M ]
|
|
Enable manage DSA IT control.
|
|
.B \-MM
|
|
makes control critical.
|
|
.TP
|
|
.BI \-d \ debuglevel
|
|
Set the LDAP debugging level to \fIdebuglevel\fP.
|
|
.B ldapdelete
|
|
must be compiled with LDAP_DEBUG defined for this option to have any effect.
|
|
.TP
|
|
.BI \-f \ file
|
|
Read a series of DNs from \fIfile\fP, one per line, performing an
|
|
LDAP delete for each.
|
|
.TP
|
|
.B \-x
|
|
Use simple authentication instead of SASL.
|
|
.TP
|
|
.BI \-D \ binddn
|
|
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
|
|
For SASL binds, the server is expected to ignore this value.
|
|
.TP
|
|
.B \-W
|
|
Prompt for simple authentication.
|
|
This is used instead of specifying the password on the command line.
|
|
.TP
|
|
.BI \-w \ passwd
|
|
Use \fIpasswd\fP as the password for simple authentication.
|
|
.TP
|
|
.BI \-y \ passwdfile
|
|
Use complete contents of \fIpasswdfile\fP as the password for
|
|
simple authentication.
|
|
.TP
|
|
.BI \-H \ ldapuri
|
|
Specify URI(s) referring to the ldap server(s); only the protocol/host/port
|
|
fields are allowed; a list of URI, separated by whitespace or commas
|
|
is expected.
|
|
.TP
|
|
.BI \-h \ ldaphost
|
|
Specify an alternate host on which the ldap server is running.
|
|
Deprecated in favor of \fB\-H\fP.
|
|
.TP
|
|
.BI \-p \ ldapport
|
|
Specify an alternate TCP port where the ldap server is listening.
|
|
Deprecated in favor of \fB\-H\fP.
|
|
.TP
|
|
.BR \-P \ { 2 \||\| 3 }
|
|
Specify the LDAP protocol version to use.
|
|
.TP
|
|
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
|
|
.TP
|
|
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
|
|
|
|
Specify general extensions with \fB\-e\fP and search extensions with \fB\-E\fP.
|
|
\'\fB!\fP\' indicates criticality.
|
|
|
|
General extensions:
|
|
.nf
|
|
[!]assert=<filter> (an RFC 4515 Filter)
|
|
[!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
|
|
[!]manageDSAit
|
|
[!]noop
|
|
ppolicy
|
|
[!]postread[=<attrs>] (a comma-separated attribute list)
|
|
[!]preread[=<attrs>] (a comma-separated attribute list)
|
|
abandon, cancel (SIGINT sends abandon/cancel; not really controls)
|
|
.fi
|
|
|
|
Search extensions:
|
|
.nf
|
|
[!]domainScope (domain scope)
|
|
[!]mv=<filter> (matched values filter)
|
|
[!]pr=<size>[/prompt|noprompt] (paged results/prompt)
|
|
[!]sss=[\-]<attr[:OID]>[/[\-]<attr[:OID]>...] (server side sorting)
|
|
[!]subentries[=true|false] (subentries)
|
|
[!]sync=ro[/<cookie>] (LDAP Sync refreshOnly)
|
|
rp[/<cookie>][/<slimit>] (LDAP Sync refreshAndPersist)
|
|
.fi
|
|
.TP
|
|
.B \-r
|
|
Do a recursive delete. If the DN specified isn't a leaf, its
|
|
children, and all their children are deleted down the tree. No
|
|
verification is done, so if you add this switch, ldapdelete will
|
|
happily delete large portions of your tree. Use with care.
|
|
.TP
|
|
.BI \-z \ sizelimit
|
|
Use \fIsizelimit\fP when searching for children DN to delete,
|
|
to circumvent any server-side size limit. Only useful in conjunction
|
|
with \fB\-r\fP.
|
|
.TP
|
|
.BI \-O \ security-properties
|
|
Specify SASL security properties.
|
|
.TP
|
|
.B \-I
|
|
Enable SASL Interactive mode. Always prompt. Default is to prompt
|
|
only as needed.
|
|
.TP
|
|
.B \-Q
|
|
Enable SASL Quiet mode. Never prompt.
|
|
.TP
|
|
.BI \-U \ authcid
|
|
Specify the authentication ID for SASL bind. The form of the identity depends on the
|
|
actual SASL mechanism used.
|
|
.TP
|
|
.BI \-R \ realm
|
|
Specify the realm of authentication ID for SASL bind. The form of the realm
|
|
depends on the actual SASL mechanism used.
|
|
.TP
|
|
.BI \-X \ authzid
|
|
Specify the requested authorization ID for SASL bind.
|
|
.I authzid
|
|
must be one of the following formats:
|
|
.BI dn: "<distinguished name>"
|
|
or
|
|
.BI u: <username>
|
|
.TP
|
|
.BI \-Y \ mech
|
|
Specify the SASL mechanism to be used for authentication. If it's not
|
|
specified, the program will choose the best mechanism the server knows.
|
|
.TP
|
|
.BR \-Z [ Z ]
|
|
Issue StartTLS (Transport Layer Security) extended operation. If you use
|
|
\fB\-ZZ\fP, the command will require the operation to be successful.
|
|
.SH EXAMPLE
|
|
The following command:
|
|
.LP
|
|
.nf
|
|
ldapdelete "cn=Delete Me,dc=example,dc=com"
|
|
.fi
|
|
.LP
|
|
will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
|
|
Of course it would probably be necessary to supply authentication
|
|
credentials.
|
|
.SH DIAGNOSTICS
|
|
Exit status is 0 if no errors occur. Errors result in a non-zero exit
|
|
status and a diagnostic message being written to standard error.
|
|
.SH "SEE ALSO"
|
|
.BR ldap.conf (5),
|
|
.BR ldapadd (1),
|
|
.BR ldapmodify (1),
|
|
.BR ldapmodrdn (1),
|
|
.BR ldapsearch (1),
|
|
.BR ldap (3),
|
|
.BR ldap_delete_ext (3)
|
|
.SH AUTHOR
|
|
The OpenLDAP Project <http://www.openldap.org/>
|
|
.SH ACKNOWLEDGEMENTS
|
|
.so ../Project
|