RECLAIM STGPOOL (Reclaim volumes in a sequential-access storage pool)

Use this command to reclaim volumes in a sequential-access storage pool. Reclamation does not move inactive versions of backup data from volumes in active-data pools.

This command cannot be used for the following types of storage pools:
  • Container-copy storage pools. Space in these storage pools is reclaimed as part of the processing that is done by PROTECT STGPOOL commands.
  • Storage pools with one of the following data formats:
    • NETAPPDUMP
    • CELERRADUMP
    • NDMPDUMP
  • Storage pools that use a CENTERA device class.
  • Storage pools that use a Write Once Read Many (WORM) device class. Reclamation is not necessary because WORM volumes are not reusable, but you can run reclamation to consolidate data onto fewer volumes.

Use this command only if you are not going to use automatic reclamation for the storage pool. This command accepts the values of the RECLAIMPROCESS and RECLAIMSTGPOOL attributes of the storage pool definition. This command also accepts the values of the OFFSITERECLAIMLIMIT and RECLAIM parameters of the storage pool definition, if not overridden by the OFFSITERECLAIMLIMIT and THRESHOLD command parameters.

Tips:
  • When you issue this command, duplicate data in a primary storage pool, copy storage pool, or active-data pool that is set up for data deduplication is removed.
  • When you use this command to restore deduplicated objects to the same storage pool, any duplicate data blocks are replaced with references to deduplicated extents.

For storage pools defined with RECLAMATIONTYPE=SNAPLOCK, this command also deletes empty WORM FILE volumes that exceeded their reclaim period.

Privilege class

To issue this command, you must have system privilege, unrestricted storage privilege, or restricted storage privilege for the storage pool that is being reclaimed and the reclaim storage pool, if applicable.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-RECLaim STGpool--pool_name--+----------------------+--------->
                               '-THreshold--=--number-'   

                             .-Wait--=--No------.   
>--+----------------------+--+------------------+--------------->
   '-DUration--=--minutes-'  '-Wait--=--+-No--+-'   
                                        '-Yes-'     

>--+-------------------------------------------+---------------><
   '-OFFSITERECLAIMLimit--=--number_of_volumes-'   

Parameters

pool_name (Required)
Specifies the storage pool in which volumes are to be reclaimed.
DUration
Specifies the maximum number of minutes that the reclamation runs before it is automatically canceled. You can specify a number 1 - 9999. This parameter is optional.

After the specified number of minutes elapses, the next time the server checks the reclamation process the server stops the reclamation process. The server checks the reclamation process when the server mounts another eligible volume from the storage pool that is being reclaimed. The server also checks the reclamation process when the server begins to reclaim a new batch of files from the currently mounted volume. As a result, the reclamation can run longer than the value you specified for this parameter.

Until the server checks the reclamation process, there is no indication the duration period expired. When the server stops the reclamation process, the server issues message ANR4927W: Reclamation terminated for volume xxx - duration exceeded.

If you do not specify this parameter, the process stops only when no more volumes meet the threshold.

If you specify a duration value for reclamation of a copy storage pool with offsite volumes, you might cause the reclamation to end before any volumes are reclaimed. In most situations when you initiate reclamation for a copy storage pool with offsite volumes, consider limiting the number of offsite volumes to be reclaimed rather than limiting the duration. For details, see the OFFSITERECLAIMLIMIT parameter.

THreshold
Specifies the percentage of reclaimable space on a volume that makes it eligible for reclamation. Reclaimable space is the amount of space that is occupied by files that are expired or deleted from the server database. Reclaimable space also includes unused space.

You can specify a number 1 - 99. This parameter is optional. If not specified, the RECLAIM attribute of the storage pool definition is used.

To determine the percentage of reclaimable space for a volume, issue the QUERY VOLUME command and specify FORMAT=DETAILED. The value in the field Pct. Reclaimable Space is the percentage of reclaimable space for the volume.

Specify a value of 50 percent or greater for this parameter so that files stored on two volumes can be combined into a single target volume.

OFFSITERECLAIMLimit
Specifies the maximum number of offsite storage pool volumes that the server tries to reclaim. This parameter is valid only for copy storage pools. You can specify a number 0 - 99999. This parameter is optional. If not specified, the OFFSITERECLAIMLIMIT attribute of the storage pool definition is used.
Wait
Specifies whether to wait for the server to complete processing this command in the foreground. This parameter is optional. The default is NO. You can specify one of the following values:
No
Specifies that the server processes this command in the background.

You can continue with other tasks while the command is processed. Messages that are created from the background process are displayed either in the activity log or the server console, depending on where messages are logged.

If you cancel this process, some files might already be moved to new volumes before the cancellation.

Yes
Specifies that the server processes this command in the foreground. The operation must complete before you can continue with other tasks. Output messages are displayed to the administrative client when the operation completes. Messages are also displayed either in the activity log or the server console, or both, depending on where the messages are logged.
Restriction: You cannot specify WAIT=YES from the server console.

Example: Reclaim volumes in a sequential-access storage pool

Reclaim volumes in the storage pool named TAPEPOOL. Specify that reclamation ends as soon as possible after 60 minutes.
reclaim stgpool tapepool duration=60

Related commands

Table 1. Commands related to RECLAIM STGPOOL
Command Description
CANCEL PROCESS Cancels a background server process.
MIGRATE STGPOOL Migrates files from a primary storage pool to the next storage pool in the hierarchy.
MOVE DRMEDIA Moves DRM media onsite and offsite.
QUERY DRMEDIA Displays information about disaster recovery volumes.
QUERY PROCESS Displays information about background processes.
QUERY STGPOOL Displays information about storage pools.