HOLD RETSET (Place a hold on a retention set)

Edit online

Use this command to place a retention set in a retention hold, for example, if a litigation is pending or anticipated, you might need to preserve relevant data indefinitely until the litigation concludes. When the retention set is added to a retention hold, the data cannot be deleted and is not subject to normal expiration processing. A retention set remains in a hold until the RELEASE RETSET command is issued.

Important:

You can place a retention set in a retention hold state multiple times. The retention set is eligible for deletion only after all of the holds to which it is assigned are released.

Privilege class

To issue this command, you must have system privilege or unrestricted policy privilege.

Syntax

Parameters

hold_name (Required): Specifies the name of the retention hold into which you want to place the retention set. The name must be unique and the maximum length is 64 characters.

retset_id (Required): Specifies the ID of the retention set which you want to place on a hold. The set number is a unique numeric value.

REASon (Required): Specifies the reason for which a retention hold is placed on the specified retention set. The maximum length is 510 characters. Enclose the reason in quotation marks if it contains any blank characters.

Example: Place a retention hold on a retention set

Add retention set 143248 to the retention hold COURT_DOCKET_987204.

hold retset court_docket_987204 143248 reason="Contains data relevant to court proceedings."

Related commands

Table 1. Commands related to HOLD RETSET
Command	Description
DEFINE HOLD	Define a retention set hold.
QUERY HOLD	Displays information about a hold that is placed on a retention set.
QUERY HOLDLOG	Displays information about the hold log.
RELEASE RETSET	Releases a retention set from a retention hold.
RENAME HOLD	Changes the name of a hold on a retention set.
UPDATE HOLD	Changes the attributes of a hold.