UPDATE BACKUPSET (Update a retention value assigned to a backup set)

Use this command to update the retention value associated with a client's backup set.

Privilege class

To issue this command, you must have system privilege or policy privilege for the domain to which the client node is assigned.

Syntax

Read syntax diagramSkip visual syntax diagramUPDate BACKUPSET,node__namenode_group_name,backup_set_nameRETention=daysNOLimitBEGINDate=dateBEGINTime=timeENDDate=dateENDTime=timeWHERERETention=daysNOLimitWHEREDATAType=ALLWHEREDATAType=,FILEIMAGEWHEREDESCription=descriptionPreview=NoYesVERSion=AnyVERSion=AnyLatest

Parameters

node_name or node_group_name (Required)
Specifies the names of the client nodes or node groups whose data is contained in the specified backup set to be updated. To specify multiple node and node group names, separate the names with commas and no intervening spaces. The node names that you specify can contain wildcard characters, but node group names cannot contain wildcard characters.
backup_set_name (Required)
Specifies the name of the backup set to update. The backup set name you specify can contain wildcard characters. You can specify more than one backup set name by separating the names with commas and no intervening spaces.
RETention (Required)
Specifies the updated number of days to retain the backup set on the server. You can specify an integer from 0 to 30000. The values are:
days
Specifies the updated number of days to retain the backup set.
NOLimit
Specifies that the backup set is retained on the server indefinitely. If you specify NOLIMIT, the server retains the volumes containing the backup set forever, unless a user or administrator deletes the volumes from server storage.
Attention: Updating the retention period of a backup set may cause it to expire at a different time from other backup sets that might be stored on the same output media. In either case, the media will not be made available for other uses until all of its backup sets have expired.
BEGINDate
Specifies the beginning date in which the backup set to update was created. This parameter is optional. The default is the current date. You can use this parameter with the BEGINTIME parameter to specify a range for the date and time. If you specify a begin date without a begin time, the time will be at 12:00 a.m. (midnight) on the date you specify.
You can specify the date by using one of the following values:
Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or +days The current date plus days specified. TODAY +3 or +3.
TODAY-days or -days The current date minus days specified. TODAY-3 or -3.
EOLM (End Of Last Month) The last day of the previous month. EOLM
EOLM-days The last day of the previous month minus days specified. EOLM-1

To include files that were active a day before the last day of the previous month.
BOTM (Beginning Of This Month) The first day of the current month. BOTM
BOTM+days The first day of the current month, plus days specified. BOTM+9

To include files that were active on the 10th day of the current month.
BEGINTime
Specifies the beginning time in which the backup set to update was created. This parameter is optional. The default is the current time. You can use this parameter with the BEGINDATE parameter to specify a range for the date and time. If you specify a begin time without a begin date, the date will be the current date at the time you specify.
You can specify the time by using one of the following values:
Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM or +HH:MM The current time plus hours and minutes on the specified end date NOW+02:00 or +02:00.
NOW-HH:MM or -HH:MM The current time minus hours and minutes on the specified end date NOW-02:00 or –02:00.
ENDDate
Specifies the ending date in which the backup set to update was created. This parameter is optional. You can use this parameter with the ENDTIME parameter to specify a range for the date and time. If you specify an end date without an ending time, the time will be at 11:59:59 p.m. on the specified end date.
You can specify the date by using one of the following values:
Value Description Example
MM/DD/YYYY A specific date 09/15/1999
TODAY The current date TODAY
TODAY+days or +days The current date plus days specified. TODAY +3 or +3.
TODAY-days or —days The current date minus days specified. TODAY -3 or -3.
EOLM (End Of Last Month) The last day of the previous month. EOLM
EOLM-days The last day of the previous month minus days specified. EOLM-1

To include files that were active a day before the last day of the previous month.
BOTM (Beginning Of This Month) The first day of the current month. BOTM
BOTM+days The first day of the current month, plus days specified. BOTM+9

To include files that were active on the 10th day of the current month.
ENDTime
Specifies the ending time in which the backup set to update was created. This parameter is optional. You can use this parameter with the ENDDATE parameter to specify a range for the date and time. If you specify an end time without an end date, the date will be the current date at the time you specify.
You can specify the time by using one of the following values:
Value Description Example
HH:MM:SS A specific time 10:30:08
NOW The current time NOW
NOW+HH:MM or +HH:MM The current time plus hours and minutes specified NOW+02:00 or +02:00.
NOW-HH:MM or -HH:MM The current time minus hours and minutes specified NOW-02:00 or –02:00.
WHERERETention
Specifies the retention value, specified in days, that is associated with the backup set to update. The values are:
days
Specifies that the backup set that is retained this number of days is updated.
NOLimit
Specifies that the backup set retained indefinitely is updated.
WHEREDESCription
Specifies the description that is associated with the backup set to update. This parameter is optional. You can specify wildcard characters for the description. Enclose the description in quotation marks if it contains any blank characters.
WHEREDATAType
Specifies the backup sets containing the specified types of data are to be updated. This parameter is optional. The default is that backup sets for all types of data (file level, image, and application) are to be updated. To specify multiple data types, separate each data type with a comma and no intervening spaces. Possible values are:
ALL
Specifies that backup sets for all types of data (file level, image, and application) are to be updated. This is the default.
FILE
Specifies that a file level backup set is to be updated. File level backup sets contain files and directories backup up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be updated. Image backup sets contain images created by the backup-archive client BACKUP IMAGE command.
Preview
Specifies whether to preview the list of backup sets to update, without actually updating the backup sets. This parameter is optional. The default is No. The values are:
No
Specifies that the backup sets are updated.
Yes
Specifies that the server displays the backup sets to update, without actually updating the backup sets.
VERSion
Specifies the version of the backup set to update. Backup sets with the same prefix name are considered to be different versions of the same backup set. This parameter is optional. The default is to update any version that matches the criteria specified on the command. The values are:
Any
Specifies that any version that matches the criteria specified on the command should be updated.
Latest
Specifies that only the most recent version of the backup set should be updated. If other criteria specified on the command (for example, ENDDATE or WHERERETENTION) exclude the most recent version of the backup set, then no backup set will be updated.

Example: Update a retention period

Update the retention period where the description is Healthy Computers. The retention period is assigned to backup set PERS_DATA.3099 that contains data from client node JANE. Change the retention period to 70 days.
update backupset jane pers_data.3099
retention=70 wheredescription="healthy computers"

Related commands

Table 1. Commands related to UPDATE BACKUPSET
Command Description
DEFINE BACKUPSET Defines a previously generated backup set to a server.
DEFINE NODEGROUP Defines a group of nodes.
DEFINE NODEGROUPMEMBER Adds a client node to a node group.
DELETE BACKUPSET Updates a retention value associated with a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
GENERATE BACKUPSET Generates a backup set of a client's data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup set.
QUERY BACKUPSET Displays backup sets.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE NODEGROUP Updates the description of a node group.