Tivoli Storage Manager for OS/2 Using the Backup-Archive Client


Chapter 10. Using Commands

TSM provides a command line interface (CLI) that you can use as an alternative to the graphical user interface (GUI). This chapter describes how to start or end a client command session, and how to enter commands. It also provides detailed information about each TSM command. Table 26 shows a list of tasks related to entering commands.

Table 26. Entering Commands

Task Page
"Starting and Ending a Client Command Session" "Starting and Ending a Client Command Session"
"Entering Client Commands" "Entering Client Commands"
"Remembering Previous Commands" "Remembering Previous Commands"
"Using Wildcard Characters" "Using Wildcard Characters"
Table 27 provides an alphabetical list of the commands, a brief description, and where to go in this book for more information.

Table 27. Commands

Command Description Page
archive Archives files from a workstation to TSM storage. Archive
cancel restore Displays a list of restartable restore sessions and permits you to select one to cancel. Cancel Restore
delete access Revokes authorization for a user to restore or retrieve files. Delete Access
delete archive Deletes archived files from TSM storage. Delete Archive
delete filespace Deletes file spaces in TSM storage. Delete Filespace
help Displays online command help. Help
incremental Backs up new and changed files. Incremental
loop Starts an interactive command session. Loop
macro Uses commands within a macro file. Macro
query access Displays a list of current authorization rules. Query Access
query archive Displays a list of archived files. Query Archive
query backup Displays a list of backup versions. Query Backup
query backupset Queries a backup set from the server or a local file. Query Backupset
query filespace Displays a list of file spaces in TSM storage. Query Filespace
query mgmtclass Displays information about available management classes. Query Mgmtclass
query restore Displays a list of your restartable restore sessions in the server database. Query Restore
query schedule Displays information about scheduled events. Query Schedule
query session Displays information about the current session. Query Session
restart restore Displays a list of restartable restore sessions and permits you to select one to restart. Restart Restore
restore Restores backup versions from TSM storage. Restore
restore backupset Restores a backup set from the server or a local file. Restore Backupset
retrieve Retrieves archived files from TSM storage. Retrieve
schedule Starts the client scheduler on the workstation. Schedule
selective Backs up selected files. Selective
set access Authorizes another user to access your backup versions or archive copies. Set Access
set password Changes the TSM password for your workstation. Set Password

Starting and Ending a Client Command Session

You can start or end a client command session in either batch mode or interactive mode. Use batch mode when you want to enter a single client command. TSM processes the command and returns to the command prompt.

Use interactive mode when you want to enter a series of commands. Since TSM establishes connection to the server only once for interactive mode, a series of commands can be processed more quickly. TSM processes the commands and returns to the tsm> prompt.

Process Commands in Batch Mode

In an OS/2 window, change directory to the TSM directory. When you enter a single command in batch mode, precede it with the executable program name, dsmc. For example, to process the incremental command in batch mode, you would enter:

   dsmc incremental

If a password is required, TSM prompts you each time you enter a command if the passwordaccess option is set to prompt, or authentication on the server is set to On. Type your password and press Enter.

You can also enter your password using the password option with a command, but your password is displayed. For example, if your password is secret, enter:

   dsmc incremental -password=secret

If you set the passwordaccess option to generate in your dsm.opt file, you are not required to specify the password with the command. TSM only prompts you for your password if you are registering your workstation with a server, or manually changing your password.

To end a batch mode session, enter quit at the prompt.

Process Commands in Interactive Mode

Use the interactive mode to enter a series of commands. In an OS/2 window, change directory to the TSM directory. Enter dsmc on the command line and press Enter. Do not precede each command with the executable program name, dsmc. When the tsm> command prompt appears, type the command name and press Enter. Alternatively, you can enter dsmc loop on the command line to start a client command session in interactive mode. Loop is the default command for dsmc.

If a password is required, TSM prompts you when you enter the first command. Type your password and press Enter. You can also enter your password using the password option with the loop command, but your password is displayed. For example, if your password is secret, you would enter:

   dsmc loop -password=secret

To end an interactive session, enter quit at the prompt.


Entering Client Commands

A client command can include one or more of these components:

The sections that follow describe each of these components.

Command Name

The first part of a command is the command name. The command name consists of a single word, such as help or schedule, or an action word and an object for that action, such as query archive. Enter the full command name, or its minimum abbreviation. For example, you can enter any of the following versions of the query schedule command:

   query schedule
   q sc
   q sched
   query sc

Options

There are two groups of options that you can use with commands. They are:

Parameters

Commands can have required parameters, optional parameters, or no parameters at all. Required parameters provide information to perform a task. The most commonly required parameter is a file specification. For example, if you want to archive a file named budget.fin from the c:\project directory, you would enter:

   dsmc archive c:\project\budget.fin

Some commands have optional parameters. If you do not enter a value when you include an optional parameter, TSM uses the default value. For example, the restore command includes a required parameter, sourcefilespec, that specifies the path and file name in storage that you want to restore. The optional parameter, destinationfilespec, specifies the path and file name where you want to place the restored files. If you do not specify the destinationfilespec, by default, TSM restores the files to the original source path. If you want to restore the files to a different directory, enter a value for destinationfilespec. For example, to restore c:\project\budget.fin to c:\newproj\newbudg.fin, you would enter:

   dsmc restore c:\project\budget.fin c:\newproj\newbudg.fin

Enter parameters in the order indicated in the command syntax diagram.

File Specification Syntax

Use the following syntax rules when specifying file specification parameters, such as filespec, sourcefilespec, and destinationfilespec:


Remembering Previous Commands

If the editor yes option is specified in your options file, TSM permits you to recall and edit as many as twenty previously entered commands using the up arrow and down arrow keys. If the editor=no option is specified, the feature to recall previous commands is not active. If the editor and command retrieve functions are not working on a specific workstation setting, you should turn off the editor option. For more information regarding the editor option, see Editor.

Pressing the Up arrow key displays the previous command in memory. Pressing the Down arrow key displays the next command in memory. Table 28 lists other functions you can perform when you recall commands.

Table 28. Command Recall and Edit Functions

Function Press
Display the previous command in memory. Up arrow
Display the next command in memory. Down arrow
Move to the beginning of the command. Home
Move to the end of the command. End
Move to the left. Left arrow
Move to the right. Right arrow
Move five spaces to the left. Tab left
Move five spaces to the right. Tab right
Move to the beginning of the previous word Ctrl-left arrow or CTRL-L
Move to the beginning of the next word. Ctrl-right arrow or CTRL-R
Delete a character to the right of the cursor. Delete
Delete a character to the left of the cursor. Backspace
Insert a character. Toggle the Insert key
Erase to the end of the line. Ctrl-delete or Ctrl-D
Finish or execute the command. Enter
Quit the program. F3 or Esc
End the program. CTRL-C

Using Wildcard Characters

In a command, wildcard characters can be used in the file name or file extension only. You cannot use them to specify destination files, drives, or directories. Use wildcard characters when you want to specify multiple files with similar names in one command. Without wildcard characters, you must repeat the command for each file. Valid wildcard characters that you can use include:

*
Asterisk. Matches zero or more characters.
?
Question mark. Matches any single character at the present position.

Table 29 shows examples of each wildcard.

Table 29. Wildcard Characters

Pattern Matches Does Not Match
Asterisk (*)

ab* ab, abb, abxxx a, b, aa, bb
ab*rs abrs, abtrs, abrsrs ars, aabrs, abrss
ab*ef*rs abefrs, abefghrs abefr, abers
abcd.* abcd.c, abcd.txt abcd, abcdc, abcdtxt
Question Mark (?)

ab? abc ab, abab, abzzz
ab?rs abfrs abrs, abllrs
ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs
ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs
   dsmc selective "/home/me/*.c"

Entering Commands

Follow the general rules below when you enter commands:

Archive

The archive command archives a single file, selected files, or all files in a directory and its subdirectories on a server. Directories are archived.

Archive files that you want to preserve in their current condition. To release storage space on your workstation, delete files as you archive them. Retrieve the archived files to your workstation whenever you need them again.

Syntax

                                   .----------------.
                                   V                |
>>-ARchive---+-----------------+------- filespec----+----------><
             |  .-----------.  |
             |  V           |  |
             '---- options--+--'
 

Parameters

options
You can use these command line options with the archive command: archmc, deletefiles, description, dirsonly. For more information about command line options, see Chapter 9, "Using Options With Commands".

You can use the changingretries and subdir common options with the archive command. See Chapter 8, "Setting Common Options" for information about these common options.

filespec
Specifies path and name of the file you want to archive. You can use wildcards to specify a group of files or all the files in a directory, and you can enter more than one file specification in a command.

Examples

The following are examples of tasks you might perform using the archive command.

Task
Archive a single file named budget.jan in the \plan\proj1 directory.

Command: archive c:\plan\proj1\budget.jan

Task
Archive all files in the c:\plan\proj1 directory that contain a file extension of .txt.

Command: archive c:\plan\proj1\*.txt

Task
Archive all files in the c: drive.

Command: archive -subdir=yes c:\*.*

Cancel Restore

The cancel restore command displays a list of your restartable restore sessions in the server database. You can select zero or more restartable restore sessions that you want to cancel. To restart restartable restore sessions, use the restart restore command.

Use the cancel restore command when:

Syntax

>>-CANcel Restore---+-----------+------------------------------><
                    '- options--'
 

Parameters

options
See Chapter 8, "Setting Common Options" for information about common options that you can use with the cancel restore command.

Examples

Task
Cancel a restore operation.

Command: cancel restore

Delete Access

The delete access command deletes authorization rules for files that are stored on the server. When you delete an authorization rule, you revoke user access to any files specified by that rule.

Syntax

>>-Delete ACcess---+-----------------+-------------------------><
                   |  .-----------.  |
                   |  V           |  |
                   '---- options--+--'
 

Parameters

options
For information about common options that you can use with this command, see Chapter 8, "Setting Common Options".

Examples

The following are examples of tasks you might perform using the delete access command.

Task
Display a list of current authorization rules, and select the rules you want to delete.

Command: delete access

See the following screen example:

 
Index  Type      Node     Owner    Path  
_____  ______    ____________________________________ 
1      Backup    node1    daisy   c:\dev\proja\list.c
2      Archive   node3    marm    c:\fin\budg\depta.jan
3      Backup    node4    susie   c:\plan\exp\deptc.feb
4      Archive   node5    susies  c:\mfg\invn\parta.wip
Enter Index of rule(s) to delete, or quit to cancel:

To delete the authorization rules that allow marm and susies to access your files, type 2 4 or (2,4) and press Enter.

Delete Archive

The delete archive command deletes archived files from TSM storage. Your administrator must give you authority to delete archived files.

Attention: When you delete archived files, you cannot retrieve them. Verify that the files are obsolete before you delete them.

Syntax

>>-Delete ARchive---+-----------+------------------------------->
                    '- options--'
 
>-----+- filespec----------------+-----------------------------><
      '- {filespacename}filespec-'
 

Parameters

options
You can use these command line options with the delete archive command: description, noprompt, and pick. For more information about command line options, see Chapter 9, "Using Options With Commands".

You can use the subdir common option with the delete archive command. For information about common options, see Chapter 8, "Setting Common Options".

filespec
Specifies the path and file name that you want to delete from storage. Use wildcard characters to specify a group of files or all files in a directory.
Note:If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to delete. This name is the drive label name on the workstation drive from which the file was archived.

Use the file space name if the drive label name has changed, or if you are deleting files archived from another node with drive labels that are different from yours.

Examples

The following are examples of tasks you might perform using the delete archive command.

Task
Delete files from file space abc in the proj directory.

Command: del arc {abc}\proj\*.*

Task
Delete a file named budget.jan.

Command: del arch c:\plan\proj1\budget.jan

Task
Delete all files archived from the c:\plan\proj1 directory with a file extension of .txt.

Command: del arch c:\plan\proj1\*.txt

Task
Delete files archived from the c:\project directory using the pick option.

Command: d ar c:\project\*.* -pick

Delete Filespace

The delete filespace command deletes file spaces from TSM storage. A file space is a logical space on the server that contains files you backed up or archived. TSM assigns a separate file space on the server for each drive at your workstation from which you back up or archive files. The file space name is the same as the drive label name. When you enter the delete filespace command, TSM displays a list of your file spaces. Select those file spaces that you want to delete from this list.

Your administrator must give you authority to delete a file space. You need BACKDEL authority if the file space you want to delete contains backup versions, or ARCHDEL authority if the file space contains archive copies. If the file space contains both backup versions and archive copies, you need both types of authority.

Attention: When you delete a file space, you delete all backup versions and archive copies within that file space. When you delete a file space, you cannot restore the files. Verify that the files are obsolete before you delete them.

Syntax

>>-Delete Filespace---+-----------+----------------------------><
                      '- options--'
 

Parameters

options
For information about common options that you can use with this command, see Chapter 8, "Setting Common Options".

Examples

The following are examples of tasks you might perform using the delete filespace command.

Task
Delete a file space.

Command: delete filespace

Task
Delete a file space.

Command: del f

Help

The help command displays help information for the command line client. Enter the number of the topic that you want to view. If there is more than one screen of topics, scroll backward or forward through the Table of Contents. To exit, type q and press Enter.

Syntax

>>-Help---+-----------+----------------------------------------><
          '- options--'
 

Parameters

options
For information about common options that you can use with this command, see Chapter 8, Setting Common Options.

Examples

Task
Display a list of help choices.

Command: help

Incremental

The incremental command backs up all new or changed files or directories in the default client domain or from file systems, directories, or files you specify that are not excluded from backup services.

To incrementally back up selected files or directories, specify the file specification in the command. The default is to back up files or directories in the default domain.

The following attributes in the management class assigned to the file or directory affect whether the data is actually backed up:

Frequency
The number of days that must elapse between successive backups for the file. This attribute is only used during a full incremental backup.

Mode
Permits you to back up only files that changed since the last backup (modified), or to back up the files whether they changed or not (absolute).

Serialization
Permits or denies backup of files or directories according to the following values:

For more information on management classes, see Chapter 6, "Understanding Storage Management Policies".

You can assign the default management class to a file, or you can assign a specific management class to a file using the include option in an include-exclude list.

You can perform either a full incremental backup or an incremental by date backup. The default is a full incremental backup.

You can also the selective command to perform a selective backup that backs up only the files, directories or empty directories that you specify. See Selective for more information.

A full incremental backs up all files or directories that are new, or have changed since the last incremental backup. During a full incremental backup, the client queries the server to determine the exact condition of your storage. TSM uses this information to:

Incremental-by-Date

An incremental-by-date backup, backs up new and changed files with a modification date later than the date of the last incremental backup stored at the server, unless the files are excluded from backup by an exclude statement.

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. Therefore, changes to the access control lists (ACL) are not backed up during an incremental-by-date. Use the query filespace command to determine the date and time of the last incremental backup of the entire file system.

To perform an incremental-by-date backup, use the incrbydate option with the incremental command.

Unlike a full incremental, an incremental-by-date does not maintain current server storage of all your workstation files because:

For these reasons, it is recommended that if you have limited time during the week to perform backups, but extra time on the weekends, you can use a partial incremental backup on weekdays, and a full incremental backup on weekends to maintain current server storage of your workstation files.

If the incremental command is retried because of a communication failure or session loss, the transfer statistics will display the number of bytes TSM attempted to transfer during all commands attempts. Therefore, the statistics for bytes transferred may not match the file statistics, such as those for file size.

Syntax

>>-Incremental---+---------------+---+- filespec---+-----------><
                 |  .----------. |   '- "filespec"-'
                 |  V          | |
                 '--- options--+-'
 

Parameters

options
You can use these command line options with the incremental command: dirsonly, filesonly, incrbydate. For more information, see Chapter 9, "Using Options With Commands".

You can use the following common options with the incremental command: changingretries, domain, memoryefficientbackup, subdir, tapeprompt. For information about these options, see Chapter 8, "Setting Common Options".

filespec
Specifies the path and file name that you want to back up. Use wildcards to select a group of files or all the files in a directory. You can also enter more than one file specification in a command by separating the file specifications with a space. If a file specification is not specified, the default domain or the domain specified as an option is backed up.

If a file system is specified, all new and changed files are backed up and the last incremental date for the file space is updated on the server. If a file or directory is specified, the last incremental date is not updated, so the file or directory might be backed up again if a later backup is performed using the incrbydate option.

If a file system is specified, specify the file system without a trailing slash.

Examples

The following are examples of tasks you might perform using the incremental command.

Task
Run an incremental backup of the default client domain specified in your client options file.

Command: Incremental

Task
Run an incremental backup of the c:, d:, and e: drives.

Command: i c: d: e:

Task
Run an incremental backup for the c:\proj\test directory.

Command: incremental c:\proj\test

Task
Run an incremental-by-date backup for the d: file system.

Command: incremental -incrbydate d:\u\

Loop

The loop command starts an interactive command line session that is maintained until you enter quit. In an interactive command line session, it is unnecessary to precede each command name with dsmc and your password, if one is required. After you start an interactive session, most of the options you entered with other commands are in effect throughout the session, unless you enter them again using a different setting. The following options, however, must be entered on each command for which you want them to take effect: deletefiles, description, detail, dirsonly, filesonly, fromdate, fromnode, fromtime, ifnewer, inactive, incrbydate, latest, noprompt, pick, pitdate, pittime, preservepath, todate, totime.

You can enter all valid commands in interactive mode except the schedule and loop commands.

See Chapter 8, "Setting Common Options" for options that cannot be used in interactive mode.

Syntax

>>-LOOP---+-----------+----------------------------------------><
          '- options--'
 

Parameters

options
For information about command line and common options that you can use with this command, see Chapter 9, "Using Options With Commands" and Chapter 8, "Setting Common Options".

Examples

Task
Start an interactive command line session.

Command: dsmc

Macro

The macro command sends a series of commands that you specify in a macro file. By including the macro command within a macro file, you can nest as many as ten levels of commands.

Syntax

>>-MAcro- macroname--------------------------------------------><
 

Parameters

macroname
Specifies the fully-qualified name of the file containing the commands.

Examples

The following is an example of how to use the macro command.

Task
Selectively back up files in the following directories:
\devel\project\proja
\devel\project\projb
\devel\project\projc

Command: macro backabc.mac

where backabc.mac contains the following statements:

 selective c:\devel\project\proja\*.*
 selective c:\devel\project\projb\*.*
 selective c:\devel\project\projc\*.*

Query Access

The query access command displays a list of users to whom you have given access to backup versions or archive copies of specific files. TSM displays a list of authorization rules that you defined with the set access command, or with User Access List on the graphical user interface (GUI) Utilities menu. The information includes:

Syntax

>>-Query ACcess---+-----------+--------------------------------><
                  '- options--'
 

Parameters

options
You can use the following common options with the query access command: scrolllines, scrollprompt. For more information about common options you can use with this command, see Chapter 8, "Setting Common Options".

Examples

Task
Display a list of users who have access to your files.

Command: query access

Query Archive

The query archive command displays a list of your archived files, the file size, archive date, file specification, expiration date, and file description.

Syntax

>>-Query ARchive---+-----------+---+- filespec----------------+-><
                   '- options--'   '- {filespacename}filespec-'
 

Parameters

options
You can use these command line options with the query archive command: description, dirsonly, filesonly, fromdate, fromnode, fromtime, inactive, pitdate, pittime, todate, totime. For more information, see Chapter 9, "Using Options With Commands".

You can use the following common options with the query archive command: scrolllines, scrollprompt, subdir. See Chapter 8, "Setting Common Options" for more information..

filespec
Specifies the path and file name that you want to query. Use wildcard characters to specify a group of files, or all the files in a directory.
Note:If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to query. This is the drive label name on the workstation drive from which the file was archived.

Use the file space name if the drive label has changed, or if you are querying files archived from another node whose drive labels are different from yours.

Examples

The following are examples of tasks you might perform using the query archive command.

Task
Display a list of all your archived files in the c:\proj directory.

Command: q ar c:\proj\*

Task
Display a list of all your archived files in the c:\proj directory. Use the dateformat and timeformat options to reformat the dates and times.

Command: q ar -date=5 -time=4 c:\proj\*

Task
Display a list of archived files in the c:\proj directory containing a file extension of .dev. Use the dateformat and timeformat options.

Command: q ar -date=5 -time=4 c:\proj\*.dev

Task
Last week you changed the label of your c: drive to store and archived some files. Yesterday you changed the label to dev and archived more files. Display a list of all the files you archived in the c:\proj directory when the label was store.

Command: q ar {store}\proj\*

Task
Last week you archived files from a diskette labeled docs. Display a list of all the files you archived.

Command: q ar {docs}\*

Query Backup

The query backup command displays a list of backup versions of your files. For each backup version, TSM displays the file specification, file size, backup date, whether the file is active or inactive, and the management class to which the file is assigned. TSM displays only the first ten characters of the management class name.

Syntax

>>-Query Backup---+-----------+---+- filespec----------------+-><
                  '- options--'   '- {filespacename}filespec-'
 

Parameters

options
You can use these command line options with the query backup command: dirsonly, filesonly, fromdate, fromnode, fromtime, pitdate, pittime, todate, totime. For more information, see Chapter 9, "Using Options With Commands".

You can use the subdir, scrolllines and scrollprompt common options with the query backup command. See Chapter 8, "Setting Common Options" for information about these common options.

filespec
Specifies the path and file name that you want to query. Use wildcard characters to specify a group of files or all the files in a directory.
Note:If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to query. This is the drive label name or UNC name on the workstation drive from which the file was backed up.

Use the file space name if the drive label name has changed, or if you are querying files backed up from another node with drive label names that are different from yours.

Examples

The following are examples of tasks you might perform using the query backup command.

Task
Query files from the abc file space proj directory.

Command: q b {abc}\proj\*.*

Task
Display a list of all active and inactive backup versions that were backed up from the c:\proj directory.

Command: q backup -ina c:\proj\*

Task
Display a list of all active and inactive backup versions that were backed up from the c:\proj directory. Use the dateformat and timeformat options to reformat the dates and times.

Command: q b -date=5 -time=4 -ina c:\proj\*

Task
Last week you backed up files from a diskette labeled docs. Display a list of those files.

Command: q b {docs}\*

Query Backupset

The query backupset command queries a backup set from a local file or the server. Attributes, directories, and files associated with the backup set are displayed.

Syntax

>>-Query BACKUPSET---+---------+---+- backupsetname-+----------><
                     '-options-'   '- filename------'
 

Parameters

options
You can use these command line options with the query backupset command: description and location. See Chapter 9, "Using Options With Commands" for information about these command line options.

You can use these common options with the query backupset command: scrolllines and scrollprompt. See Chapter 8, "Setting Common Options" for information about these common options.

backupsetname
Specifies the name of the backup set on the server from which to perform a query operation. Wildcards can be used to specify the backupsetname.

filename
Specifies the file name on your local machine that contains the backup set you want to query.

Examples

Task
Query a backup set on the server called mybackupsetname.

Command: query backupset mybackupsetname -loc=server

Task
Query the backup set contained in the backupsetfile.name file in the budget directory.

Command: query backupset c:\budget\backupsetfile.name loc=file

Query Filespace

The query filespace command displays a list of file spaces for a node stored on the server. A file space is a logical space on the server that contains files you backed up or archived. TSM assigns a separate file space on the server for each drive at your workstation from which you back up or archive files. The file space name is the same as the drive label name.

Syntax

>>-Query Filespace---+-----------+-----------------------------><
                     '- options--'
 

Parameters

options
You can use the fromnode command line option with the query filespace command. For more information, see Chapter 9, "Using Options With Commands".

You can use the scrolllines and scrollprompt options with the query filespace command. See Chapter 8, "Setting Common Options" for more information..

Examples

The following are examples of tasks you might perform using the query filespace command.

Task
Display your file spaces.

Command: query filespace

Task
Display your file spaces. Use the dateformat and timeformat options to reformat the dates and times.

Command: query filespace -date=5 -time=4

Query Mgmtclass

The query mgmtclass command displays information about the management classes available in your active policy set.

Your administrator defines management classes that contain attributes controlling whether a file is eligible for backup or archive services. They also contain attributes that determine how TSM manages the backups and archives after they reach the server.

Your active policy set contains a default management class; it can contain any number of additional management classes. You can assign specific management classes to files using include options that are located in the client options file. If you do not assign a management class to a file, TSM uses the default management class.

Syntax

>>-Query Mgmtclass---+-----------+-----------------------------><
                     '- options--'
 

Parameters

options
You can use the detail and fromnode command line options with the query mgmtclass command. For more information, see Chapter 9, "Using Options With Commands".

You can also use the scrolllines and scrollprompt common options with the query mgmtclass command. For more information about these common options, see Chapter 8, "Setting Common Options".

Examples

Task
Display available management classes.

Command: query mgmtclass

Query Restore

The query restore command displays a list of your restartable restore sessions in the server database. The list contains the following fields: owner, replace, subdir, preservepath, source, and destination.

Certain restore operations, called restartable restore sessions, start a special protocol within TSM. Some restore sessions can be restarted for these reasons:

Syntax

>>-Query Restore-----------------------------------------------><
 

Parameters

options
For information about common options you can use with the query restore command, see Chapter 8, "Setting Common Options".

Examples

Task
Display your restartable restore session in the server database.

Command: query restore

Query Schedule

The query schedule command displays the events scheduled for your node. Your administrator can set up schedules to perform automatic backups and archives for you. To plan your work, use this command to determine when the next scheduled events occur.

Syntax

>>-Query SCHedule---+-----------+------------------------------><
                    '- options--'
 

Parameters

options
You can use these common options with the query schedule command: dateformat, errorlogname, nodename and password. For more information about these common options, see Chapter 8, "Setting Common Options".

Examples

Task
Display your scheduled events.

Command: query schedule

Query Session

The query session command displays information about your TSM session, including the current node name, when the session was established, server information, and server connection information.

Syntax

>>-Query SEssion---+-----------+-------------------------------><
                   '- options--'
 

Parameters

options
For information about common options you can use with the query session command, see Chapter 8, "Setting Common Options".

Examples

Task
Display your session information.

Command: query session

Restart Restore

The restart restore command displays a list of your restartable restore sessions in the server database. You can select zero or more restartable restore sessions that you want to restart.

The restarted restore uses the same options you used in the failed restore. The restarted restore continues from the point at which the restore previously failed.

To cancel restartable restore sessions, use the cancel restore command. Use the restart restore command when:

Options from the failed session supersede new or changed options for the restarted session.

Syntax

>>-RESTArt Restore---+-----------+-----------------------------><
                     '- options--'
 

Parameters

options

For information about common options you can use with the restart restore command, see Chapter 8, "Setting Common Options".

Examples

Task
Restart a restore.

Command: restart restore

Restore

The restore command obtains copies of backup versions of your files from a TSM server. To restore files, specify the directories or selected files, or select the files from a list. Restore files to the directory from which you backed them up, or to a different directory. TSM uses the preservepath option with the subtree value as the default for restoring files. For more information on this option, see Chapter 9, "Using Options With Commands".

Restoring Microsoft DFS Junctions

To restore Microsoft DFS junctions, you must restore Microsoft DFS root. If you select the junction point itself, TSM restores data under junction, but not the junction itself. If you select a junction point that no longer exists under DFS root, TSM creates a local directory under DFS root with the same name as the junction, before restoring data.

Syntax

>>-REStore---+--------+---+----------------------+-------------->
             '- FILE--'   '-+-----------------+--'
                            |  .-----------.  |
                            |  V           |  |
                            '---- options--+--'
 
>-----+- sourcefilespec----------------+------------------------>
      '- {filespacename}sourcefilespec-'
 
>-----+----------------------+---------------------------------><
      '- destinationfilespec-'
 

Parameters

file
This parameter specifies that the source file specification is an explicit filename. This parameter is required when you are restoring a file name from the current path, you do not specify a relative or absolute path, and the file name conflicts with one of the reserved restore command keywords, such as restore backupset.

options
You can use these command line options with the restore command: dirsonly, filesonly, fromdate, fromnode, fromtime, ifnewer, inactive, latest, pick, pitdate, pittime, preservepath, todate, totime. For more information, see Chapter 9, "Using Options With Commands".

You can use these common options with the restore command: replace, subdir. See Chapter 8, "Setting Common Options" for information about common options.

sourcefilespec
Specifies the path and file name in storage that you want to restore. Use wildcard characters to specify a group of files or all the files in a directory. If the sourcefilespec is fully wildcarded and the options: pick, latest, inactive, fromdate, and todate are not specified, TSM starts a special, highly-efficient restore process. If this process is interrupted for any reason, use the query restore command to display a list of restartable restores. The restart restore command can be used to complete the restore once the interruption is corrected.
Note:If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the files you want to restore. This is the drive label name on the workstation drive from which the files were backed up.

Use the file space name if the drive label name has changed, or if you are restoring files backed up from another node with drive labels that are different from yours.

destinationfilespec
Specifies the path and file name where you want to place the restored files. If you do not specify a destination, TSM restores the files to the original source path.

If the destination drive does not exist, end the file specification either with a directory delimiter (\) or a file name. Otherwise, TSM assumes the last name is a file name and tries to repeatedly overwrite the file as each file is restored.

Examples

The following are examples of tasks you might perform using the restore command.

Task
Restore a single file named budget.fin.

Command: restore c:\devel\projecta\budget.fin

Task
Restore a single file named budget.fin which resides in the current directory.

Command: restore file budget.fin

Task
Restore files from the abc file space proj directory.

Command: rest {abc}\proj\*.*

Task
Restore all files with a file extension of .c from the c:\devel\projecta directory.

Command: rest c:\devel\projecta\*.c

Task
Restore all files with an extension of .c from the \devel\projecta directory located in the winnt file space.

Command: rest {winnt}\devel\projecta\*.c

Note:When an only partially wildcarded source operand is used and then interrupted, a restartable restore session is not created.

Task
Restore all files with a file extension of .c from the c:\devel\projecta directory to the c:\newdevel\projectn\projecta directory. If the projectn or projectn\projecta directory does not exist, it is created.

Command: restore c:\devel\projecta\*.c c:\newdevel\projectn

Task
Restore files in the c:\project directory. Use the pick and inactive options to select active and inactive backup versions.

Note: Even though the source operand is fully wildcarded, the presence of the pick and inactive options prevents creation of a restartable restore session in the event this restore is interrupted.

Command: restore c:\project\* -pi -ina

Restore Backupset

The restore backupset command restores a backup set from the server or a local file.

If you are unable to restore a backup set from portable media to your client machine, check with your TSM administrator to ensure that the portable media was created on a device using a format that is compatible with your device.

Syntax

>>-REStore BACKUPSET---+---------+---+- backupsetname-+--------->
                       '-options-'   '- filename------'
 
>-----+- sourcefilespec----------------+------------------------>
      '- {filespacename}sourcefilespec-'
 
>-----+----------------------+---------------------------------><
      '- destinationfilespec-'
 

Parameters

options
You can use these command line options with the restore backupset command: location, ifnewer, and preservepath. See Chapter 9, "Using Options With Commands" for information about these command line options.

You can use these common options with the restore backupset command: quiet, replace, and subdir. See Chapter 8, "Setting Common Options" for information about these common options.

backupsetname
Specifies the name of the backup set on the server from which to perform a restore operation. Wildcard characters cannot be used to specify the backupsetname.

filename
Specifies the name of a local file from which to perform a restore operation.

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

{filespacename}
Specifies the file space name that contains the files you want to restore.

destinationfilespec
Specifies the destination path. The default is to restore to the original source path.

Examples

The following are examples of tasks you might perform using the restore backupset command.

Task
Restore a backup set called mybackupsetname from the server.

Command: restore backupset mybackupsetname -loc=server

Task
Restore the backup set contained in the backupsetfile.name file in the budget directory.

Command: restore backupset c:\budget\backupsetfile.name -loc=file

Retrieve

The retrieve command obtains copies of archived files from the server. You can retrieve specific files or entire directories. Use the description option to specify the descriptions assigned to the files you want to retrieve.

Place the retrieved files in the same directory from which they were archived, or in a different directory. TSM uses the preservepath option with the subtree value as the default for restoring files. For more information on this option, see Chapter 9, "Using Options With Commands".

Syntax

>>-RETrieve---+-----------------+------------------------------->
              |  .-----------.  |
              |  V           |  |
              '---- options--+--'
 
>-----+- sourcefilespec----------------+------------------------>
      '- {filespacename}sourcefilespec-'
 
>-----+----------------------+---------------------------------><
      '- destinationfilespec-'
 

Parameters

options
You can use these command line options with the retrieve command: description, dirsonly, filesonly, fromdate, fromnode, fromtime, pick, todate, and totime. For more information, see Chapter 9, "Using Options With Commands".

For information about common options you can use with the retrieve command, see Chapter 8, "Setting Common Options".

sourcefilespec
Specifies the path and file name that you want to retrieve. Use wildcard characters to specify a group of files or all the files in a directory.
Note:If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the files you want to retrieve. This name is the drive label on the workstation drive from which the files were archived.

Use the file space name if the drive label name has changed, or if you are retrieving files archived from another node with drive label names that are different from yours.

destinationfilespec
Specifies the path and file name where you want to place the retrieved files. If you do not specify a destination, TSM returns the files to their original source path.

If the destination drive does not exist, end the file specification either with a directory delimiter (\) or a file name. Otherwise, TSM assumes the last name is a file name and tries to repeatedly overwrite the file as each file is retrieved.

Examples

The following are examples of tasks you might perform using the retrieve command.

Task
Retrieve a single file named budget.fin.

Command: ret c:\devel\projecta\budget.fin

Task
Retrieve all files with an extension of .c from the c:\devel\projecta directory.

Command: ret c:\devel\projecta\*.c

Task
Retrieve all files with a file extension of .c from the \devel\projecta directory on the winnt file space.

Command: ret {winnt}\devel\projecta\*.c

Task
Retrieve all files in the c:\devel directory.

Command: ret c:\devel\*

Task
Retrieve files from the abc file space proj directory.

Command: ret {abc}\proj\*.*

Task
Retrieve all files with a file extension of .c from the c:\devel\projecta directory to the c:\newdevel\projectn\projecta directory. If the \projectn or the \projectn\projecta directory does not exist, it is created.

Command: ret c:\devel\projecta\*.c c:\newdevel\projectn\

Task
Retrieve files in the c:\project directory. Use the pick option.

Command: ret c:\project\* -pick

Schedule

The schedule command starts the client scheduler on your workstation. The client scheduler must be running before scheduled work can start.

When you start the client scheduler, it continuously contacts the server for scheduled events based on the time you specified with the queryschedperiod option in your client options file. If your administrator sets this option for all nodes, that setting overrides your setting.

If you are using TCP/IP communications, the server can prompt your workstation when it is time to run a scheduled event. To do so, set the schedmode option to prompted in the client options file or on the schedule command.

After you start the client scheduler, it continues to run and to start scheduled events until you press Ctrl+Break, restart the machine, or turn off the machine to end it.

Note:You cannot enter this command in interactive mode.

Syntax

>>-SCHedule---+-----------------+------------------------------><
              |  .-----------.  |
              |  V           |  |
              '---- options--+--'
 

Parameters

options
You can use these common options: maxcmdretries, password, queryschedperiod, retryperiod, schedlogname, schedmode, and tcpclientport. See Chapter 8, "Setting Common Options" for more information.

Examples

The following is an example of a task you might perform using the schedule command.

Task
Start the client scheduler.

Command: dsmc sch -password=notell

Selective

The selective command backs up files that you specify. If these files become damaged or lost, you can replace them with backup versions from the server. When you run a selective backup, TSM backs up all the files unless they are excluded from backup in your include-exclude list, or they do not meet management class requirements for serialization.

During a selective backup, TSM sends copies of the files to the server even if they have not changed since the last backup. This might result in more than one copy of the same file on the server. If this occurs, you might not have as many different down-level versions of the file on the server as you intended. Your version limit might consist of identical files. To avoid this, use the incremental command to back up only new and changed files.

You can selectively back up single files or directories. You can also use wildcard characters to back up groups of related files.

During a selective backup, a directory path may be backed up, even if the specific file that was targeted for backup is not found. For example:

   dsmc selective c:\dir1\dir2\bogus.txt

still backs up dir1 and dir2 even if the file bogus.txt does not exist.

If the selective command is retried because of a communication failure or session loss, the transfer statistics will display the number of bytes TSM attempts to transfer during all command attempts. Therefore, the statistics for bytes transferred may not match the file statistics, such as those for file size.

Syntax

                                     .----------------.
                                     V                |
>>-Selective---+-----------------+------- filespec----+--------><
               |  .-----------.  |
               |  V           |  |
               '---- options--+--'
 

Parameters

options
You can use these command line options with the selective command: dirsonly, filesonly. For more information, see Chapter 9, "Using Options With Commands".

You can use these common options with the selective command: changingretries, quiet, tapeprompt, and subdir. See Chapter 8, "Setting Common Options" for information about these common options.

filespec
Specifies the path and file name that you want to back up. Use wildcard characters to select a group of files or all the files in a directory. You can enter more than one file specification in a command. When backing up a file system, specify the file system with a trailing slash.

Examples

The following are examples of tasks you can perform using the selective command.

Task
Back up the proja.dev file in the c:\devel directory.

Command: sel c:\devel\proja.dev

Task
Back up all files in the c:\devel directory whose file names begin with proj.

Command: sel c:\devel\proj*.*

Task
Back up all files in the c:\devel directory whose file names begin with proj. Back up all files with a file extension of .fin in the c:\planning directory.

Command: sel c:\devel\proj* c:\planning\*.fin

Set Access

The set access command gives users at other nodes access to your backup versions or archived copies. You can give another user access to a specific file, multiple files, or all files in a directory. When you give access to another user, that user can restore or retrieve your objects. Specify in the command whether you are giving access to archives or backups.

Note:You cannot give access to both archives and backups using a single command.

Syntax

>>-SET Access---+- Archive-+---+- filespec----------------+----->
                '- Backup--'   '- {filespacename}filespec-'
 
>----- node---+-----------------+------------------------------><
              |  .-----------.  |
              |  V           |  |
              '---- options--+--'
 

Parameters

backup
Permits access to backup versions of files .

filespec
Specifies the path, file or directory to which you are giving access to another node or user. Use wildcard characters to specify a group of files, or all files in a directory; all objects in a directory branch; or all objects in a drive. However, you cannot use a wildcard to specify all drives. Use a single asterisk "*" for the file spec to give access to all files owned by you and backed up on the server. When the command, set access backup "*" node, is entered, no check is made with the server; it is assumed you have at least one object backed up.

If you give access to a branch of the current working directory, you only need to specify the branch. If you give access to objects that are not in a branch of the current working directory, you must specify the drive and directory. The file spec to which you gave access must have at least one backup version or archive copy object (file or directory) on the server.

To give access to all objects below a certain level, use an asterisk, directory delimiter, and an asterisk at the end of your file spec. For example, to give access to all objects below d:\test\, use file spec d:\test\*\*.

To specify all files in a named directory, enter c:\proj\* on the command line. To specify all files in all directories off of the root directory, enter d:\*\* on the command line. Enter d:\* on one set access command and d:\*\* on another if you want another user to have complete access to your file space. The first d:\* gives access to all subdirectories and all files off of the root directory.

Use the file space name if the drive label name has changed.

Note: If you include filespacename, do not include a drive letter in the file specification.

{filespacename}
Specifies the file space name (enclosed in braces) on the server that contains the files to which you are giving access. This name is the drive label name on the workstation drive from which the file was backed up or archived. Use the file space name if the drive label name has changed.

node
Specifies the client node of the user to whom you are giving access. Use wildcards to give access to more than one node with similar node names. Use an asterisk (*) to give access to all nodes.

options
See Chapter 8, "Setting Common Options" for information about common options that you can use with this command.

Examples

The following are examples of tasks you might perform using the set access command:

Task
Give the user at node_2 authority to restore all files with an extension of .c from the c:\devel\proja directory.

Command: set access backup c:\devel\proja\*.c node_2

Task
Give the user at node_3 authority to retrieve all files in the c:\devel directory, but do not permit access to files in subdirectories of c:\devel, such as c:\devel\proj.

Command: set access archive c:\devel\* node_3

Task
Give all nodes whose names end with bldgb the authority to restore all backup versions from all directories on the d: drive. The d: drive has the file space name of project.

Command: set ac b {project}\*\* *bldgb

Task
Back up an entire drive.

Command: set ac d:*\* user

Set Password

The set password command changes the TSM password for your workstation. You are prompted twice for your new password.

A password is not case-sensitive, and it can be as many as 64 characters. Valid characters are:

a-z
Any letter, a through z, upper or lower-case
0-9
Any number, 0 through 9
+
Plus
.
Period
_
Underscore
-
Hyphen
&
Ampersand

Syntax

>>-SET Password---+--------------+---+-----------------+-------><
                  '- oldpw newpw-'   |  .-----------.  |
                                     |  V           |  |
                                     '---- options--+--'
 

Parameters

oldpw
Specifies the current password for your workstation.

newpw
Specifies the new password for your workstation.

options
Select any valid common option. For more information, see Chapter 8, "Setting Common Options".

Examples

The following is an example of using the set password command.

Task
Change your password from osecret to nsecret.

Command: set password osecret nsecret


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