QUERY BACKUPSET (Query a backup set)

Use this command to display information about one or more backup sets.

Privilege class

Any administrator can issue this command.

Syntax

Read syntax diagramSkip visual syntax diagramQuery BACKUPSET*,node_namenode_group_name*,backup_set_nameBEGINDate=dateBEGINTime=timeENDDate=dateENDTime=timeWHERERETention=daysNOLimitWHEREDESCription=descriptionWHEREDEVclass=device_class_nameWHERETOCexists=YesNoWHEREDATAType=,FILEIMAGEFormat=StandardFormat=StandardDetailed

Parameters

node_name or node_group_name
Specifies the name of the client node and node groups whose data is contained in the backup set to be displayed. 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.
backup_set_name
Specifies the name of the backup set whose information is to be displayed. 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.
BEGINDate
Specifies the beginning date of the range in which the point-in-time date of the backup set to be displayed must fall. This parameter is optional. 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 of the range in which the point-in-time date of the backup set to be displayed must fall. This parameter is optional. 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 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.
ENDDate
Specifies the ending date of the range in which the point-in-time date of the backup set to be displayed must fall. This parameter is optional. You can use this parameter with the ENDTIME parameter to specify an ending date and time. If you specify an end date without an end 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. The maximum number of days you can specify is 9999. 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 of the range in which the point-in-time date of the backup set to be displayed must fall. This parameter is optional. You can use this parameter with the ENDDATE parameter to specify a 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 must be associated with the backup sets to be displayed. You can specify an integer from 0 to 30000. The values are:
days
Specifies that backup sets that are retained this number of days are displayed.
NOLimit
Specifies that backup sets that are retained indefinitely are displayed.
WHEREDESCription
Specifies the description that must be associated with the backup set to be displayed. The description you specify can contain wildcard characters. This parameter is optional. Enclose the description in quotation marks if it contains any blank characters.
WHEREDEVclass
Specifies the name of the device class that must be associated with the backup set to be displayed. You can use wildcard characters to specify a device class name. This parameter is optional.
WHERETOCexists
Specifies whether a backup set must have a table of contents in order to be displayed. This parameter is optional. The default is to display all backup sets whether or not they have a table of contents.
WHEREDATAType
Specifies the data type of a backup set to be displayed. This parameter is optional. The default is to display all types of backup sets. To specify multiple data types, separate data types with commas and no intervening spaces.
FILE
Specifies that a file level backup set is to be displayed. File level backup sets contain files and directories backed up by the backup-archive client.
IMAGE
Specifies that an image backup set is to be displayed. Image backup sets contain images created by the backup-archive client BACKUP IMAGE command.
Format
Specifies how the information is displayed. This parameter is optional. The default value is STANDARD. Possible values are:
Standard
Specifies that partial information is displayed for the specified backup sets.
Detailed
Specifies that complete information is displayed for the specified backup sets.

Example: Query a backup set

Display information for backup sets whose names begin with PERS_DATA. The backup sets belong to the node JANE and are assigned to the DVLMENT device class.
query backupset jane pers_data*
                   Node Name: JANE
             Backup Set Name: PERS_DATA.3089
                   Data Type: File
                   Date/Time: 03/17/2007 16:17:47
            Retention Period: 60
           Device Class Name: DVLMENT
                 Description: backupset created from /srvr
Has Table of Contents (TOC)?: Yes

Example: Displayed detailed information about a backup set

Display detailed information about backup sets that belong to the node JANE.

query backupset jane f=d
                   Node Name: JANE
             Backup Set Name: PERS_DATA.3089
                   Data Type: File
                   Date/Time: 03/17/2007 16:21:49 AM
            Retention Period: 60
           Device Class Name: DVLMENT
                 Description: backupset created from /srvr
Has Table of Contents (TOC)?: Yes
             Filespace names: /home
                Volume names: /home/tsm/stg/79204720.ost

Field descriptions

Node Name
Specifies the name of the client node whose data is contained in the backup set.
Backup Set Name
Specifies the name of the backup set.
Data Type
Displays the data type of the backup sets. Possible types are file, image, and application.
Date/Time
Specifies the date and time (PITDate and PITTime) of the GENERATE BACKUPSET command. The PITDate and PITTime specify that files that were active on the specified date and time and that are still stored on the IBM Spectrum® Protect server are to be included in the backup set, even if they are inactive at the time you issue the GENERATE BACKUPSET command. The default is the date on which the GENERATE BACKUPSET command is run.
Retention Period
Specifies the number of days that the backup set is retained on the server.
Device Class Name
Specifies the name of the device class for which the volumes containing the backup set is assigned.
Description
Specifies the description associated with the backup set.
Has Table of Contents (TOC)?
Specifies whether the backup set has a table of contents.
Filespace names
Displays a list of the file spaces that are contained in the backup set.
Volume names
Displays a list of the volumes on which the backup set resides.

Related commands

Table 1. Commands related to QUERY 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.
GENERATE BACKUPSET Generates a backup set of a client's data.
GENERATE BACKUPSETTOC Generates a table of contents for a backup set.
DELETE BACKUPSET Deletes a backup set.
DELETE NODEGROUP Deletes a node group.
DELETE NODEGROUPMEMBER Deletes a client node from a node group.
QUERY BACKUPSETCONTENTS Displays contents contained in backup sets.
QUERY NODEGROUP Displays information about node groups.
UPDATE BACKUPSET Updates a retention value associated with a backup set.
UPDATE NODEGROUP Updates the description of a node group.