Restore Backupset

Supported Clients

This command is valid for all clients.

Parameters

{filespacename}

Specifies the file space (enclosed in braces) on the server that contains the files you want to restore. This is the name on the workstation drive from which the files were backed up, or the virtual file space name for a group.

Specify a file space name when you restore a backup set containing a group.

Specify a file space name when the sourcefilespec does not exist on the target computer. This can occur if the drive label name has changed or if you are restoring files that were backed up from another node that had drive labels that are different from yours.

Note: You must specify a mixed or lowercase NTFS or ReFS file space name that is enclosed in quotation marks and braces. For example, {"NTFSDrive"}. Single quotation marks are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotation marks are valid. The single quotation marks requirement is a restriction of the operating system.

sourcefilespec

Specifies the source path of a portion of the backup set. The default is to restore the entire backup set.

destinationfilespec

Specifies the destination path for the restored files. If you do not specify a sourcefilespec, you cannot specify a destinationfilespec. If you do not specify a destination, the backup-archive client restores the files to the original source path. If you are restoring more than one file, you must end the file specification with a directory delimiter (/), otherwise, the client assumes that the last name is a file name and reports an error. If you are restoring a single file, you can optionally end the destination file specification with a file name if you want to give the restored file a new name. When the sourcefilespec does not exist on the target workstation, you must specify destinationfilespec.

-BACKUPSETName=

Specifies the name of the backup set from which to perform a restore operation. You cannot use wildcard characters to specify the backup set name. The value of backupsetname depends on the location of the backup set, and corresponds to one of the following three choices:

backupsetname

Specifies the name of the backup set on the server from which to perform a restore operation. If location option is specified, you must set -location=server.

localfilename

Specifies the file name of the first backup set volume. You must set -location=file.

tapedevice

Specifies the name of the tape device containing the backup set volume. You must use a Windows-provided device driver, not the device driver that is provided by IBM. You must set -location=tape.

-LOCation=

Specifies the location of the backup set. If you do not specify the location parameter, the client searches for backup sets on the IBM Storage Protect server. If you specify the location parameter, the value must be one of the following three choices:

server

Specifies that the backup set is on the IBM Storage Protect server. Server is the default location.

file

Specifies that the backup set is on an available file system.

tape

Specifies that the backup set is on an available tape device.

Table 1. Restore Backupset command: Related options

Option	Where to use
dirsonly	Command line only.
filesonly	Command line only.
ifnewer	Command line only.
preservepath	Command line only.
quiet	Client options file (dsm.opt) or command line.
quiet	Client user options file (dsm.opt) or command line.
replace	Client options file (dsm.opt) or command line.
replace	Client user options file (dsm.opt) or command line.
skipntpermissions	Client options file (dsm.opt) or command line.
subdir	Client options file (dsm.opt) or command line.
subdir	Client user options file (dsm.opt) or command line.