SET TOCLOADRETENTION (Set load retention period for table of contents)

Use this command to specify the approximate number of minutes that unreferenced table of contents data will remain loaded in the server database.

During NDMP-controlled backup operations of NAS file systems, the server can optionally collect information about files and directories in the image and store this information in a table of contents within a storage pool. The IBM Spectrum® Protect backup-archive client graphical user interface (GUI) can be used to examine files and directories in one or more file-system images by displaying entries from the table of contents data. The server loads the necessary table of contents data into a temporary database table.

After the data is loaded, the user can then select those files and directories to be restored. Because this database table is temporary, the data remains loaded only for a specified time since the last reference to that data. At installation, the retention time is set to 120 minutes. Use the QUERY STATUS command to see the table of contents load retention time.

Privilege class

To issue this command, you must have system privilege.

Syntax

Read syntax diagramSkip visual syntax diagramSet TOCLOADRetentionminutes

Parameters

minutes (Required)
Specifies the approximate number of minutes that an unreferenced table of contents data is retained in the database. You can specify an integer from 30 to 1000.

Example: Define the load retention period for the table of contents

Use the command, SET TOCLOADRETENTION, to specify that unreferenced table of contents data is to be retained in the database for 45 minutes.
set tocloadretention 45

Related commands

Table 1. Commands related to SET TOCLOADRETENTION
Command Description
QUERY STATUS Displays the settings of server parameters, such as those selected by the SET commands.