ldapdelete — LDAP delete entry tool
ldapdelete [−n] [−v] [−c] [−M[M]] [ −d debuglevel ] [ −f file ] [ −D binddn ] [−W] [ −w passwd ] [ −y passwdfile ] [ −H ldapuri ] [ −h ldaphost ] [ −P 2 | 3 ] [ −p ldapport ] [ −O security−properties ] [
−U authcid ] [
−R realm ] [−r] [−x] [−I] [−Q] [ −X authzid ] [ −Y mech ] [ −z sizelimit ] [−Z[Z]] [dn...]
ldapdelete is a shell-accessible interface to the ldap_delete_ext(3) library call.
ldapdelete
opens a connection to an LDAP server, binds, and deletes one
or more entries. If one or more DN arguments are provided, entries with
those Distinguished Names are deleted. Each DN should be provided using the LDAPv3
string representation as defined in RFC 4514. If no
dn arguments are
provided, a list of DNs is read from standard input (or from
file if the -f flag
is used).
−nShow what would be done, but don't actually delete entries. Useful for debugging in conjunction with -v.
−vUse verbose mode, with many diagnostics written to standard output.
−cContinuous operation mode. Errors are reported, but ldapdelete will continue with deletions. The default is to exit after reporting an error.
−M[M]Enable manage DSA IT control. −MM makes control critical.
−d
debuglevelSet the LDAP debugging level to debuglevel. ldapdelete must be
compiled with LDAP_DEBUG defined for this option to
have any effect.
−f
fileRead a series of DNs from file, one per line,
performing an LDAP delete for each.
−xUse simple authentication instead of SASL.
−D
binddnUse the Distinguished Name binddn to bind to the
LDAP directory.
−WPrompt for simple authentication. This is used instead of specifying the password on the command line.
−w
passwdUse passwd
as the password for simple authentication.
−y
passwdfileUse complete contents of passwdfile as the
password for simple authentication.
−H
ldapuriSpecify 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.
−h
ldaphostSpecify an alternate host on which the ldap server is running. Deprecated in favor of -H.
−p
ldapportSpecify an alternate TCP port where the ldap server is listening. Deprecated in favor of -H.
−P
2|3Specify the LDAP protocol version to use.
−rDo 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.
−z
sizelimitUse sizelimit when searching
for children DN to delete, to circumvent any
server-side size limit. Only useful in conjunction with
−r.
−O
security−propertiesSpecify SASL security properties.
−IEnable SASL Interactive mode. Always prompt. Default is to prompt only as needed.
−QEnable SASL Quiet mode. Never prompt.
−U
authcidSpecify the authentication ID for SASL bind. The form of the identity depends on the actual SASL mechanism used.
−R
realmSpecify the realm of authentication ID for SASL bind. The form of the realm depends on the actual SASL mechanism used.
−X
authzidSpecify the requested authorization ID for SASL
bind. authzid
must be one of the following formats: dn: <distinguished name>
or u:
<username>
−Y
mechSpecify the SASL mechanism to be used for authentication. If it's not specified, the program will choose the best mechanism the server knows.
−Z[Z]Issue StartTLS (Transport Layer Security) extended
operation. If you use −ZZ , the command will require
the operation to be successful.
The following command:
ldapdelete "cn=Delete Me,dc=example,dc=com"
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.
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.
ldap.conf(5), ldapadd(1), ldapmodify(1), ldapmodrdn(1), ldapsearch(1), ldap(3), ldap_delete_ext(3)
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from University of Michigan LDAP 3.3 Release.