The client program includes a group of client command options that you can enter with specific commands only from the command line. You can also enter common options to override many of the options set in your client options file. Options are processed following this precedence (order):
For a complete list of client command options, their descriptions, the commands with which you can use them, and the location in this book for more information, see Figure 26. For a complete list of common options, see Chapter 8, "Setting Common Options".
Follow these general rules when you enter options with a command:
dsmc archive -description="year end 1999" /home/
dsmc incremental -quiet
dsmc selective -subdir=yes /devel/proj1/ dsmc selective /devel/proj1/ -subdir=yes
Figure 26. Client Command Options
Command Option | Description | Commands | Page |
---|---|---|---|
archmc | Overrides the default management class for a file or a group of files. | Archive | Archmc |
deletefiles | Deletes the local copy of files from your workstation after they are archived on the server. Can also be used with the restore image command and the incremental option to delete files from the restored image that are deleted from the filespace after the image is created. |
Archive Restore Image | Deletefiles |
description | Specifies a description for a file that you are archiving, deleting, or retrieving. Also specifies the description of a backupset that you want to restore or query. |
Archive Delete Archive Query Archive Query Backupset Restore Backupset Retrieve | Description |
detail | Displays management class attributes for available management classes. | Query Mgmtclass | Detail |
dirsonly | Backs up, restores, archives, retrieves, or displays directories only. |
Archive Incremental Query Archive Query Backup Restore Retrieve Selective | Dirsonly |
filesonly | Backs up, restores, retrieves, or displays files only. |
Incremental Query Archive Query Backup Restore Retrieve Selective | Filesonly |
fromdate | Sets a date limit for files. Tivoli Storage Manager does not include files processed before this date when it processes the command, although older directories might be included. |
Query Archive Query Backup Restore Retrieve Restore Image | Fromdate |
fromnode | Displays file spaces for an alternate node. Also specifies an alternate node from which to restore or retrieve files. |
Query Archive Query Backup Query Filespace Query Mgmtclass Restore Retrieve Query Image Restore Image | Fromnode |
fromowner | Displays file spaces for an alternate owner. Also specifies an alternate owner from which to restore or retrieve files. |
Query Archive Query Backup Restore Retrieve Query Image Restore Image | Fromowner |
fromtime | Specifies a beginning time on the specified date. Use with the fromdate option. This option is ignored if the fromdate option is absent. |
Query Archive Query Backup Restore Retrieve Restore Image | Fromtime |
ifnewer | Replaces existing files with the latest backup version only if the backup version is newer than the existing version. |
Restore Retrieve | Ifnewer |
inactive | Processes inactive backup versions of files. |
Query Backup Restore | Inactive |
incrbydate | Requests an incremental backup by date. | Incremental | Incrbydate |
incremental | Applies changes to the base image using information from incremental backups made after the original image backup. | Restore Image | Incremental |
latest | Restores the most recent backup version of a file whether it is active or inactive. | Restore | Latest |
location | Specifies whether to locate backup sets on the server or in local files. |
Query Backupset Restore Backupset | Location |
mode | Specifies whether an image backup is performed on an entire file system or only those files that changed after the original image backup. | Backup Image | Mode |
noprompt | Suppresses the confirmation prompt when deleting an archived file. | Delete Archive | Noprompt |
pick | Displays a list of files from which you can select files to delete, restore, or retrieve. |
Delete Archive Restore Retrieve Restore Image | Pick |
pitdate | Specifies the file backup date to use when Tivoli Storage Manager selects files to restore. Use with the pittime option. |
Query Backup Restore Restore Image | Pitdate |
pittime | Specifies a point in time on the specified date. Use with the pitdate option. This option is ignored if the pitdate option is absent. |
Query Backup Restore Restore Image | Pittime |
preservepath | Specifies how the restore directory path is built. |
Restore Retrieve | Preservepath |
todate | Sets a date limit for files. Tivoli Storage Manager does not include files that are processed after this date. Use with the totime option. |
Query Archive Query Backup Restore Retrieve Restore Image | Todate |
totime | Specifies an ending time on the specified date. Use with the todate option. This option is ignored if the todate option is absent. |
Query Archive Query Backup Restore Retrieve Restore Image | Totime |
volinformation | Backs up or restores volume restrictions, such as volume or disk space restrictions and trustee directory assignments for the root directory of a volume. |
Archive Incremental Restore Retrieve Selective | Volinformation |
Options
The archmc option specifies the available management class for a file or a group of files in the active policy set of your policy domain to which you want to bind your archived files.
Syntax
>>-ARCHMc- managementclass-------------------------------------><
Parameters
Examples
Options
The deletefiles option can be used with the archive command to delete archived files from your workstation after they are archived on the server.
This option can also be used with the restore image command and the incremental option to delete files from the restored image that are deleted from the file space after the image is created.
Syntax
>>-DELetefiles-------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
dsmc archive "/home/foo/*.c" -deletefiles
dsmc restore image /local/data -incremental -deletefiles
Options
The description option assigns or specifies a description for files on which you are performing archive, delete, retrieve, or query archive functions. You can also use this option to specify the description of a backup set that you want to restore or query. For example, if you want to archive a file named budget.jan and assign to it the description 1998 Budget for Proj 1, you would enter:
dsmc archive -des="1998 Budget for Proj 1" /home/plan/proj1/budget.jan
Syntax
>>-DEScription- description------------------------------------><
Parameters
If you use the archive command to archive more than one file, the description you enter is assigned to each of the files. For example, to archive a group of files and assign the same description, Project X, to each file, you would enter:
dsmc archive -description="Project X" "/home/allproj/.*"
You can then use the description to retrieve all of the files.
Examples
Options
The detail option displays detailed information about each management class in your active policy set. If you do not use the detail option, only the management class name and a brief description are displayed. If you specify the detail option, information is displayed about attributes in each copy group contained in each management class. A management class can contain a backup copy group, an archive copy group, both, or neither.
Syntax
>>-DETail------------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The dirsonly option processes directories only. Files are not processed.
Syntax
>>-DIrsonly----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The filesonly option processes files only. Directories are not processed. When the filesonly option is used with either the restore or retrieve command, directories are not sent from the server. However, directories with default attributes are created, if required, as placeholders for files that are being restored or retrieved.
Syntax
>>-FILESOnly---------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The fromdate option specifies a date from which you want to search for backed up or archived files. Files that were backed up or archived before this date are not included, although older directories might be included, if necessary, to restore or retrieve the files.
Syntax
>>-FROMDate- date----------------------------------------------><
Parameters
When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.
Examples
Options
The fromnode option permits one node to perform commands for another node. A user on another node must use the set access command to permit you to query, list, restore, or retrieve files or images for that other node.
Syntax
>>-FROMNode- node----------------------------------------------><
Parameters
Examples
Options
The fromowner option specifies an alternate owner from which to restore files or images. The owner must give access to another to use the files or images. For example, to restore files from the /home/devel/proja directory belonging to usermike on system puma, and place the restored files in a directory you own named /home/id/proja, you would enter:
dsmc restore -fromowner=usermike -fromnode=puma /home/devel/proja/ /home/id/proja/
Non root users can specify -fromowner=root to access files owned by the root user if the root user has granted them access.
Note: | If you specify the fromowner option without the fromnode option, the active user must be on the same system as the fromowner user. |
Syntax
>>-FROMOwner- owner--------------------------------------------><
Parameters
Examples
Options
The fromtime option, used with the fromdate option, specifies a beginning time. This option is ignored if the fromdate option is not specified.
Syntax
>>-FROMTime- time----------------------------------------------><
Parameters
When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.
Examples
Options
The ifnewer option replaces an existing file with the backup if the backup is newer than the existing file. Only active backups are considered unless you also use the inactive or latest options.
Note: | This option is ignored if the replace option is set to No. |
Syntax
>>-IFNewer-----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The inactive option is used with the restore, restore image, query image, and query backup commands, and the pick option, to display active and inactive objects.
You can also use the pick option to display backup versions, archive copies, and images that match the file specification you enter.
Only active backups are considered unless you also use either the inactive or the latest option.
Syntax
>>-INActive----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
Important: | Run a complete incremental backup periodically without the incrbydate option. For example, perform an incremental-by-date backup on weekdays. Then, on weekends when there is more time, perform a full incremental backup. See the limitations listed below. |
The incrbydate option performs an alternate method of incremental backup that is faster, but not as complete, when you use it with the incremental command. Files are backed up only if the file modification date is later than the date and time of the last incremental backup of the entire file system in which the file resides.
If you use the incremental command without this option, the client program queries the server for a list of file attributes for all active files that are currently stored on the server. This information determines which files to back up.
If you use the incremental command with this option on part of a file system, the date of the last incremental backup is not updated and a second incremental by date backup will back up the files again.
The following list describes limitations of the incrbydate option:
Syntax
>>-INCRbydate--------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The incremental option can be used with the restore image command to specify that changes to the base image recorded at the server after the original image was backed up, are applied to the restored image. If you also use the deletefiles option, changes include the deletion of files and directories.
Syntax
>>-INCREmental-------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The latest option restores the most recently backed up version of a file, even if the backup is inactive. Only active versions are considered for a restore unless you use either the inactive or the latest option.
Syntax
>>-LATest------------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The location option specifies where TSM searches for the backup set for a query or restore operation. You can use this option to locate backup sets on the server or local files. Tapes that are generated on the server can be used locally by specifying location=tape and the device name.
Syntax
.-server--. >>-LOCation-+---------+---------------------------------------->< +-file----+ '-tape----'
Parameters
Examples
dsmc restore backupset mybackupsetname -loc=server
The mode option specifies whether a full image back up is performed or only an incremental back up of files changed or created since the last full image backup. The mode option has no effect on a raw logical device backup.
Syntax
.-Selective---. >>-MODE-+-------------+---------------------------------------->< '-Incremental-'
Parameters
Examples
dsmc backup image /usr -mode=s
dsmc ba im -mode=i /home
Options
Use this option with caution.
The noprompt option suppresses the confirmation prompt that normally appears before an archived file is deleted. Using this option can speed up the delete procedure. However, it also increases the danger of accidentally deleting an archived file that you wanted to save.
Syntax
>>-NOPrompt----------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The pick option displays a list of backup versions, images, or archive copies that match the file specification you enter. From the list, you can select the versions to process. Select the inactive option to view both active and inactive objects.
For images, if a source file space and image file space are not specified, the pick list contains all backed up images. In this case, the images selected from the pick list are restored to their original location. If the source file space and the destination file space are specified, only one entry from the pick list may be selected.
Syntax
>>-PIck--------------------------------------------------------><
Parameters
There are no parameters for this option.
Examples
Options
The pitdate option, used with the pittime option, establishes a point in time for which you want to display or restore the latest version of your backups. Files or images that were backed up on or before the date and time you specified, and which were not deleted before the date and time you specified, are processed. Backup versions that you create after this date and time are ignored.
Syntax
>>-PITDate- date-----------------------------------------------><
Parameters
When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.
Examples
Options
The pittime option, used with the pitdate option, establishes a point in time for which you want to display or restore the latest version of your backups. Files or images that were backed up on or before the date and time you specified, and which were not deleted before the date and time you specified, are processed. Backup versions that you create after this date and time are ignored. This option is ignored if the pitdate option is not specified.
Syntax
>>-PITTime- time-----------------------------------------------><
Parameters
When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.
Examples
Options
The preservepath option specifies how much of the source path to reproduce as part of the target directory path when you restore files to a new location. Use the -subdir=yes option setting to include the entire subtree of the source directory (directories and files below the lowest-level source directory) as source to be restored. If a required target directory does not exist, it is created. If a target file has the same name as a source file, it is overwritten. Use the -replace=prompt option setting to have Tivoli Storage Manager prompt you before files are overwritten.
Syntax
.-subtree--. >>-PRESERvepath-+----------+----------------------------------->< +-complete-+ +-nobase---+ '-none-----'
Parameters
If you specify subdir=yes, all files in the source directories are restored to the single target directory.
Examples
/fs/h1/m1/file.a /fs/h1/m1/file.b /fs/h1/m1/l1/file.x /fs/h1/m1/l1/file.y
Figure 27. Preservepath Examples
This command: | Restores these directories and files: |
---|---|
dsmc res /fs/h1/m1/ /u/ann/ -preservep=complete |
/u/ann/h1/m1/file.a /u/ann/h1/m1/file.b |
dsmc res /fs/h1/m1/ /u/ann/ -preservep=nobase |
/u/ann/file.a /u/ann/file.b |
dsmc res /fs/h1/m1/ /u/ann/ -preservep=subtree |
/u/ann/m1/file.a /u/ann/m1/file.b |
dsmc res /fs/h1/m1/ /u/ann/ -preservep=none |
/u/ann/file.a /u/ann/file.b |
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preservep=complete |
/u/ann/h1/m1/file.a /u/ann/h1/m1/file.b /u/ann/h1/m1/l1/file.x /u/ann/h1/m1/l1/file.y |
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preservep=nobase |
/u/ann/file.a /u/ann/file.b /u/ann/l1/file.x /u/ann/l1/file.y |
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preservep=subtree |
/u/ann/m1/file.a /u/ann/m1/file.b /u/ann/m1/l1/file.x /u/ann/m1/l1/file.y |
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preservep=none |
/u/ann/file.a /u/ann/file.b /u/ann/file.x /u/ann/file.y |
Options
The todate option, used with the totime option, specifies an ending date and time. For example, you might request a list of files that were backed up before 11:59 PM on June 30, 1998.
Use the todate and totime options with the fromtime and fromdate options to request a list of backed up or archived files within a period of time. For example, you might request a list of files that were backed up between 6:00 AM on July 1, 1998 and 11:59 PM on July 30, 1998.
Syntax
>>-TODate- date------------------------------------------------><
Parameters
When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.
Examples
Options
The totime option, used with the todate option, specifies an ending time on a specified date. For example, you might request a list of files that were backed up before 11:59 PM on June 30, 1998. This option is ignored if the todate option is not specified.
Use the totime and todate options with the fromtime and fromdate options to request a list of files that were backed up within a period of time. For example, you might request a list of files that were backed up between 6:00 AM on July 1, 1998 and 11:59 PM on July 30, 1998.
Syntax
>>-TOTime- time------------------------------------------------><
Parameters
When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.
Examples
Options
The volinformation option backs up or archives root-level information. This option applies only when you back up or restore non-root files..
Specify volinformation either with the selective or the archive command, or any incremental command that does not target the entire volume. Entering the incremental command on an entire volume implicitly backs up the root-level information.
Do not use the volinformation option with the restore or the retrieve command; the root-level information is restored or retrieved implicitly.
Syntax
>>-VOLinformation----------------------------------------------><
Parameters
There are no parameters for this option.
Examples