DELETE RETSET (Delete a retention set)

Use this command to delete a retention set or to delete individual client nodes, node groups, or file spaces from a retention set.

When you delete a retention set, the files that it contains are no longer protected from expiration.
Attention:
  • It is not possible to recover a deleted retention set. Before you start a delete operation, verify that you selected the correct retention set for deletion.
  • If you do not specify a node, node group, or filespace name, the entire retention set is deleted.
  • If you specify a node or node group name but do not specify a filespace name, all file spaces that are members of that node or node group are deleted.
  • If you specify both a node and a filespace name, only the specified file space that is a member of the specified node is deleted.

To provide an audit trail that you can use to track deleted or expired retention sets, a record of each deleted retention set, including its full history, is retained in the activity log based on activity log retention settings. To view the activity log, issue the QUERY ACTLOG command.

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagramDELete RETSet retset_id ,node_namenode_group_namefile space specification
file space specification
Read syntax diagramSkip visual syntax diagram,filespace_name12NAMEType=SERVERNAMEType=SERVERUNIcodeFSIDCODEType=BOTHCODEType=UNIcodeNONUNIcodeBOTH
Notes:
  • 1 The filespace_name can correspond to a file space on a backup-archive client or to an IBM Spectrum® Protect for Virtual Environments virtual machine. To specify the virtual machine, use either the virtual machine name or the corresponding filespace name.
  • 2 If you specify a filespace name, you can specify only one fully qualified node name.

Parameters

retset_id (Required)
Specifies the ID of the retention set that you want to delete. The retention set ID is a unique numeric value.
Tip: To obtain the retention set ID, issue the QUERY RETSET command.
node_name or node_group_name
Specifies the name of one or more client node or node groups that are to be deleted from the retention set. To specify multiple node names and node group names, separate the names with commas and no intervening spaces. You can use wildcard characters with node names but not with node group names. If you specify wildcard characters in the node name, all nodes included in the retention set that match that wildcard specification will be deleted. If you specify a filespace name, you can specify only one fully qualified node name.
filespace_name
Specifies the name of a file space to be removed from the retention set. The filespace name can correspond to a backup-archive client file space or to the name of an IBM Spectrum Protect for Virtual Environments virtual machine. Instead of specifying a filespace name, you can specify the name of the virtual machine.

You can specify wildcard characters in the filespace name. To specify a file space that contains a comma in the name, you must specify the file space numerical ID and then specify NAMETYPE=FSID.

Tip: To determine which file spaces and file space IDs are defined for a node, issue the QUERY FILESPACE command.
NAMEType
Specifies how you want the server to interpret the filespace name that you enter. Use this parameter only when you specify a a fully qualified filespace name.

The default value is SERVER. If a virtual file space mapping name is specified, you must use SERVER. You can specify one of the following values:

SERVER
The server uses the server's code page to interpret the filespace name.
UNIcode
The server converts the filespace name that is entered from the server code page to the UTF-8 code page. The success of the conversion depends on the characters in the name and the server's code page. Conversion fails if the string includes characters that are not available in the server code page, or if the server cannot access system conversion routines.
FSID
The server interprets the filespace name as the file space ID (FSID).
CODEType
Specifies the type of file spaces that are eligible for deletion when the command is processed. The default value is BOTH, meaning that file spaces are eligible for deletion regardless of code page type. Use this parameter only when you enter at least one wildcard character for the filespace name. You can specify one of the following values:
UNIcode
Specifies only file spaces that are in Unicode format.
NONUNIcode
Specifies only file spaces that are not in Unicode format.
BOTH
Specifies all file spaces regardless of code page type.

Example: Delete a retention set

Delete retention set 143248.
delete retset 143248

Related commands

Table 1. Commands related to DELETE RETSET
Command Description
QUERY RETSET Displays information about retention sets.
QUERY RETSETCONTENTS Displays information about the contents of retention sets.
UPDATE RETSET Changes the attributes of a retention set.