QUERY RETSETCONTENTS (Query the contents of a retention set)

Use this command to display information about the objects in one or more retention sets. For each object in a retention set, you can view the node and file space information. You can filter the list of objects that are displayed by specifying a retention set ID or by specifying filtering values for retention set attributes.

Privilege class

Any administrator can issue this command.

Syntax

Notes:

¹ You must specify either a retention set ID, a node name, or a retention rule name.
² The filespace_name must correspond to an IBM Spectrum Protect for Virtual Environments virtual machine. If you specify a file space name, you can specify only one fully qualified node name. Instead of specifying a file space name, you can specify the name of the virtual machine.

Parameters

retset_id

Specifies the ID of a retention set whose contents you want to query. The retention set ID is a unique numeric value. This parameter is optional. If you specify a retention set ID, you cannot specify either the NODENAME or the RETRULENAME parameters.

NOdename

Specifies a node or node group to which the retention set applies. This parameter is optional. You can use wildcard characters to specify this name.

FIlespace

Specifies the name of a file space or file spaces on a virtual machine to be queried. This parameter is optional. The filespace name can include wildcard characters if the NAMETYPE and the CODETYPE parameter values are not specified. 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. For example, if the filespace name is 71256,4, specify 71256,4 nametype=fsid.

Tip: Issue the QUERY FILESPACE command to determine which file spaces and file space IDs are defined for a node on the server.

NAMEType

Specifies how you want the server to interpret the file space names that you enter.

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

SERVER: The server uses the server's code page to interpret the file space name.
UNIcode: The server converts the file space 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 can fail 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 file space name as the file space ID (FSID).

CODEType

Specify how you want the server to interpret the file space names that you enter. The default value is BOTH, meaning that file spaces are included regardless of code page type. Use this parameter only when you enter a single wildcard character for the file space name. You can specify one of the following values:

UNIcode: Specifies only file spaces that are in Unicode.
NONUNIcode: Specifies only file spaces that are not in Unicode.
BOTH: Specifies all file spaces regardless of code page type.

RETRulename

Specifies the name of the retention rule that triggered the creation of the retention set. This parameter is optional. If you do not specify this parameter, the query output includes all retention rules.

COUnt

Specifies the number of files to display in the query output. This parameter is optional.

Format

Specifies how the information is displayed. This parameter is optional. The default value is STANDARD. You can specify one of the following values:

Standard: Specifies that partial information is displayed.
Detailed: Specifies that complete information is displayed.

Example: Display information about the contents of a retention set

Display detailed information about the contents of retention set 35. See Field descriptions for field descriptions.

query retsetcontents 35


Retention     Node Name              Filespace      Client's Name for File  
Set ID                               Name
---------     ------------------     ----------     ------------------------------------------
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\SQL
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\ADDRESS\GWISE\I386
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\BASICS
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\GIF
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\BIN
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\LIB
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE5\BASICS
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE\TSM533C-
                                                     .0213FA_EXPRESS_EXCHANGE_CD\TDPEXCHANGE\-
                                                     WIN32\CLIENT
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE\TSM533C-
                                                     .0213FA_EXPRESS_EXCHANGE_CD\TDPEXCHANGE\-
                                                     WIN32\LANGUAGES
35            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\ARA

Example: Display information about the contents of all retention sets created by a particular retention rule

Display detailed information about the contents of all retention sets that were created by the retention rule that is named MONTHLY. See Field descriptions for field descriptions.

query retsetcontents retrulename=monthly



Retention     Node Name              Filespace      Client's Name for File
Set ID                               Name
---------     ------------------     ----------     ------------------------------------------
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\SQL
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\ADDRESS\GWISE\I386
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\BASICS
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\GIF
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\BIN
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\LIB
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE5\BASICS
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE\TSM533C-
                                                     .0213FA_EXPRESS_EXCHANGE_CD\TDPEXCHANGE\-
                                                     WIN32\CLIENT
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE\TSM533C-
                                                     .0213FA_EXPRESS_EXCHANGE_CD\TDPEXCHANGE\-
                                                     WIN32\LANGUAGES


Retention     Node Name              Filespace      Client's Name for File
Set ID                               Name
---------     ------------------     ----------     ------------------------------------------
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\SQL
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\ADDRESS\GWISE\I386
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\BASICS
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE3\GIF
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\BIN
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\CLIENT\TSM533C.0-
                                                     216FA_EXPRESS_CLIENT_CD\DISK1\_JRE\LIB
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\SPA\IE5\BASICS
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.3.7\EXCHANGE\TSM533C-
                                                     .0213FA_EXPRESS_EXCHANGE_CD\TDPEXCHANGE\-
                                                     WIN32\CLIENT
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\5.
37            FILEMAN                \\lambo\k$     \TESTFILES\EXPRESS\E3SP1ENG\SETUP\I386\EX-
                                                     CHANGE\EXCHWEB\HELP\ARA

Field descriptions

Retention Set ID: The number that is associated with the retention set.
Node Name: The name of the node that is associated with the retention set.
Filespace Name: The name of the file space that is associated with the retention set.
Client's Name for File: The name by which the objects in a retention set are known by the client.

Related commands

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