Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
General policy settings for soft delete operations.
Soft delete policy introduces the ability to control the Directory Server behavior of the delete operation. Instead of performing a permanent delete of an entry it is possible to retain deleted entries and undelete them at a later time. An entry preserved in the deleted state is known as a soft deleted entry. The DN or RDN attributes of a soft deleted entry may not be modified however other soft deleted entry attributes can be modified. Another limitation of soft deletes is that only leaf directory entries can be soft deleted.
The following components have a direct aggregation relation from Soft Delete Policies:
The following components have a direct aggregation relation to Soft Delete Policies:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| auto-soft-delete-connection-criteria | |
| auto-soft-delete-request-criteria | |
| soft-delete-retention-time | |
| soft-delete-retain-number-of-entries |
| Description | A description for this Soft Delete Policy |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
auto-soft-delete-connection-criteria
| Description | Connection criteria used to automatically identify a delete operation for processing as a soft delete request. Specifies a set of connection criteria used to indicate that delete operations from clients matching this criteria will be automatically processed as soft deletes. Delete operations the soft delete request control are always processed as soft deletes without additional criteria. |
| Default Value | No connection criteria is being evaluated to automatically identify a delete operation for processing as a soft delete request. |
| Allowed Values | The DN of any Connection Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
auto-soft-delete-request-criteria
| Description | Request criteria used to automatically identify a delete operation for processing as a soft delete request. Specifies a set of request criteria used to indicate that delete operations for requests matching this criteria will be automatically processed as soft deletes. |
| Default Value | No request criteria is being evaluated to automatically identify a delete operation for processing as a soft delete request. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum length of time that soft delete entries are retained before they are eligible to purged automatically. Specifies the maximum length of time that soft delete entries will be retained before they are purged by an automatic task which runs periodically in the background on the server. |
| Default Value | Soft delete entries are retained indefinitely by default. |
| Allowed Values | A duration. Lower limit is 0 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
soft-delete-retain-number-of-entries
| Description | Specifies the number of soft deleted entries to retain before the oldest entries are purged. Specifies the threshold on the number of soft deleted entries to retain before they are purged by an automatic task which runs periodically in the background on the server. |
| Default Value | Soft delete entries are retained indefinitely by default. |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Soft Delete Policies:
dsconfig list-soft-delete-policies
[--property {propertyName}] ...
To view the configuration for an existing Soft Delete Policy:
dsconfig get-soft-delete-policy-prop
--policy-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Soft Delete Policy:
dsconfig set-soft-delete-policy-prop
--policy-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Soft Delete Policy:
dsconfig create-soft-delete-policy
--policy-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Soft Delete Policy:
dsconfig delete-soft-delete-policy
--policy-name {name}