Tivoli Storage Manager for Windows Using the Backup-Archive Client


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 Table 26. 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:


Table 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
class Specifies whether to display a list of NAS objects or client objects when using the following commands: query backup
delete filespace
query filespace
Class
deletefiles Deletes the local copy of files from your workstation after they are archived on the server. archive
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
filelist Specifies a list of files to be processed for the command. Tivoli Storage Manager opens the designated filelist and processes the files listed within according to the command. When the filelist option is used, file specification is ignored. archive
delete archive
expire
incremental
query backup
query archive
restore
retrieve
selective
Filelist
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


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


Fromnode
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
restore nas
Inactive
incrbydate Requests an incremental backup by date. incremental Incrbydate
latest Restores the most recent backup version of a file whether it is active or inactive. restore Latest
location Specifies whether Tivoli Storage Manager searches for a backup set on the server, in local files, or on a tape device during a query or restore operation. query backupset
restore backupset
Location
mode Specifies whether to perform an image backup on an entire file system or only those files that change after the original image backup. backup nas
Mode
monitor Specifies whether you want to monitor an image backup or restore of one or more file systems belonging to a NAS file server. backup nas
restore nas
Monitor
nojournal Use this option with the with the incremental command to specify that the traditional full incremental backup is performed, instead of the default journal-based backup. incremental Nojournal
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 nas

Pick
pitdate Specifies the file backup date to use when you select files to restore. Use with the pittime option. query backup
restore
restore nas
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 nas
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
type Displays node types that you specify. query node Type
v2archive Use this option with the archive command to archive only files and not directories to the server. archive
V2archive

Command Line Options Reference

The following sections contain detailed information about each of the Tivoli Storage Manager 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 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 c:\plan\proj1\
budget.jan\*

Class

The class option specifies whether to display a list of NAS objects or client objects when using the following commands:

For example, to display a list of the file spaces belonging to a NAS node, specify the class=nas option with the query filespace command.

Syntax

         .-client-.
>>-CLASS-+--------+--------------------------------------------><
         '-nas----'
 
 

Parameters

nas
Specifies that you want to display a list of file spaces for a NAS node.

client
Specifies that you want to display a list of file spaces for a client node. This is the default.

Examples

Command line:
q backup -class=nas

Deletefiles

Use the deletefiles option with the archive command to delete archived files from your workstation.

Syntax

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

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc archive c:\foo\*.c -deletefiles

Description

The description option assigns or specifies a description for files when performing archive, delete, retrieve, or query archive operations. 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" c:\plan\proj1\
   budget.jan

You can also use this option to specify the description of a backup set that you want to query.

Syntax

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

Parameters

description
Assigns a description to the file you are archiving. If you do not specify a description, 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 applies to each file. 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" c:\allproj\*.x

You can then use the description to retrieve all of the files.

Examples

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

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 displays. If you specify the detail option, information about attributes in each copy group contained in each management class will display. A management class can contain a backup copy group, an archive copy group, both, or neither.

For Windows NT, 2000 Unicode-enabled clients: A Unicode-enabled file space may not display correctly if the server cannot display the Unicode name. In this case, use the file space identifier (fsID) of the file space to identify these file spaces on the server. Use the detail option with the query filespace command to determine the fsID of a file space. The fsID also displays in the file information dialog in the native and Web client GUIs.

Syntax

>>-DETail------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc query mgmtclass -detail

Dirsonly

The dirsonly option processes directories only.

Syntax

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

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc query backup -dirsonly c:*

Filelist

Use the filelist option to process a list of files. The Tivoli Storage Manager client opens the file you specify with this option and processes the list of files within according to the specific command. With the exception of the restore and retrieve commands, when you use the filelist option, Tivoli Storage Manager ignores all other file specifications on the command line.

The files (entries) listed in the filelist must adhere to the following rules:

The following is an example of a list of files within a filelist:

   c:\myfiles\directory\file1
   c:\tivoli\mydir\yourfile.doc
   ..\notes\avi\dir1
   ..\fs1\dir2\file3
   "d:\fs2\Ha Ha Ha\file.txt"
   "d:\fs3\file.txt"

If an entry in the filelist indicates a directory, only that directory will process and not the files within the directory.

If the file name (the filelistspec) you specify with the filelist option does not exist, the command fails. Tivoli Storage Manager skips any entries in the filelist that are not valid files or directories. Tivoli Storage Manager logs errors associated with an entry in the filelist, and processing continues to the next entry.

Use file specifications with the restore and retrieve commands to denote the destination for the restored filelist entries. For example, in the restore command: restore -filelist=c:\filelist.txt d:\dir\, the file specification d:\dir represents the restore destination for all entries in the filelist. However, in the selective command: selective -filelist=c:\filelist.txt d:\dir, the file specification d:\dir is ignored.

If you specify a directory in a filelist for the delete archive command, the directory is not deleted. Filelists that you use with the delete archive command should not include directories. After deleting the files, use wildcard specifications on the command line to delete the directories.

The entries in the list will be processed in the order they appear in the filelist. For optimal processing performance, pre-sort the filelist by filespace name and path.

Note:
Tivoli Storage Manager may be back up a directory twice if the following conditions exist: For example, your filelist includes the entries c:\dir0\myfile and c:\dir0. If the \dir0 directory does not exist on the server, the c:\dir0 directory is sent to the server a second time.

Syntax

>>-FILEList- filelistspec--------------------------------------><
 
 

Parameters

filelistspec
Specifies the location and name of the file that contains the list of files to process with the command.
Note:
When you specify the filelist option on the command line, you cannot use the subdir option.

Examples

Command line:
sel -filelist=c:\avi\filelist.txt

Filesonly

The filesonly option restricts backup and restore processing to files only. You cannot restore or retrieve directories from the server when using the filesonly option with the restore or retrieve commands. However, directories with default attributes are created, if required, as placeholders for files that you restore or retrieve.

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 C:\Windows\Program Files\*.exe

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 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 d:\

Fromtime

Use the fromtime option with the fromdate option to specify a beginning time. This option is ignored if you do not specify the fromdate option.

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 -timeformat=4 -fromt=11:59AM -fromd=06/30/99 -tot=11:59PM -tod=06/30/99 c:\*

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 -ifnewer d:\logs\*.log

Inactive

Use the inactive option with the pick option and the following commands:

You can also use the pick option to display backup versions and archive copies 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 -inactive c:\id\projecta\

Incrbydate

Important:
If you have limited time during the week to perform backups, but extra time on weekends, you can maintain current server storage of your workstation files by performing a partial incremental backup on weekdays and a full incremental backup on weekends.

Use the incrbydate option with the incremental command to back 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

Latest

Use the latest option with the restore command to restore the most recent backup 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 c:\devel\projecta\ -latest

Location

The location option specifies where Tivoli Storage Manager 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 Tivoli Storage Manager searches for the backup set on the server. This is the default.

file
Specifies that Tivoli Storage Manager searches for the backup set on a local file.

tape
Specifies that Tivoli Storage Manager searches for the backup set on a local tape device. This parameter is valid for Windows NT and Windows 2000 clients. The supported tape devices are the following:
Note:
For Windows NT, 2000: If you want to restore a backup set from a 3570 or 3590 tape device, but you do not have the 3570 or 3590 generic device driver on your client workstation, you can download these device drivers from the following Web site:
   ftp://ftp.software.ibm.com/storage/devdrvr/

Examples

Command line:
restore backupset mybackupsetname -loc=server
restore backupset c:\mybackupsetname.prj -loc=file
restore backupset \\.\TAPE1 -loc=3570

Mode

The mode option specifies whether you want to perform a full or differential image backup of NAS file systems.

Syntax

        .-differential-.
>>-MODE-+--------------+---------------------------------------><
        '-full---------'
 
 

Parameters

full
Specifies that you want to perform a NAS image backup of an entire file system.

differential
Specifies that you want to perform a NAS image backup of files that changed since the last full image backup. If an eligible full image backup does not exist, a full image backup is performed. This is the default.

Examples

Command line:
dsmc backup nas -mode=full -nasnodename=nas1 {/vol/vol0}
{/vol/vol1}

Monitor

The monitor option specifies whether you want to monitor an image backup or restore of one or more file systems belonging to a Network Attached Storage (NAS) file server. If you specify monitor=yes, Tivoli Storage Manager monitors the current NAS image backup or restore operation and displays processing information on your screen. This is the default.

If you specify monitor=no, Tivoli Storage Manager does not monitor the current NAS image backup or restore operation and is available to process the next command.

Use this option with the backup nas and restore nas commands.

The monitor option is valid for all Windows clients.

Syntax

           .-Yes-.
>>-MONitor-+-----+---------------------------------------------><
           '-No--'
 
 

Parameters

Yes
Specifies that you want to monitor the current NAS image backup or restore operation and display processing information on your screen. This is the default.

No
Specifies that you do not want to monitor the current NAS image backup or restore operation.

Examples

Command line:
backup nas -mode=full -nasnodename=nas1 -monitor=yes
{/vol/vol0} {/vol/vol1}

Nojournal

Use the nojournal option with the incremental command to specify that you want to perform a traditional full incremental backup, instead of the default journal-based backup.

Journal-based incremental backup differs from the traditional full incremental backup in the following ways:

For these reasons, you may want to use the nojournal option to perform a traditional full incremental backup.

See "Journal-Based Backup (Windows NT, 2000 only)" for more information about journal-based incremental backup.

This option is valid for Windows NT and Windows 2000 only.

Syntax

>>-NOJournal---------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
   dsmc incr c: -nojournal

Noprompt

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. Use this option with caution.

Syntax

>>-NOPrompt----------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc delete archive -noprompt c:\home\project\*

Pick

The pick option creates a list of backup versions 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.

Syntax

>>-PIck--------------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

Command line:
dsmc restore c:\project\* -pick -inactive

Pitdate

Use the pitdate option with the pittime option to establish a point in time for which you want to display or restore the latest version of your backups. Files 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 -pitdate=08/01/1999 c:\myfiles\

Pittime

Use the pittime option with the pitdate option to establish a point in time for which you want to display or restore the latest version of your backups. Files 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 query backup -pitt=06:00:00 -pitd=08/01/1999 c:\myfiles\

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:
c:\h1\m1\file.a
c:\h1\m1\file.b
c:\h1\m1\l1\file.x
c:\h1\m1\l1\file.y

This command:
dsmc res c:\h1\m1\ c:\ann\ -preservep=complete.

Restores these directories and files:

c:\ann\h1\m1\file.a
c:\ann\h1\m1\file.b

This command:
dsmc res c:\h1\m1\ c:\ann\ -preser=nobase.

Restores these directories and files:

c:\ann\file.a
c:\ann\file.b

This command:
dsmc res c:\h1\m1\ c:\ann\ -preser=subtree.

Restores these directories and files:

c:\ann\m1\file.a
c:\ann\m1\file.b

This command:
dsmc res c:\h1\m1\ c:\ann\ -preser=none.

Restores these directories and files:

c:\ann\file.a
c:\ann\file.b

This command:
dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=
complete

Restores these directories and files:

c:\ann\h1\m1\file.a
c:\ann\h1\m1\file.b
c:\ann\h1\m1\l1\file.x
c:\ann\h1\m1\l1\file.y

This command:
dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=nobase.

Restores these directories and files:

c:\ann\file.a
c:\ann\file.b
c:\ann\l1\file.x
c:\ann\l1\file.y

This command:
dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=subtree.

Restores these directories and files:

c:\ann\m1\file.a
c:\ann\m1\file.b
c:\ann\m1\l1\file.x
c:\ann\m1\l1\file.y

This command:
dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=none.

Restores these directories and files:

c:\ann\file.a
c:\ann\file.b
c:\ann\file.x
c:\ann\file.y

This command:
dsmc res backupset c:\h1\m1\ c:\ann\ -su=yes 
-preser=nobase -loc=file

Restores these directories and files:

c:\ann\file.a
c:\ann\file.b
c:\ann\file.x
c:\ann\file.y

Todate

Use the todate option with the totime option to specify 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 -todate=12/11/1999 c:\myfiles\

Totime

Use the totime option with the todate option to specify 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 -totime=23:00:00 -todate=09/17/1999 c:\somefiles\

Type

Use the type option with the query node command to specify the type of node to query.

Syntax

        .-any----.
>>-TYpe-+--------+---------------------------------------------><
        +-nas----+
        +-server-+
        '-client-'
 
 

Parameters

any
Specifies all nodes registered at the server. This is the default.

nas
Specifies all NAS nodes registered at the server.

server
Specifies client nodes that are other Tivoli Storage Manager servers.

client
Specifies client nodes that are backup-archive clients.

Examples

Command line:
q node -type=nas

V2archive

Use the v2archive option with the archive command to archive only files to the server. Directories that exist in the path of the source file specification will not process.

This option differs from the filesonly option in that the filesonly option archives the directories that exist in the path of the source file specification.

The v2archive and dirsonly options are mutually exclusive and an error message displays if you use both options in the same archive command.

This option is not persistent; you must explicitly specify this option in each archive command.

If you use this option, you may want to consider the following:

Syntax

>>-V2archive---------------------------------------------------><
 
 

Parameters

There are no parameters for this option.

Examples

This command:
dsmc archive c:\relx\dir1\ -v2archive -su=y

Archives these files:

c:\relx\dir1\file1
c:\relx\dir1\file2
c:\relx\dir1\file3
c:\relx\dir1\dir2\file4
c:\relx\dir1\dir2\file5
 

Note: c:\relx\dir1 and c:\relx\dir1\dir2 are not archived.


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