Tivoli Storage Manager for UNIX Using the Backup-Archive Clients


Chapter 9. Using Options With Commands

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):

  1. Options defined on the server with server-enforced client options. The client cannot override the value.
  2. Options entered locally on the command line.
  3. Options defined on the server for a schedule using the options parameters.
  4. Options entered locally in the options file.
  5. Options received from the server with client options not enforced by the server. The client can override the value.
  6. Default option values.

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 27. For a complete list of common options, see Chapter 8, "Setting Common Options".


Entering Options With a Command

Follow these general rules when you enter options with a command:


Figure 27. 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 file space 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 query.
archive
delete archive
query archive
query 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, although older directories might be included.
query archive
query backup
restore
retrieve
restore image
query 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
query image
restore
restore image
retrieve

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

Fromtime
ifnewer Replaces existing files with the latest backup version only if the backup version is newer than the existing version.
restore
restore backupset
retrieve

Ifnewer
inactive Processes inactive backup versions of files.
query backup
restore
query image
restore image

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
restore backupset
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

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

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
selective

Volinformation

Command Line Options Reference

The following sections contain detailed information about each of the TSM command line options. These options are arranged in alphabetical order. Information for each option includes:

Archmc

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

managementclass
Specifies an available management class in the active policy set of your policy domain. This management class overrides the default management class for the files you are archiving.

Examples

Command line:
dsmc archive -archmc=RET2YRS /home/
plan/proj1/budget.jan

Deletefiles

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 if they were deleted from the file space after the image was created.

Syntax

>>-DELetefiles-------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc archive "/home/foo/*.c" -deletefiles
dsmc restore image /local/data -incremental -deletefiles

Description

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 query. For example, if you want to archive a file named budget.jan and assign to it the description 1999 Budget for Proj 1, you would enter:

   dsmc archive -des="1999 Budget for Proj 1" /home/plan/
   proj1/budget.jan

Syntax

>>-DEScription- description------------------------------------><
 

Parameters

description
Assigns a description to the file you are archiving. If a description is not provided, the default is archive date:x, where x is the current system date.

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

Command line:
dsmc archive "/home/foo/*.prj" 
-des="1999 Budget for Proj 1"

Detail

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

Command line:
dsmc query mgmtclass -detail

Dirsonly

The dirsonly option processes directories only. Files are not processed.

Syntax

>>-DIrsonly----------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc query backup -dirsonly "*"

Filesonly

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

Command Line:
dsmc incremental -filesonly

Fromdate

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

date
Specifies the date from which you want to search for backup copies or archived files. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc query backup -fromdate=12/11/1999 /home/dilbert/*

Fromnode

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

node
Specifies the node name on a workstation or a file server whose backup copies or archived files you want to access.

Examples

Command line:
dsmc query archive -fromnode=bob -subdir=yes 
"/home/jones/*"

Fromowner

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

owner
Name of an alternate owner.

Examples

Command line:
dsmc query archive "/home/id/proja/*" -fromowner=mark

Fromtime

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

time
Specifies a beginning time on a specific date. If you do not specify a time, the time defaults to 23:59:59. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc q b -fromt=11:59AM -fromd=06/30/99 -tot=11:59PM -tod=06/30/99

Ifnewer

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

Command line:
dsmc restore "/home/grover/*" -sub=y -rep=y -ifnewer

Inactive

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

Command line:
dsmc restore "/home/zoe/*" -inactive -pick

Incrbydate

Important:It is recommended that if you have limited time during the week to perform backups, but extra time on weekends, you may want to maintain current server storage of your workstation files by performing a partial incremental backup on weekdays, and a full incremental backup on weekends.

The incrbydate option is used with the incremental command to backup up new and changed files with a modification date later than the last incremental backup stored at the server, unless the file is excluded from backup. Files added at the client after the last incremental backup, but with a modification date earlier than the last incremental, are not backed up

An Incremental-by-date updates the date and time of the last incremental at the server. If an incremental-by-date is performed on only part of a file system, the date of the last full incremental is not updated, and the next incremental-by-date will back up these files again.

Both full and partial incrementals back up new and changed files. An incremental-by-date takes less time to process than a full incremental, and requires less memory. However, unlike a full incremental, an incremental-by-date does not maintain current server storage of all your workstation files because:

Syntax

>>-INCRbydate--------------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc incremental -incrbydate

Incremental

Use the incremental option with the restore image command to ensure that any changes that were made to the base image are also applied to the restored image.

If you also use the deletefiles option, changes include the deletion of files and directories.

Syntax

>>-INCREmental-------------------------------------------------><
 

Examples

Command line:
res i "/home/devel/projecta/*" -incremental

Latest

The latest option is used with the restore command to restore 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

Command line:
dsmc restore "/home/devel/projecta/*" -latest

Location

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 the location option and either the file name or the tape device.

Syntax

            .-server--.
>>-LOCation-+---------+----------------------------------------><
            +-file----+
            '-tape----'
 

Parameters

server
Specifies that TSM searches for the backup set on the server. This is the default.

file
Specifies that TSM searches for the backup set on a local file.

tape
Specifies that TSM searches for the backup set on a local tape device. This parameter is valid for Solaris, AIX and HP-UX clients. The supported tape devices are the following:

Notes:

  1. 8mm

  2. 4mm

  3. DLT

  4. 3570

  5. 3590

Examples

Command line:
dsmc restore backupset mybackupsetname 
-loc=server
dsmc restore backupset mybackupsetname

Mode

The mode option specifies whether a full image backup is performed or only an incremental backup is performed for files that were 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

selective
Specifies that a full (selective) image backup is performed. This is the default.

incremental
Specifies that only files that were changed or created since the last full image backup are backed up. Deleted files are not inactivated on the server.

Examples

Command line:
dsmc ba im d: -mode=i 

Noprompt

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

Command line:
dsmc delete archive -noprompt "/home/project/*"

Pick

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

Command line:
dsmc restore "/home/project/*" -pick -inactive

Pitdate

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

date
Specifies the appropriate date. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc restore "/fs1/*" -sub=y -pitdate=08/01/1999 
-pittime=06:00:00

Pittime

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

time
Specifies a time on a specified date. If you do not specify a time, the time defaults to 23:59:59. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc q b "/fs1/*" -pitt=06:00:00 -pitd=08/01/1999

Preservepath

The preservepath option specifies how much of the source path to reproduce as part of the target directory path when you restore or retrieve 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

subtree
Creates the lowest-level source directory as a subdirectory of the target directory. Files from the source directory are stored in the new subdirectory. This is the default.

complete
Restores the entire path, starting from the root, into the specified directory. The entire path includes all the directories except the file space name.

nobase
Restores the contents of the source directory without the lowest level, or base directory, into the specified destination directory.

none
Restores all selected source files to the target directory. No part of the source path at or above the source directory is reproduced at the target.

If you specify subdir=yes, all files in the source directories are restored to the single target directory.

Examples

Command line:
For the examples below, assume the server file space contains the following backup copies:
/fs/h1/m1/file.a
/fs/h1/m1/file.b
/fs/h1/m1/l1/file.x
/fs/h1/m1/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=complete

Restores these directories and files:

/u/ann/h1/m1/file.a
/u/ann/h1/m1/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=nobase

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b

This command:
dsmc res backupset /fs/h1/m1/ /u/ann/ -su=yes 
-preser=nobase -loc=file

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/file.x
/u/ann/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=subtree

Restores these directories and files:

/u/ann/m1/file.a
/u/ann/m1/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -preser=none

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes 
-preser=complete

Restores these directories and files:

/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

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=nobase

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/l1/file.x
/u/ann/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=subtree

Restores these directories and files:

/u/ann/m1/file.a
/u/ann/m1/file.b
/u/ann/m1/l1/file.x
/u/ann/m1/l1/file.y

This command:
dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=none

Restores these directories and files:

/u/ann/file.a
/u/ann/file.b
/u/ann/file.x
/u/ann/file.y

Todate

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, 1999.

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, 1999 and 11:59 PM on July 30, 1999.

Syntax

>>-TODate- date------------------------------------------------><
 

Parameters

date
Specifies an ending date. Enter the date in the format you selected with the dateformat option.

When you include dateformat with a command, it must precede the fromdate, pitdate, and todate options.

Examples

Command line:
dsmc restore "/home/user1/*" -todate=12/11/1999

Totime

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, 1999. 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, 1999 and 11:59 PM on July 30, 1999.

Syntax

>>-TOTime- time------------------------------------------------><
 

Parameters

time
Specifies an ending time. If you do not specify a time, the time defaults to 23:59:59. Specify the time in the format you selected with the timeformat option.

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.

Examples

Command line:
dsmc restore "/home/user1/*" -todate=09/17/1999 
-totime=23:00:00

Volinformation

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.

Syntax

>>-VOLinformation----------------------------------------------><
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc selective -vol


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]