RESTORE STGPOOL (Restore storage pool data from a copy pool or an active-data pool)

Use this command to restore files from one or more copy storage pools or active-data pools to a primary storage pool.

Tivoli® Storage Manager restores all the primary storage pool files that:
  • Have been identified as having errors
  • Reside on a volume with an access mode of DESTROYED
Restriction: You cannot use this command for container storage pools. Use the REPLICATE STGPOOL command to protect data for container storage pools.

You can also use this command to identify volumes that contain damaged, primary files. During restore processing, a message is issued for every volume in the restored storage pool that contains damaged, non-cached files. Use the QUERY CONTENT command to identify damaged, primary files on a specific volume.

You cannot restore a storage pool defined with a CENTERA device class.

In addition to restoring data to primary storage pools that have NATIVE or NONBLOCK data formats, this command also lets you restore data to primary storage pools that have NDMP data formats (NETAPPDUMP, CELERRADUMP, or NDMPDUMP). The primary storage pool must have the same data format as the copy storage pool from which data is to be restored. Tivoli Storage Manager supports backend data movement for NDMP images.

Tip: To restore NAS client-node data to NAS storage pools, you must manually change the access mode of the volumes to DESTROYED using the UPDATE VOLUME command. However, if you are using disaster recovery manager, the plan file will contain the information the server needs to automatically mark the volumes as DESTROYED.
Restoration of files might be incomplete if backup file copies in copy storage pools or active-data pools were moved or deleted by other Tivoli Storage Manager processes during restore processing. To prevent this problem, do not issue the following commands for copy storage pool or active-data pool volumes while restore processing is in progress:
  • MOVE DATA
  • DELETE VOLUME (DISCARDDATA=YES)
  • AUDIT VOLUME (FIX=YES)
Also, you can prevent reclamation processing for your copy storage pools by setting the RECLAIM percentage to 100 with the UPDATE STGPOOL command.

Privilege class

To issue this command, you must have system privilege, unrestricted storage privilege, or restricted storage privilege for the primary storage pool for which files are to be restored. If you are a restricted storage administrator and you want to restore files to a new primary storage pool, you must also have authority for the new storage pool.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-RESTORE STGpool--primary_pool_name--------------------------->

>--+--------------------------------+--------------------------->
   '-COPYstgpool--=--copy_pool_name-'   

   .-ACTIVEDATAOnly--=--No-------------.   
>--+-----------------------------------+------------------------>
   '-ACTIVEDATAOnly--=--+-No---------+-'   
                        '-Yes--| A |-'     

>--+--------------------------------------+--------------------->
   '-NEWstgpool--=--new_primary_pool_name-'   

   .-MAXPRocess--=--1------.  .-Preview--=--No------.   
>--+-----------------------+--+---------------------+----------->
   '-MAXPRocess--=--number-'  '-Preview--=--+-No--+-'   
                                            '-Yes-'     

   .-Wait--=--No------.   
>--+------------------+----------------------------------------><
   '-Wait--=--+-No--+-'   
              '-Yes-'     

A (Yes)

|--ACTIVEDATAPool--=--active-data_pool_name---------------------|

Parameters

primary_pool_name (Required)
Specifies the name of the primary storage pool that is being restored.
COPYstgpool
Specifies the name of the copy storage pool from which the files are to be restored. This parameter is optional. If this parameter is not specified, files are restored from any copy pool in which copies can be located. Do not use this parameter with the ACTIVEDATAONLY or ACTIVEDATAPOOL parameters.
ACTIVEDATAOnly
Specifies that active versions of backup files are to be restored from active-data pools only. This parameter is optional. The default is NO. If this parameter is not specified, files are restored from copy-storage pools. Do not use this parameter with the COPYSTGPOOL parameter. Possible values are:
No
Specifies that the storage pool will not be restored from active-data pools.
Yes
Specifies that the storage pool will be restored from active-pool or pools that you specify using the ACTIVEDATAPOOL parameter. If you specify YES as a value for ACTIVEDATAONLY, but do not specify a value for ACTIVEDATAPOOL, files are restored from any active-data pool in which active versions of backup files can be located.
Attention: Restoring a primary storage pool from an active-data pool might cause some or all inactive files to be deleted from the database if the server determines that an inactive file needs to be replaced but cannot find it in the active-data pool.
ACTIVEDATAPool
Specifies the name of the active-data pool from which the active versions of backup files are to be restored. This parameter is optional. If this parameter is not specified, files are restored from any active-data pool in which active versions of backup files can be located.
NEWstgpool
Specifies the name of the new storage pool to which to restore the files. This parameter is optional. If this parameter is not specified, files are restored to the original primary storage pool (the pool being restored).
MAXPRocess
Specifies the maximum number of parallel processes that are used for restoring files. Using multiple, parallel processes may improve throughput for the restore. This parameter is optional. You can specify a value from 1 to 999. The default is 1.

When determining this value, consider the number of mount points (logical drives) and physical drives that can be dedicated to this operation. To access a sequential access volume, Tivoli Storage Manager uses a mount point, and, if the device type is not FILE, a physical drive. The number of available mount points and drives depends on other Tivoli Storage Manager and system activity and on the mount limits of the device classes for the sequential access storage pools that are involved in the restore.

Each process needs a mount point for copy storage pool volumes, and, if the device type is not FILE, each process also needs a drive. If you are restoring files in a sequential storage pool, each process needs an additional mount point for primary storage pool volumes and, if the device class is not FILE, an additional drive. For example, suppose you specify a maximum of 3 processes to restore a primary sequential storage pool from a copy storage pool of the same device class. Each process requires two mount points and two drives. To run all three processes, the device class must have a mount limit of at least 6, and at least 6 mount points and 6 drives must be available.

To preview a restore, only one process is used and no mount points or drives are needed.

Preview
Specifies if you want to preview but not perform the restore. The preview lets you identify volumes required to restore the storage pool. The preview displays:
  • A list of primary storage pool volumes that contain damaged files.
  • The number of files and the number of bytes to be restored, assuming that the access mode of the required copy storage pool volumes is READWRITE or READONLY when the restore operation is performed.
  • A list of copy storage pool volumes containing files to be restored. These volumes must be mounted if you perform the restore.
  • A list of any volumes containing files that cannot be restored.
Note: For only a list of offsite copy storage pool volumes to be mounted during a restore, change the access mode of the copy pool volumes to UNAVAILABLE. This prevents reclamation and move data processing of the volumes until they are moved onsite for the restore.
This parameter is optional. The default is NO. Possible values are:
No
Specifies that the restore is done.
Yes
Specifies that you want to preview the restore but not do the restore.
Wait
Specifies whether to wait for the server to complete processing this command in the foreground. This parameter is optional. The default is NO. Possible values are:
No
Specifies that the server processes this command in the background.

You can continue with other tasks while the command is being processed.

Messages created from the background process are displayed either in the activity log or the server console, depending on where messages are logged. To cancel a background process, use the CANCEL PROCESS command. If you cancel this process, some files may have already been restored prior to the cancellation.

Yes
Specifies that the server performs this operation in the foreground. The operation must complete before you can continue with other tasks. The server then displays the output messages to the administrative client when the operation completes.
Note: You cannot specify WAIT=YES from the server console.

Example: Restore files from a copy storage pool to the primary storage pool

Restore files from any copy storage pool to the primary storage pool, PRIMARY_POOL.
restore stgpool primary_pool

Example: Restore files from a specific active-data pool to the primary storage pool

Restore files from active-data pool ADP1 to the primary storage pool PRIMARY_POOL.
restore stgpool primary_pool activedataonly=yes activedatapool=adp1

Related commands

Table 1. Commands related to RESTORE STGPOOL
Command Description
BACKUP STGPOOL Backs up a primary storage pool to a copy storage pool.
CANCEL PROCESS Cancels a background server process.
COPY ACTIVEDATA Copies active backup data.
QUERY CONTENT Displays information about files in a storage pool volume.
QUERY PROCESS Displays information about background processes.
RESTORE VOLUME Restores files stored on specified volumes in a primary storage pool from copy storage pools.
UPDATE STGPOOL Changes the attributes of a storage pool.
UPDATE VOLUME Updates the attributes of storage pool volumes.