Using the Backup-Archive Client


Chapter 10. Using Commands

This chapter describes how to start or end a client command session, and how to enter commands. It also provides detailed information about each command in the command reference section.

See Table 24 for a list of tasks related to entering commands.

Table 24. 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 25 provides an alphabetical list of commands, a brief description, and where to go in this book for more information.

Table 25. Commands

Command Description Page
Archive Archives files from a workstation to storage. Archive
Cancel Restore Displays a list of restartable restore sessions and allows 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 storage. Delete Archive
Delete Filespace Deletes file spaces in 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 Backup Set Displays the attributes, directories and files associated with a backup set. Query Backupset
Query Filespace Displays a list of file spaces in 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
Query TSA Displays information about the current TSA. Query TSA
Restart Restore Displays a list of restartable restore sessions and allows you to select one to restart. Restart Restore
Restore Restores backup versions from storage. Restore
Restore Backup Set Restores a backup set from the server or a local file. Restore Backupset
Retrieve Retrieves archived files from 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. Select batch mode when you want to enter a single client command. TSM processes the command and returns to the command prompt.

Select 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

When you enter a single command in batch mode, precede it with the executable program name, load dsmc. For example, to process the incremental command in batch mode, type load dsmc incremental and press Enter. If a password is required, TSM prompts you each time you enter a command. Type your password and press Enter.

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

   load dsmc incremental -password=secret

If you use passwordaccess generate, you need not specify your password on the command, nor are you prompted to do so.

Process Commands in Interactive Mode

When you enter a series of commands in interactive mode, do not precede them with the executable program name, load dsmc. Instead, enter load dsmc on the command line and press Enter. When the command prompt appears, type the command name, and press Enter. Alternatively, you can enter load 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 will be displayed. For example, if your password is secret, you would enter:

   load 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 name that identifies it. 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, the minimum abbreviation, or an abbreviation containing the minimum abbreviation allowed. 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:

Filespec Syntax

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

Parameters

Commands have either required parameters, optional parameters, or both. 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 from the project directory, you would enter:

   load dsmc archive t3\sys:project/budget

It is not necessary to enter the NetWare server name from which you are working.

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, which identifies the path and filename in storage that you want to restore, and an optional parameter, destinationfilespec, which identifies the path and filename where you want to place the restored files. If you do not use 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 the file budget in the project directory on the nw1\sys: volume to the newproj directory on the nw2\sys: volume with a new file name of planning, you would enter:

   load dsmc restore nw1\sys:project/budget  nw2\sys:newproj/planning

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


Remembering Previous Commands

TSM allows you to recall and edit as many as twenty previously entered commands using the up arrow and down arrow keys. Pressing the Up arrow key displays the previous string in memory. Pressing the Down arrow key displays the next string in memory. The table below lists other functions you can perform when you recall commands.

Function Press
Display the previous string in memory. Up arrow
Display the next string in memory. Down arrow
Move to the beginning of the string. Home
Move to the end of the string. End
Move to the left. Left arrow
Move to the right. Right arrow
Move five spaces to the right. Tab right
Delete the character at the cursor. Delete
Delete the character to the left of the cursor. Backspace
Insert a character. Toggle the Insert key
Finish. Enter
Clear the current line. Esc
End the program. CTRL-C
End the program. QQ (Scheduler or Incremental Backup/Restore)

Using Wildcard Characters

In a command, wildcard characters can be used in the file name or extension only. You cannot use them to specify destination files, volume names, server names, the bindery, or NDS names. Use wildcard characters when you want to specify multiple files with similar names in one command. Without wildcard characters, you would need to 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 26 shows examples of each wildcard.

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

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 any files that you want to keep in their present condition. To release storage space on your workstation, delete the files as you archive them. Retrieve the archived files to your workstation whenever you need them again.

Syntax

                           .-----------------------.
                           V                       |
>>-Archive---+---------+-----+-filespec---------+--+-----------><
             '-options-'     +-BINdery----------+
                             '-DIRectory or NDS-'
 

Parameters

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

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

filespec
Describes the drive, 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.

BINdery
Specifies that you want to archive the bindery.

DIRectory or NDS
Specifies that you want to archive the NDS.

Examples

The table below provides examples of some tasks you might perform using the archive command.

Task Command
Archive a single file named budget.
load dsmc archive t9\sys:user/proj1/budget  

Archive all files in the T9\sys:user/proj1 directory that end with the characters .txt.
load dsmc archive t9\sys:usr/proj1/*.txt

Archive a single file named budget and files with names that end with the characters .txt from the server t9 and the volume sys:.
load dsmc arch t9\sys:user/prj/budget 
  t9\sys:user/prj/*.txt

Archive all files in the t9\sys:home directory.
load dsmc archive t9\sys:home/*

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.

You may want to cancel restartable restore sessions with the cancel restore command or restart restartable restore sessions with the restart restore command for the following reasons:

Syntax

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

Parameters

There are no parameters for this command.

Examples

To cancel a restore, you would enter:

   load dsmc 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 the access a user has to any files specified by that rule.

Syntax

>>-Delete ACcess---+---------+---------------------------------><
                   '-options-'
 

Parameters

options
For information about common options you can use with the delete access command, see Chapter 8, Setting Common Options

Examples

The table below provides an example of a task you might perform using the delete access command.

Task Command
Display a list of current authorization rules and select the rules you want to delete. See the screen example below.
delete acc

+--------------------------------------------------------------------------------+
|                                                                                |
|Index  Type       Node    User   Path                                           |
|_____  ____   ____________________________________                              |
|1    Backup     node1     *     mo\sys:u/dev/proja/list                         |
|2    Archive    node3     *     mo\sys:u/fin/budg/depta                         |
|3    Backup     node4     *     mo\sys:u/plan/exp/deptc                         |
|4    Archive    node5     *     mo\sys:u/mfg/inv/parta                          |
|Enter Index of rule(s) to delete, or quit to cancel:                            |
+--------------------------------------------------------------------------------+

To delete the authorization rules that allow node3 and node5 to access your files, type 2 4 or (2,4) (your selections can be separated by commas or spaces) and press Enter. Quit without making a selection by entering quit.

Delete Archive

The delete archive command deletes archived files from 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

                                  .-----------------------.
                                  V                       |
>>-Delete ARchive---+---------+-----+-filespec---------+--+----><
                    '-options-'     +-BINdery----------+
                                    '-DIRectory or NDS-'
 

Parameters

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

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

filespec
Specifies the path and filename that you want to delete from storage. Use wildcards to specify a group of files or all files in a directory.

BINdery
Specifies that you want to delete the archived bindery.

DIRectory or NDS
Specifies that you want to delete the archived NDS.

Examples

The table below provides examples of some tasks you might perform using the delete archive command.

Task Command
Delete a single archived file named budget. load dsmc del arch sys:user/home/proj1/budget
Delete all archived files in the sys:user/home/proj1 directory that end with the characters .txt. load dsmc del arch sys:user/home/proj1/*.txt
Delete archived files in the sys:user/project directory using the pick option. load dsmc del ar sys:user/project/* -pick

Delete Filespace

The delete filespace command deletes file spaces from 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 files 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 retrieve the files. Verify that the files are obsolete before you delete them.

Syntax

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

Parameters

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

Examples

The table below provides an example of some tasks you might perform using the delete filespace command.

Task Command
Delete a file space. load dsmc delete filespace
Delete a file space. Use the dateformat and timeformat options to reformat the dates and times. These formats remain in effect for the rest of the interactive session unless you enter them again on a later command. load dsmc del fil -date=5 -time=4

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

Parameters

There are no parameters for this command.

Examples

To display a list of help choices, type help and press Enter.

Incremental

The incremental command backs up all new or changed files in your default client domain, or on the NetWare volumes you specify that are not excluded from backup services. TSM also backs up file system trustee rights along with file data. It is not possible to restore only the trustee rights; they are restored as part of the file restore process.

In order for TSM to back up a file, it must meet management class requirements for frequency, mode, and serialization. The following attributes in the management class assigned to a file affect whether the file is actually backed up.

You can incrementally back up an entire filespace (domain) or just a single file. If you specify only the filespace name, the entire directory tree is traversed. If you specify a directory, only that directory is backed up, unless you use subdir=y. This is considered a partial incremental back up.

There are two types of incremental backups: full and partial. You must perform a full incremental backup before you can perform a partial.

  1. A full incremental backup ensures that backups are managed according to your installation's storage management policies. It ensures that your backup storage accurately reflects the state of your NetWare server.

  2. A partial incremental backup should complete more quickly than a full incremental backup and requires less memory. If you are constrained for time or machine memory, a partial incremental backup might be best.

    For more information about partial incremental backups, see "Partial Incremental".

Normally, use incremental backup to back up all files created or changed since the last time you ran a backup. However, you can exclude specific files or groups of files from backup services by using the exclude option in your client option file's include-exclude list.

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.

To perform an incremental-by-date backup, use the incrbydate option if you must meet a limited backup time window, and using a full incremental backup would take longer than the scheduled time. If you use incrbydate on only part of a file system, the date of the last incremental is not updated, and a second incremental-by-date will back up the files again.

If you are running NetWare Btrieve on your NetWare server (or any other server-based database), stop the database application before backing up the files associated with the database. Many database applications place locks on files that can prevent TSM from backing them up. Because TSM is a Storage Management Services (SMS) backup application, it supports database Target Service Agents (TSA's) as soon as they are available. This allows TSM to maintain database integrity without manual interaction.

If you are running your communication with SNA LU6.2 (NetWare for SAA), you cannot stop the Btrieve database application because NetWare for SAA requires Btrieve to be running. Therefore, you cannot back up the file named btrieve.trn in the system subdirectory. As a result, you might not be able to maintain true data integrity here.

If TSM refuses to back up a file, check to see if it is marked for execute only or it is opened and locked by another user.

If your system fails during an incremental backup, TSM checks all files again when you start the next incremental backup. Only files that have changed are backed up. If the back up fails, the transfer statistics that appear during subsequent back up attempts will show the number of bytes TSM tried to transfer during all commands attempts. Therefore, the statistics for bytes transferred may not match the file statistics, such as those for file size.

For information about backing up server specific information, see the Netware Backup and Recovery Guide. This document is shipped with the client under the name ntwback.htm.

Syntax

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

Parameters

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

filespec
Specifies the path and file name that you want to back up. Use wildcards to specify a group of files, all the files in a directory, all objects in a directory branch, or all objects in a volume.

Separate each file specification by a space if you want to enter more than one file specification in a command. If a file specification is not supplied, the default domain or the domain specified as an option is backed up. Do not use a trailing slash to specify the volume, directory or file.

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

filespacename
Specifies the file space name on the server that contains the files you want to back up.

Examples

The table below provides examples of some tasks you might perform using the incremental command.

Task Command
Run an incremental backup for your default client domain as indicated in the client options file. load dsmc i
Run a full incremental backup for the sys: volume, the data: volume and the bindery on server b9. load dsmc i b9\sys: b9\data: b9\bind:
Run a partial incremental backup. load dsmc inc vol:system/*
Run a partial incremental backup by date using the incrbydate option. load dsmc inc -incrbydate
Incrementally back up the NDS. load dsmc inc nds:
Run an incremental backup remotely for the sys: volume on server b9. load dsmc inc b9\sys:
Run a partial incremental backup of the NDS. load dsmc inc nds:.o=ann.*

Loop

The loop command starts an interactive command-line session that is maintained until you enter quit. If you use an interactive command-line session, it is not necessary to precede each command name with dsmc and your password, if one is required. Once you start an interactive session, most options you entered with other commands remain 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
volinformation

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

The following options cannot be used with the loop command:

Syntax

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

Parameters

options

For information about the common options you can use with the loop command, seeChapter 8, Setting Common Options.

Examples

To start an interactive command-line session, enter load dsmc loop

At the tsm>

prompt, enter a command.

There are three methods for ending an interactive session. Select one of the following:

Note:Do not attempt to end an interactive session by unloading 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 commands.

Examples

The table below provides an example of how to use the macro command.

Task Command
Selectively back up files in the following directories:sys:project/proja, sys:project/projb, and sys:project/projc
macro sys:adsm/backabc.mac
where backabc.mac

contains the following statements:

sel sys:devel/project/proja/*
sel sys:devel/project/projb/*
sel sys:devel/project/projc/*

Query Access

The query access command displays a list of nodes 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. The information includes:

Syntax

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

Parameters

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

Examples

To display a list of nodes that have access to your files, enter load dsmc q ac

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

                                 .-----------------------.
                                 V                       |
>>-Query ARchive---+---------+-----+-filespec---------+--+-----><
                   '-options-'     +-BINdery----------+
                                   '-DIRectory or NDS-'
 

Parameters

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

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

filespec
Specifies the path and file name that you want to query. Use wildcards to specify a group of files or all the files in a directory.

BINdery
Displays a list of archived bindery files.

DIRectory or NDS
Displays a list of archived NDS files.

Examples

The table below provides examples of some tasks you might perform using the query archive command.

Task Command
Display a list of all your archived files in the serverA's sys: volume. load dsmc q ar -sub=y servera\sys:*
Display a list of all your archived files on servera\sys:. Use the dateformat and timeformat options to reformat the dates and times. load dsmc q ar -sub=yes -date=5 -time=4 servera\sys:*
Display a list of archived files in the servera\sys:u/proj directory whose first four characters of the file name begin with proj. Use the dateformat and timeformat options. load dsmc q ar -date=1 -time=4 servera\sys:uproj/proj*

Query Backup

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

Syntax

                                .------------------------.
                                V                        |
>>-Query Backup---+---------+-----+- filespec---------+--+-----><
                  '-options-'     +- BINdery----------+
                                  '- DIRectory or NDS-'
 

Parameters

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

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

filespec
This variable specifies the path and file name that you want to query. Use wildcards to specify a group of files or all the files in a directory.

BINdery
This parameter specifies that the three system files that make up the bindery database are to be backed up.

DIRectory or NDS
This parameter displays a list of backed up NDS objects. To display a list of the entire directory, specify directory: or directory:*. To display a list of only one container in the directory, specify directory:.o=container_name. In all examples, nds: instead of dir: may be entered.

Examples

The table below provides examples of some tasks you might perform using the query backup command.

Task Command
Display a list of all your backed up files on the sys: volume.
load dsmc q backup -su=y serva\sys:*

Display a list of all your backed up files. Use the dateformat and timeformat options to reformat the dates and times. load dsmc q b -date=1 -time=4 -su=y serva\sys:*
Display a list of files that were backed up from the serva\sys:proj directory that have file names that begin with the four characters proj. Use the dateformat and timeformat options. load dsmc q b -date=1 -time=4 serva\sys:proj/proj*

Query Backupset

The query backupset command queries a backupset from the server, a tape device, or a local file. This command can display the attributes, or attributes plus directories and files associated with the backup set.

Syntax

>>-Query BACKUPSET---+----------+---+- backupsetname-+---------->
                     '- options-'   '- filename------'
 
>-----+-------------------+------------------------------------><
      +- sourcefilespec---+
      +- BINdery----------+
      '- DIRectory or NDS-'
 

Parameters

options
You can use these command line options with the query backupset command: description, 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 and subdir. See Chapter 8, "Setting Common Options" for information about these common options.

backupsetname
Specifies the backupset name to use for the query. This must be the name on the server. The name can contain wildcards.

filename
Specifies the file name on your local machine that contains the backupset you want to query. This parameter requires the location=file option.

sourcefilespec
Specifies the source path which can be a portion of the backupset. The default is to query the entire backupset.

BINdery
Specifies that the three system files that make up the bindery database are to be queried.

DIRectory or NDS
Queries the NDS.

Examples

Task Command
Query the meta data of a single file named budget.dev from the /dev/rmt0 device.
load dsmc query backupset type=info sys:u/jones
/budget.dev -fromfile=/dev/rmt0 

Query all files in the budget directory that contain a file extension of .txt, from the /dev/rmt0 device.
load dsmc query backupset type=all sys:u/budget
/*.txt -fromfile=/dev/rmt0

Query the meta data and files on the volume with the description of budget from the /dev/rmt0 device.
load dsmc query backupset -des=budget -type=all 
-fromfile=/dev/rmt0

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 node from which you back up or archive files.

Syntax

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

Parameters

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

You can use the following command-line option:

For more information about command-line options, see Chapter 9, Using Options With Commands.

Examples

The table below provides examples of some tasks you might perform using the query filespace command.

Task Commands
Display your file spaces. load dsmc q filespace
Display your file spaces. Use the dateformat and timeformat options to reformat the dates and times. q filespace -date=1 -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.

When you archive files, you can override the assigned management class by using the archmc option.

Syntax

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

Parameters

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

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

Examples

To display default and available management classes, enter load dsmc q mgmt -det.

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, invoke a special protocol within TSM. Some restore sessions can be restarted for these reasons:

Syntax

>>-Query REStore-----------------------------------------------><
 

Parameters

There are no parameters for this command.

Examples

The following is an example of the output when you use query restore:

    owner      Rep Sub Pre Source   
    -----      --- --- --- -------
1.  framke      P   N   L   \home\ramke\testdir\*
2.  framke      P   N   L   \home\framke\*
                           dest = \tmp\
 

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 of those scheduled events will occur.

Syntax

>>-Query SChedule---+---------+--------------------------------><
                    '-options-'
 

Parameters

options
You can use the following common options with the query schedule command:

Go to Chapter 8, Setting Common Options for information about common options.

Examples

To display your scheduled events, enter

load dsmc query schedule

Query Session

The query session command displays the information about your TSM session. This information includes 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 your can use with the query session command, see Chapter 8, Setting Common Options.

Examples

To display your session information, enter

load dsmc query se

A sample query session display follows:

Tivoli Storage Manager
Command Line Backup Client Interface - Version 3, Release 7
(C) Copyright IBM Corporation, 1990, 1999, All Rights Reserved.
 
Node Name: EPSILON3
Session established with server FIJI_0918GA: AIX-RS/6000
  Server Version 3, Release 1
  Server date/time: 07/04/1999 16:09:52  
  Last access: 07/04/1999 16:08:39
 
Server Connection Information
 
Server Name.............: FIJI_0918GA
Server Type.............: AIX-RS/6000
Server Version..........: Ver. 3, Rel. 1
Last Access Date........: 07/04/1999 16:08:39
Delete Backup Files.....: Yes
Delete Archive Files....: Yes
 
Node Name...............: epsilon3
User Name...............: amperez

Query TSA

The query tsa command displays information associated with a specific NetWare Target Service Agent (TSA). This information includes the TSA name, type, version information, and location of the password file for the TSA (if applicable).

This command also verifies the user ID and password information, depending on how they are stored. If the user id and password have been stored locally using the nwpwfile option to create a password file, and either the current password file does not contain valid information or a current password files does not exist, this command prompts for the correct information. (For more information on nwpwfile, see Nwpwfile.

If the password is stored in the local options file nwuser, the command verifies the user ID and password in that file. For more information on nwuser, see Nwuser.

Syntax

>>-Query TSA---+---------+---+----------------+----------------><
               '-options-'   +-tsaname--------+
                             +-NDS------------+
                             '-servername\NDS-'
 

Parameters

options
You can specify the nwuser option with the query tsa command. This is helpful if you wish to generate a password to be stored locally in your nwpwfile options file, and you wish to use the query tsa command in batch mode.

tsaname
Specifies the NetWare file server TSA name you want to query. If neither tsaname nor NDS is specified, the local NetWare file server name is used.

NDS
Specifies that you want to query the TSA (TSANDS.NLM) for the Novell Directory Services (NDS).

servername\NDS
Specifies that you want to query a remote TSA (TSANDS.NLM) for the Novell Directory Services (NDS) which is loaded on fileserver servername.

Examples

The table below provides examples of some tasks that you can perform using the query tsa command.

Task Command
Query local file server TSA. load dsmc q tsa
Query TSA for file server ramke. load dsmc q tsa ramke
Query TSA for NDS. load dsmc q tsa nds
Query TSA for NDS; tsands.nlm is loaded remotely on file server mock. load dsmc q tsa mock/nds
Create .pwd file for file server ramke in batch mode. load dsmc q tsa ramke -nwuser=.admin.adsm:viksne -nwpwfile=yes
Create .pwd file for file server ramke in interactive mode. dsmc q tsa ramke -nwpwfile=yes
Create .pwd file for NDS interactively. dsmc q tsa nds -nwpwfile=yes

Example 1

A sample output for query tsa follows:

Tivoli Storage Manager
Command Line Backup Client Interface - Version 3, Release 1
(C) Copyright IBM Corporation, 1990, 1999, All Rights Reserved.
 
Node Name: GOETHE
Session established with server spikes: Windows NT
  Server Version 3, Release 1, Level 0.1
  Server date/time: 16/04/1999 16:09:52  
  Last access: 16/04/1999 16:08:39
 
Connecting to a NetWare File System (goethe)
 
Connected to goethe
 
TSA Name..........: goethe
TSA Module Name........: TSA410.NLM
TSA Version.....: 4.14.0
SMDR Version....: 1.0.0
User/Password Location..: goethe\sys:tsm/030199/74cc82cb.pwd
User/Password Valid.....: Yes
 
tsm>

Example 2

A sample output for query tsa nds (no password file present) follows:

Tivoli Storage Manager
Command Line Backup Client Interface - Version 3, Release 7
(C) Copyright IBM Corporation, 1990, 1999, All Rights Reserved.
 
Node Name: goethe
Session established with server spikes: Windows NT
  Server Version 3, Release 1, Level 0.1
  Server date/time: 06/04/1999 16:09:52  
  Last access: 06/04/1999 16:08:39
 
Connecting to a Novell Directory (goethe_tree)
 
Please enter NetWare user for "goethe_tree":.admin.adsm
 
Please enter the password on "goethe_tree" for NetWare user".admin.adsm":*****
 
Connected to goethe_tree
 
NetWare TSA Information
 
TSA Name..........: goethe
TSA Module Name........: tsands
TSA Version.....: 1.0.0
SMDR Version....: 1.0.0
User/Password Location..: goethe\sys:tsm/040199/5e82fd66.pwd
User/Password Valid.....: Yes
 
tsm>

Example 3

A sample output for query tsa (non-NetWare platforms) follows:

Tivoli Storage Manager
Command Line Backup Client Interface - Version 3, Release 7
(C) Copyright IBM Corporation, 1990, 1999, All Rights Reserved.
 
Node Name: spikes
Session established with server spikes: Windows NT
  Server Version 3, Release 1, Level 0.1
  Server date/time: 06/04/1999 16:09:52  Last access: 06/04/1999 16:08:39
   
Selected function is not supported for this client platform.
 
tsm>

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.

You may want to restart restartable restore sessions by using the restart restore command or cancel restartable restore sessions by using the cancel restore command for the following reasons:

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

Syntax

>>-RESTArt restore-+---------+---------------------------------><
                   '-options-'
 

Parameters

options

Go to Chapter 8, Setting Common Options for information about common options.

Examples

To restart a restore, you would enter:

   load dsmc restart restore

Restore

The restore command obtains copies of backup versions of your files from a server. To restore files, specify the directories or selected files, or select the files from a list. Restore files to the directory from where you backed them up, or to a different directory.

System trustee rights are restored as part of the file restore process. They cannot be restored alone or by using the volinfo option.

The restore command can be used to restore a backupset object. See Restore Backupset for the syntax.

Syntax

>>-REStore----+--------+---+---------+-------------------------->
              '- FILE--'   '-options-'
 
      .-----------------------.
      V                       |
>-------+-sourcefilespec---+--+---+---------------------+------><
        +-BINdery----------+      '-destinationfilespec-'
        '-DIRectory or NDS-'
 

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
For information about common options you can use with the restore command, see Chapter 8, Setting Common Options.

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

The following selections are also available for this command:

sourcefilespec
This variable specifies the path and file name that you want to restore. Use wildcards to specify a group of files or all the files in a directory.

BINdery
This parameter specifies that the three system files that make up the bindery database are to be restored. To restore the bindery, enter load dsmc restore bindery

Always restore the bindery first to ensure the trustee data (permissions) are restored correctly.

It is also a good idea to ensure that the bindery restore reconciled with the current NetWare system configuration, especially if the bindery is restored using a version that is back level.

To restore each volume on the server, enter load dsmc res sys:* -su=yes -rep=yes

Note:Any changes made after the backup version was made are lost.

DIRectory or NDS
Restores the NDS. To restore the entire directory, specify restore dir:* -sub=yes.

To restore one container, specify dir:.o=container_name In all examples, nds: instead of dir: may be entered.

It is also a good idea to ensure that the directory restore reconciled with the current NetWare system configuration, especially if the directory is restored using a version that is back level.

Note:Objects added after the backup version was made are not deleted.

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

Examples

The table below provides examples of some tasks that you can perform using the restore command.

Task Command
Restore a single file named budget load dsmc restore sys:u/projecta/budget
Restore files from the sys:projecta directory that end with the characters.bak. load dsmc res sys:u/projecta/*.bak
Restore all files from the sys:projecta directory that end with the characters .bak to the sys:projectndirectory.

Attention: If the destination is a directory, you must specify the delimiter (/) as the last character of the destination. If you omit the delimiter and your specified source is a directory or a filespec with a wildcard, you will receive an error.

load dsmc res sys:projecta/*.bak sys:projectn/
Restore all files from the sys:projecta directory that end with the characters.bak to another directory on a different NetWare server, serverb\sys:projectn. Projectn need not exist on serverb. load dsmc restore sys:projecta/*.bak serverb\sys:projectn/
Restore the NDS load dsmc res T9.dir
Restore the .o=ibm organization in the NDS load dsmc res adsm40.directory.o=ibm
Restore files in the sys:user/project directory. Use the pick option and the inactive option. load dsmc res servb\sys:user/projedct/* -pick -inactive

Restore Backupset

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

Syntax

>>-REStore BACKUPSET---+---------+---+- backupsetname-+--------->
                       '-options-'   '- filename------'
 
>-----+--------------------+---+---------------------+---------><
      +- --sourcefilespec--+   '-destinationfilespec-'
      +-BINdery------------+
      '-DIRectory or NDS---'
 

Parameters

options
You can use these command line options with the restore backupset command: location, description. 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, 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 or device from which to perform a restore operation. This parameter requires the location=file option.

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

bindery
Specifies that the three system files that make up the bindery database are to be restored.

directory or NDS
Restore the NDS.

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

Examples

The following table provides examples of some tasks you might perform using the restore backupset command.

Task Command
Restore a single file named budget.dev from the /dev/rmt0 device, to the original source path. load dsmc restore backupset sys:u/jones /budget.dev -loc=/dev/rmt0
Restore all files in the budget directory that contain a file extension of .txt, from the tape(s) on the /dev/rmt0 device, to the original source path. load dsmc restore backupset sys:u/budget/*.txt -loc=/dev/rmt0
Restore the sys: volume from the tape(s) on the /dev/rmt0 device, to the original source path, replacing existing files if there is a conflict. load dsmc restore backupset sys: -replace=y -loc=/dev/rmt0

Retrieve

The retrieve command obtains copies of archived files from the server. Specify either selected files or whole directories to retrieve archived files. Use options such as description that allow you to search on the descriptions assigned to the files when they were archived.

Place the retrieved files in the same directory from which they were archived, or in a different directory.

Note:If you are retrieving files to a different directory than the original directory, file names become the names you specify with the destinationfilespec option. Because only DOS names are valid within the TSM client, the file name becomes a DOS name.

Syntax

                            .-----------------------.
                            V                       |
>>-RETrieve---+---------+-----+-sourcefilespec---+--+----------->
              '-options-'     +-BINdery----------+
                              '-DIRectory or NDS-'
 
>-----+---------------------+----------------------------------><
      '-destinationfilespec-'
 

Parameters

options
You can use the following common options with the :

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

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

The following selections are also available for this command:

sourcefilespec
Specifies the path and file name that you want to retrieve. Use wildcards to specify a group of files or all the files in a directory.

BINdery
Specifies that the three system files that make up the bindery database are to be retrieved.

DIRectory or NDS
Retrieves the NDS.

destinationfilespec
Specifies the path and file name where you want to place retrieved files. The path and file name must follow DOS naming conventions. If you do not specify a destination, TSM restores the files to the original source path.

Examples

The table below provides examples of some tasks that you can perform using the retrieve command.

Task Command
Retrieve a single file named budget. load dsmc ret sys:projecta/budget
Retrieve all files from the sys:projecta directory that end with the characters .bak. load dsmc retrieve sys:projecta/*.bak
Retrieve all files from the sys:projecta directory that end with the characters .bak to the sys:projectn/ directory.
Note:If the destination is a directory, you must specify the delimiter (/) as the last character of the destination. If you omit the delimiter and your specified source is a directory or a filespec with a wildcard, you will receive an error.
load dsmc ret/projecta/*.bak servb\sys:projectn/
Retrieve all files in the sys:home directory.
Note:To retrieve files contained in a subdirectory, you must specify the subdirectory in another retrieve command.
retrieve sys:home/*
Retrieve files in the sys:project directory. Use the pick option. ret sys: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 polls the server for scheduled events based on the time you specified on 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.

Once you start the client scheduler, it continues to run and to start scheduled events. To end the scheduler, enter QQ. If the scheduler is active, it completes necessary transactions, then stops.

Syntax

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

Parameters

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

Examples

The table below provides an example of a task that you can perform using the schedule command.

Task Command
Start the client scheduler. load dsmc schedule -password=notell

When you run the schedule command, all messages regarding scheduled work are sent to a file called dsmsched.log or to an alternate file specified in the schedlogname option in your client options file. If you do not specify a directory path with the file name in the schedlogname option, TSM stores the file in the default installation directory.

Selective

The selective command backs up files that you specify selectively, for example, when you don't want to wait for the next incremental backup.

You can selectively back up single files and directories from the NetWare server. You can also selectively back up the NDS and the bindery. Use wildcard characters to back up groups of related files.

When you run a selective backup, TSM backs up all the files unless they are excluded from backup in your include-exclude list, or unless 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 having more than one copy of the same file on the server. If that 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 that, use the incremental command to back up only changed and new files.

If TSM refuses to back up a file, check to see if it is marked for execute only or if it is opened and locked by another user.

Syntax

                             .-----------------------.
                             V                       |
>>-Selective---+---------+-----+-filespec---------+--+---------><
               '-options-'     +-BINdery----------+
                               '-DIRectory or NDS-'
 

Parameters

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

You can use the following command-line options:

For more information about command-line options, see Chapter 9, Using Options With Commands.

filespec
Identifies 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.

BINdery
This parameter specifies that you want to selectively back up the bindery.

DIRectory or NDS
Specifies that you want to back up the NDS. To back up the entire directory, specify dir:.* -su=y. To back up one container in the directory, specify dir:.o=nds_object. An NDS object can contain container objects and leaf objects. In all examples, nds: instead of dir: may be entered.

Examples

The table below provides examples of some tasks that you can perform using the selective command.

Task Command
Back up the proja file in the sys:u/devel directory. load dsmc Selective sys:u/devel/proja
Back up all files in the sys:u/devel directory whose file names begin with proj. load dsmc selective sys:u/devel/proj*
Back up all files in the sys:u/devel directory whose file names begin with proj. Back up the single file budget in the sys:user directory. load dsmc selective sys:u/devel/proj* sys:user/budget
Back up the entire NDS. load dsmc s t9\dir:
Back up the bindery on serverc. load dsmc s servc\bindery:
Back up the tfr organization container of the NDS. load dsmc s t9\dir/.o=tfr

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 files. Define in the command whether you are giving access to archives or backups.

Note:You cannot give access to both types of files using a single command. Access is enabled only between like platforms. You can grant access only to another NetWare client node.

Syntax

>>-SET Access---+-archive-+---filespec---node---+---------+----->
                '-backup--'                     '-options-'
 
      .-*----.
>-----+------+-------------------------------------------------><
      '-user-'
 

Parameters

archive
Allows access to archived files.

backup
Allows access to backup versions of files.

filespec
Identifies the path and file name or directory name that was backed up or archived on the server to which you are giving access to another node or user.

Use wildcards to specify a group of files, all the files in a directory, all objects in a directory branch, or all objects in a volume. You can code a single asterisk (*) for the filespec to give access to all files owned by you and backed up on the server. When you enter the command set access backup * node user, 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 volume and directory. The filespec to which you give access must have at least one backup version or archive copy object (file or directory) on the server.

Give access to all objects below a certain level by using an asterisk, the directory delimiter, and another asterisk at the end of your filespec. For example, to give access to all objects below sys:ann, use filespec sys:ann/*/*.

To specify all files in all directories off the root directory, enter sys:*/* on the command line. Enter sys:* on one set access command and sys:*/* on another if you want another user to have complete access to your filespace. The first sys:* gives access to all subdirectories and all files off the root directory.

{filespacename}
Identifies 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
For information about common options you can use with the set access command, see Chapter 8, Setting Common Options.

user
Specifies the name of the user to whom you are giving access. Use a single asterisk or omit this parameter to give access to all users at the specified node.

Examples

The table below provides examples of some tasks that you can perform using the set access command.

Task Command
Give the user at node2 authority to restore the budget file from the directory of sys:user directory. load dsmc set access backup sys:budget node2
Give node3 authority to retrieve all files in the sys:devel\proja whose file names end with .sys. load dsmc set access archive sys:devel/proja/*.sys node3
Give node3 the authority to retrieve all files from the directory sys:u/devel/proja. load dsmc set a archive sys:u/devel/proja node3
Give node3 authority to restore all your backed up files. load dsmc set access b * node3
Give all nodes whose names end with bldgb the authority to restore all your backed up files. load dsmc set a b *bldgb

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-'   '-options-'
 

Parameters

oldpw
Identifies the current TSM password for your workstation.

newpw
Identifies the new TSM password for your workstation.

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

Examples

The table below provides an example of using the set password command.

Task Command
Change your current password from osecret to nsecret. load dsmc set password osecret nsecret


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