Subtree delete control

Edit online

The Subtree delete control explains its use with the server and provides the results.

Description
This control is attached to a delete request. This control indicates that the specified entry and all descendant entries are to be deleted. However, if the subtree is an active replication context, the control does not take effect and an LDAP_UNWILLING_TO_PERFORM message is returned. This return means that the subtree to be deleted might contain any replication agreements that the server uses to replicate. If the subtree contains any replication agreements, then the subtree cannot be deleted by using this control.
OID
1.2.840.113556.1.4.805
Syntax
This control has no value.
Behavior
This control is registered for the following operations:
  • Delete
The following persons are enabled to send the control:
  • Primary Directory Administrator
  • Local Administration Group members
  • Global Administration Group members
  • Master server DN
Note: If the control is sent by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
This control has the following possible return codes:
  • LDAP_INSUFFICIENT_ACCESS
  • LDAP_UNWILLING_TO_PERFORM

The Administration Server does not support this control.

Scope
The control lasts for the term of one delete operation. The delete operation not only deletes the base entry that is specified in the request, but also deletes all the descendant entries.