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. TSM provides a command line interface (CLI) that you can use as an alternative to the graphical user interface (GUI).
When you enter commands, use the following general rules:
Figure 28 contains commands, a description of what the command does, and
where to find the command in this chapter:
Command | Description | Page |
---|---|---|
archive | Archives files from a workstation to storage. | Archive |
backup image | Creates an image backup of one or more file spaces. | Backup Image |
cancel restore | Displays a list of restartable restore sessions and lets you 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 backupset | Displays information about backupsets. | Query Backupset |
query filespace | Displays a list of file spaces in storage. | Query Filespace |
query image | Displays information regarding backed up images. | Query Image |
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 current session. | Query Session |
restart restore | Displays a list of restartable restore sessions and lets you select one to restart. | Restart Restore |
restore | Restores backup versions from storage. | Restore |
restore backupset | Restores a backupset. | Restore Backupset |
restore image | Restores a backed up image. | Restore Image |
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 |
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 shell command prompt. 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, enter:
dsmc incremental
Press Enter. If a password is required, TSM prompts you each time you enter a command. Enter your password and press Enter.
You can also enter your password using the password option with a command your password is displayed. For example, if your password is secret, enter:
dsmc incremental -password=secret
When you use the passwordaccess option with the generate parameter you do not have to specify the password on the command, nor are you prompted for the password.
Use interactive mode when you want to enter several commands. Since TSM establishes connection to the server only once for interactive mode, a series of commands processes faster. For example, to process in interactive mode, enter:
dsmc
Press Enter. When the tsm> command prompt displays, enter a command name and press Enter.
Or, you can use loop (the default command for dsmc) by entering:
dsmc loop
If a password is required, TSM prompts you when you enter the first command. Either, enter your userid and password and press Enter. Or, use the password option with the loop command (however, your password displays). For example, if your password is secret, enter:
dsmc loop -password=secret or dsmc -passw=secret
To end an interactive session, enter quit at the prompt.
Each client command is covered in this chapter. A client command can include one or more of these components:
The first part of a command is a name identifier. 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 a permitted minimum abbreviation. Examples using the query schedule command follow:
query schedule q sc q sched query sc
There are two groups of options that you can use with commands; client options and client command options.
Client options: The group of options you can set in your client options file. To override any option in that file, enter the option with a command. For specific information about using client options, see Chapter 8, "Setting Common Options".
Client command options: The group of options that you can use with specific commands on the command line only. For specific information about using client command options, see Chapter 9, "Using Options With Commands".
Commands have: required parameters, optional parameters, or none. For example, query mgmtclass has no parameters; only options. Required parameters provide information to perform a task. The most common required parameter is a file specification. For example, if you want to archive a file named budget.fin from the /project directory, enter:
dsmc archive /project/budget.fin
Some commands have optional parameters. If you do not enter a value for an optional parameter, TSM uses the default value. For example, the restore command includes a required parameter, sourcefilespec, that identifies the path and file name in storage that you want to restore, and an optional parameter, destinationfilespec, that identifies 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 /project/budget.fin to /newproj/newbudg.fin, enter:
dsmc restore /project/budget.fin /newproj/newbudg.fin
Enter parameters in the order indicated in the command syntax diagram.
Use the following syntax rules when specifying file specification parameters, such as filespec, sourcefilespec, and destinationfilespec:
restore /fs/dir1/* mydir/
dsmc i /fsThe following example is not valid:
dsmc sel /fs
When entering a file specification, if the name ends with /, then it is considered a directory, otherwise it is considered a file.
The following example illustrates these two rules, even though mydir and yourdir are both directories, the command will fail because /* is implied after mydir, and yourdir is considered a file:
restore /home/mydir/ /away/yourdir
The following example illustrates the second rule, even though mydir and yourdir are both directories, the command will fail because mydir and yourdir are considered as files:
restore /home/mydir /away/yourdir
set access /fs/dir1/*/*Do not use wildcards for the directory path name, for example:
/home/j*asler/file1.c
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 editor option specifies whether TSM should turn on or off the command line interface editor and retrieve capability. If the editor and command retrieve function are not working on a specific terminal setting, we recommend you turn off the editor option. For additional information on the editor option See Editor.
Figure 29 lists other functions you can perform when you recall
commands.
Figure 29. Using Other Functions
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 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 the character at the cursor. | Delete |
Delete the 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 -- Execute the command. | Enter |
Quit the program. | F3 or Esc |
End the program. | CTRL-C |
In a command, wildcard characters can be used in the file name or extension only. You cannot use them to specify destination files or directories.
In a command, you cannot specify a directory whose name contains an asterisk (*) or a question mark (?). TSM will recognize those characters only as wildcard characters.
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 you can use include:
Figure 30 shows examples of each wildcard.
Figure 30. Using Wildcard Characters (File Name/Extension)
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 |
Note: Values containing wildcards must be enclosed in double quotes if entered in batch mode. For example:
dsmc selective "/home/me/*.c"
Options
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 you want to keep in their present 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---+--+-------------->< '- options--' '- "filespec"-'
Parameters
You can use these common options with the archive command: changingretries, subdir. See Chapter 8, Setting Common Options for information about these common options.
Examples
The table below provides examples of some tasks you might perform using the
archive command.
Task | Command |
---|---|
Archive a single file named budget in the /home/proj1 directory. |
archive /home/proj1/budget |
Archive all files in the /home/proj1 directory that contain a file extension of .txt. |
archive "/home/proj1/*.txt" |
Archive a single file named budget and all files in the /home/proj1 directory that contain a file extension of .txt. |
ar /home/proj1/budget "/home/proj1/*.txt" |
Archive all files in the /home directory. |
archive "/home/*" |
Options
The backup image command creates an image backup of one or more filespaces that you specify. Use the include.image option to include an image for backup, or to assign a specific management class to an image object.
Syntax
.-------------------. V | >>-Backup Image---+-----------+------+-------------+--+-------->< '- options--' +- filespec---+ '- "filespec"-'
Parameters
Examples
Task | Command |
---|---|
Back up the /home/test file space over which the logical volume is mounted, and specify that TSM perform an image incremental backup (an incremental based on the date the image). | dsmc backup image /home/test -mode=incremental |
Back up the /dev/lv01 raw logical volume. | dsmc backup image /dev/lv01 |
Options
The cancel restore command displays a list of your restartable restore sessions in the server database. You can only select one restartable restore session that you want to cancel.
To cancel restartable restore sessions use the cancel restore command. You can only cancel one restartable restore session at a time. Run the cancel restore command again to cancel additional restores. To restart restartable restore sessions use the restart restore command. Use the cancel restore command when:
Syntax
>>-CANcel Restore---+-----------+------------------------------>< '- options--'
Parameters
Examples
To cancel a restore, enter: cancel restore
Options
The delete access command deletes authorization rules for files or images stored on the server. When you delete an authorization rule, you revoke user access to the files or images specified by that rule.
Syntax
>>-Delete ACcess---+-----------------+------------------------->< | .-----------. | | V | | '---- options--+--'
Parameters
See Chapter 8, Setting Common Options for options you can use with this command.
Examples
The following table contains 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:
Index Type Node Owner Path _____ _______ ____________________________________ 1 Backup NODE1 USER1 home/dev/proja/list/ 2 Archive NODE3 LUIE home/fin/budg/depta/ 3 Backup NODE4 USER2 home/plan/exp/deptc/ 4 Archive NODE5 USER2S home/mfg/invn/parta/ Enter Index of rule(s) to delete, or quit to cancel: |
delete access |
To delete the authorization rules that let luie and user2s access your files or images, enter: |
2 4 or (2,4) Press Enter |
Options
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 a file is obsolete before you delete the file.
Syntax
>>-Delete ARchive---+-----------+---+- filespec---+------------>< '- options--' '- "filespec"-'
Parameters
You can use the subdir common option with the delete archive command. See Chapter 8, Setting Common Options for information about these common options.
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. |
delete ar /user/home/proj1/budget |
Delete all archived files in the /user/home/proj1 directory that end with the characters *.txt . | delete archive "/user/home/proj1/*.txt" |
Delete files archived from the /user/project directory using the pick option. | d ar "/user/project/*" -pick |
Options
TSM authorized user
The delete filespace command deletes file spaces from storage. A file space is a logical space on the server that contains files or images you backed up or archived. TSM assigns a separate file space on the server for each file system at your workstation from which you back up or archive files. The file space name is the same as the file system 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 or images. Verify the files or images are obsolete before you delete them.
Syntax
>>-Delete Filespace---+-----------+---------------------------->< '- options--'
Parameters
Examples
The table below provides an example of some tasks you might perform using
the delete filespace command.
Task | Command |
---|---|
Delete a file space. | delete filespace |
Delete a file space. Use the dateformat and timeformat options to reformat the dates and times. | delete filespace -dateformat=5 -timeformat=4 |
Options
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, enter q, press Enter.
Syntax
>>-Help--------------------------------------------------------><
Parameters
There are no parameters for this command.
Examples
To display a list of help selections, type Help; press Enter.
Options
The incremental command backs up all changed or new files in the default client domain or from the file systems, directories, or files specified in the command, that are not excluded from backup services. To incrementally back up selected files, supply the file specification in the command. To incrementally back up files in the default domain, do not provide a file specification in the command.
The following attributes in the management class assigned to the file affect whether the file is actually backed up:
Frequency: The number of days that must elapse between successive backups for the file. This is only used during a full incremental backup.
Mode: Mode permits the selection to back up only if the file changed since the last backup (Modified) or back up whether it changed or not (Absolute).
Serialization: Serialization permits a backup:
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.
There are two types of incremental backup that you can select: full incremental or incremental-by-date. The default is a full incremental backup. You must do a full incremental backup before you can perform an incremental-by-date backup. In a full incremental, the client queries the server so that it knows the exact state of your storage. During a full incremental, TSM uses this information to:
All of this processing is required to maintain backups according to the policies defined in the management classes.
In an "incremental-by-date", the client only asks the server for the date and time of the last incremental backup of the entire file system. If the file's last changed date and time is after that of the last incremental backup of the entire file system, the file is backed up. Otherwise it is not, even if the file is new to the workstation. In an "incremental-by-date", files are not expired or rebound on the server, and the frequency attribute of the management classes is ignored. Because they do not change the last changed date and time, changes to access control lists (ACL) are not backed up during an "incremental-by-date". You can use the query filespace command to determine the date and time of the last incremental backup of the complete file system.
To do an "incremental-by-date" backup, specify -incrbydate as an option. Only use the "incremental-by-date" option if you must meet a limited backup time window, and a full incremental takes longer than the allotted time. Periodically perform full incremental backups to bring the server in line with your workstation's status. For example if you have only a limited time during the week to perform backups, but extra time on the weekend you can use incremental-by-date backups on the weekdays and then full incremental backups on the weekends.
Syntax
.-------------------. V | >>-Incremental---+----------+------+-------------+--+---------->< '- options-' +- filespec---+ '- "filespec"-'
Parameters
You can use these common options with the incremental command: changingretries, domain, memoryefficientbackup, subdir, tapeprompt. See Chapter 8, Setting Common Options for information about common options.
If a file system 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 may be backed up again if a subsequent backup is done using the incrbydate option.
If a file system is supplied for the filespec, specify the file system without a trailing slash.
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. | Incremental |
Run an incremental backup for the /home, /usr, and /proj file systems. | Incremental /home /usr /proj |
Run an incremental backup for the /proj/test directory. | Incremental /proj/test/ |
Run an incremental-by-date backup for the /home file system. | Incremental -incrbydate /home |
Run an incremental backup of all files in the /fs/dir1 directory that begin with the string abc. | Incremental -subdir=yes "/fs/dir1/abc*" |
Run an incremental backup of the abc file in the /fs/dir1 directory. | Incremental -subdir=yes /fs/dir1/abc |
Run an incremental backup of the directory object /fs/dir1, but not any of the files in the /fs/dir1 directory. | Incremental -subdir=yes /fs/dir1 |
Run an incremental backup of the directory object /fs/dir1 and all of the files in the /fs/dir1 directory. | Incremental -subdir=yes /fs/dir1/ |
Options
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, fromowner, fromtime, ifnewer, inactive, incrbydate, latest, noprompt, pick, pitdate, pittime, preservepath, todate, totime, and volinformation.
You can enter all commands in interactive mode except the schedule and loop commands.
The following commands can appear on any dsmc command line. However, they cannot appear on a command you enter when you are in interactive mode: servername, nodename, tcpserveraddress, tcpport, and commmethod.
Syntax
>>-LOOP---+-----------+---------------------------------------->< '- options--'
Parameters
Examples
To start an interactive command-line session, enter dsmc.
Options
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
Examples
The table below provides an example of how to use the macro
command.
Task | Command |
---|---|
Selectively back up files in the following directories: /devel/project/proja, /devel/project/projb, and /devel/project/projc |
MACRO backabc.mac Where backabc.mac contains the following statements: Selective /devel/project/proja/ Selective /devel/project/projb/ Selective /devel/project/projc/ |
Options
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
Examples
To display a list of users who have access to your files, enter query access.
Options
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--' '- "filespec"-'
Parameters
You can use the subdir common option with the query archive command. (See Chapter 8, Setting Common Options.)
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 current directory. | q archive "*" |
Display a list of all your archived files in the /devel directory and all of its subdirectories. | query archive "/devel/*" -subdir=yes |
Display a list of archived files in the current directory. Use the dateformat and timeformat options to reformat the dates and times. | q ar -date=5 -time=1 "*" |
Display the list of files that were archived from the /home/proj directory whose file names begin with the letters proj. Use the dateformat and timeformat options. | q ar -date=1 -time=4 "/home/proj/proj*" |
Options
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
>>-Query Backup---+-----------+---+- filespec---+-------------->< '- options--' '- "filespec"-'
Parameters
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.
Examples
The table below provides examples of some tasks you might perform using the
query backup command.
Task | Command |
---|---|
Display a list of all active and inactive backup versions of your files in the current directory. | query backup -inactive "*" |
Display a list of active and inactive backup versions of your files in the /home filesystem. Use the dateformat and timeformat options to reformat the dates and times. | q b-date=5 -time=1 -ina -su=yes /home/ |
Display the list of files that were backed up from the /home/proj directory with the names that begin with proj. Use the dateformat and timeformat options. | q b-date=1 -time=4 "/home/proj/proj*" |
Options
The query backupset command queries a backup set from the server, a tape device, or a local file. This command displays the attribute, or attributes, directories and files associated with the backup set.
Syntax
>>-Query BACKUPSET---+---------+---+- backupsetname-+---------->< '-options-' '- filename------'
Parameters
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.
Examples
Task | Command |
---|---|
Query the meta data of a single file named budget.dev from the /dev/rmt0 device. |
query backupset "/home/jones/budget.dev" -loc=/dev/rmt0 |
Query all files in the budget directory that contain a file extension of .txt, from the /dev/rmt0 device. |
query backupset "/home/budget/*.txt" -loc=/dev/rmt0 |
Query the meta data and files on the file system with the description of budget from the /dev/rmt0 device. |
query backupset -des=budget -loc=/dev/rmt0 |
Options
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 file system at your workstation from which you back up or archive files. The file space name is the same as the file system name.
Syntax
>>-Query Filespace---+-----------+----------------------------->< '- options--'
Parameters
See Chapter 8, Setting Common Options for information about common options.
Examples
The table below provides examples of some tasks you might perform using the
query filespace command.
Task | Commands |
---|---|
Display your file spaces. | query filespace |
Display your file spaces. Use the dateformat and timeformat options to reformat the dates and times. | query filespace -dateformat=5 -timeformat=4 |
Options
The query image command displays information about images backed up by a client. The options are used to determine the content and detail of the information.
Syntax
>>-Query Image---+----------+---+- logicalvolumename-+--------->< '- options-' '- filespacename-----'
Parameters
Omitting logicalvolumename and filespacename will cause all images to display.
Examples
Task | Command |
---|---|
Display all backed up images. |
q image |
Display all backed up images owned by kutras at node avalon. |
query image fromnode=avalon fromowner=kutras |
Display active and inactive version of the /usr image. |
q i /usr -inactive |
Options
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. If you do not assign a management class to a file, TSM uses the default management class.
Syntax
>>-Query Mgmtclass---+-----------+----------------------------->< '- options--'
Parameters
See Chapter 8, Setting Common Options for information about common options.
Examples
To display available management classes, enter Query Mgmtclass.
Options
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---+-----------+------------------------------->< '- options--'
Parameters
Examples
To display your restartable restore session in the server database, enter: query restore.
Options
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
Examples
To display your scheduled events, enter: Query SChedule.
Options
The query session command displays the information about your session. This information includes the current node name, when the session was established, server information, and server connection information. A sample query session display follows:
Tivoli Storage Manager Command Line Backup Client Interface - Version 3, Release 7, Level 0.0 (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, Level 0.0 Server date/time: 09/04/1999 15:09:52 Last access: 09/04/1999 15:09:40 Server Connection Information Server Name.............: FIJI_0918GA Server Type.............: AIX-RS/6000 Server Version..........: Ver. 3, Rel. 1, Lev. 0.0 Last Access Date........: 09/04/1999 15:09:40 Delete Backup Files.....: Yes Delete Archive Files....: Yes Node Name...............: EPSILON3 User Name...............: thompson
Syntax
>>-Query SEssion---+-----------+------------------------------->< '- options--'
Parameters
Examples
To display your session information, enter: Query SEssion.
Options
The restart restore command displays a list of your restartable restore sessions in the server database. You can only select one restartable restore session to restart, or you can cancel.
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 restart restartable restore sessions use the restart restore command. To cancel a restartable restore session 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
Examples
To restart a restore, enter: restart restore
Options
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.
When an entire directory or directory tree is restored, and the inactive, latest, pick, todate, and fromdate options are not specified on the restore command, TSM tracks which objects have been restored. If the restore process is interrupted for any reason, you can restart the restore at the point of interruption by entering the restart restore command. It is possible to create more than one restartable restore session. Restores are only restartable if the filespec is fully wildcarded. For example, for a restore which is restartable, enter:
dsmc rest /home/* -sub=yes
For a restore which is not restartable, enter:
dsmc rest /home/file?.c -sub=yes
Use the query restore command to display a list of your restartable restore sessions in the server database. The existence of a restartable restore inhibits further backups of that file system until the restartable restore is completed using the restart restore command or the restartable restore is dropped using the cancel restore command.
Syntax
>>-REStore---+--------+---+-----------+---+- sourcefilespec---+-> '- FILE--' '- options--' '- "sourcefilespec"-' >-----+----------------------+--------------------------------->< '- destinationfilespec-'
Parameters
You can use these common options with the restore command: replace, restoremigstate, subdir. See Chapter 8, Setting Common Options for information about common options.
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. |
restore /home/devel/projecta/budget |
Restore a single file named budget which resides in the current directory. |
restore file budget |
Restore all files from the /home/devel/projecta directory that end with the characters .c. |
restore "/home/devel/projecta/*.c" |
Restore all files from the /home/devel/projecta directory that end with the characters .c to the /home/newdevel/projectn directory. If the projectn directory does not exist, it is created. | restore "/home/devel/projecta/*.c" /home/newdevel/projectn/ |
Restore all files in the /user/project directory. Use the pick and inactive options. | restore "/user/project/*" -pick -inactive |
Restore all files in the /home/mydir directory to their state as of 1:00 PM on August 17, 1998. | res -pitd=8/17/1998 -pitt=13:00:00 /home/mydir/ |
Restore all objects in the /home/myid/ directory.
Since this restore is fully wildcarded, if the restore process is interrupted, a restartable restore session is created. Use the restart restore command to restart a restartable restore session. Use the cancel restore command to cancel a restartable restore session. | res /home/myid/* |
Options
The restore backupset command partially or fully restores a backupset from the server, a local file or a tape device.
Syntax
>>-REStore BACKUPSET---+---------+---+- backupsetname-+---------> '-options-' '- filename------' >-----+- sourcefilespec---+---+----------------------+--------->< '- "sourcefilespec"-' '- destinationfilespec-'
Parameters
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.
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. | restore backupset "/home/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. | restore backupset "/home/budget/*.txt" -loc=/dev/rmt0 |
Restore the /home file system | restore backupset "/home" -replace=yes -loc=/dev/rmt0 |
Restore the backup set contained on the tape device /dev/rmt0 on the local client machine. | restore backupset /dev/rmt0 -loc=tape |
Options
The restore image command restores a single file system image that was backed up using the backup image command. This command can restore an active base image, or a point-in-time base image, with associated incremental updates.
Syntax
>>-REStore Image---+----------+---+- sourcefilespec---+---------> '- options-' '- "sourcefilespec"-' >-----+----------------------+--------------------------------->< '- destinationfilespec-'
Parameters
For detailed information about these options, see Chapter 9, "Using Options With Commands".
The restore image command does not define or mount the destination file space. The destination file space must exist, it must be mounted, and it must be large enough to hold the source. If file systems are mounted on volume images, and you restore them to a different location, be aware of the following points:
Examples
Task | Command |
---|---|
Restore the /home/test directory over which the logical volume is mounted, to its original location. |
dsmc rest image /home/test |
Restore the /home/proj directory to its original location and apply the changes from the last incremental backup of the original image recorded at the server. The changes include deletion of files. |
dsmc restore image /home/proj -incremental -deletefiles |
Options
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 to search for 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.
Syntax
>>-RETrieve---+-----------+---+- sourcefilespec---+-------------> '- options--' '- "sourcefilespec"-' >-----+----------------------+--------------------------------->< '- destinationfilespec-'
Parameters
You can use these common options with the retrieve command: replace, restoremigstate, subdir, tapeprompt. See Chapter 8, Setting Common Options for information about common options.
Examples
Use the retrieve command to perform the following tasks:
Task | Command |
---|---|
Retrieve a single file named budget. | retrieve /home/devel/projecta/budget |
Retrieve all files with an extension of .c from the /home/devel/projecta directory. | retrieve "/home/devel/projecta/*.c" |
Retrieve all files in the /home directory. | retrieve "/home/" |
Retrieve all files in the /home/devel/projecta directory that end with the characters .c to the /home/newdevel/projectn directory. | retrieve "/home/devel/projecta/*.c" /home/newdevel/projectn/ |
Retrieve all files with a file extension of .c from the /home/devel/projecta directory to the /home/newdevel/projectn directory. If the /projectn directory does not exist, it will be created. | retrieve "/home/devel/projecta/*.c" /home/newdevel/projectn/ |
Retrieve files in the /user/project directory. Use the pick option. | ret "/user/project/*" -pick |
Retrieve all files archived from the /proj directory with the description "1999 survey results". | retrieve "/proj/*" -desc="1999 survey results" |
Options
TSM authorized user | 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 until you press Ctrl+C, stop the scheduler process with the UNIX kill command, start the machine again, or turn off the machine to end it. Note: You cannot enter this command in interactive mode. |
Syntax
>>-SCHedule---+-----------+------------------------------------>< '- options--'
Parameters
Examples
The table below provides an example of a task that you can perform using
the schedule command.
Task | Command |
---|---|
For AIX: Start the scheduler at system bootup time by entering this command in the /etc/inittab file. Ensure the passwordaccess option is set to generate. | tsm::once:/usr/lpp/adsm/bin/dsmc sched > /dev/null 2>&1 #TSM Scheduler |
For UNIX: Start the scheduler at system bootup time by entering this command in the /etc/inittab file. Ensure the passwordaccess option is set to generate. | tsm::once:/usr/adsm/dsmc sched > /dev/null 2>&1 #TSM Scheduler |
Interactively start the scheduler and keep it running in the background. | nohup dsmc sched 2> /dev/null & |
Options
The selective command selectively backs up files of your selection. If any of 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 that fit the filespec 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.
You can selectively back up single files or directories. You can also use wildcards to back up groups of related files.
Syntax
.------------------. V | >>-Selective---+-----------+-----+- filespec---+--+------------>< '- options--' '- "filespec"-'
Parameters
You can use these common options with the selective command: changingretries, subdir. See Chapter 8, Setting Common Options for information about these common options.
Examples
The table below provides examples of some tasks you can perform using the
selective command.
Task | Command |
---|---|
Back up the proja file in the /home/devel directory. | selective /home/devel/proja |
Back up all files in the /home/devel directory whose file names begin with proj. | selective "/home/devel/proj*" |
Back up the /home file system. | selective /home/ |
Back up all files in the /home/devel directory whose file names begin with proj. Back up the single file budget in the /user/home directory. | selective "/home/devel/proj*" /user/home/budget |
Options
The set access command gives users at other nodes access to your backup versions, archived copies, or backup images. You can give another user access to a specific file or image, multiple files or images, or all files or images in a directory. When you give access to another user, that user can restore or retrieve your files or images. Specify in the command whether you are giving access to archives or backups.
Note: You cannot give access to both types of files or images using a single command.
Syntax
>>-SET Access---+- Archive-+---+- filespec----------------+-----> '- Backup--' +- {filespacename}filespec-+ '-image-fs-----------------' >----- node---+-------+---+-----------------+------------------>< '- user-' | .-----------. | | V | | '---- options--+--'
Parameters
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 filespec to which you gave 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 asterisk, directory delimiter, and asterisk at the end of your filespec. For example, to give access to all objects below home/test, use filespec home/test/*/*.
To specify all files or images in a named directory, enter home/mine/proj1/* on the command line. To specify all files or images in all directories off of the root directory, enter /*/* on the command line. Enter /* on one set access command and /*/* on another if you want another user to have complete access to your filespace. The first /* gives access to all subdirectories and all files or images off of the root directory.
Examples
The following table contains examples of tasks you might run using the
set access command:
Task | Command |
---|---|
Give the user at node_3 authority to restore the budget file from the /home/user directory. | set access backup /home/user/budget node_3 |
Give any user at node_3 the authority to retrieve all files from the /home/devel/proja directory. | set ac archive /home/devel/proja/node_3. |
set ac archive "/home/devel/proja/*.c" node_3 user_c |
|
Give user_c at node_3 authority to retrieve all files from the /home/devel/proja directory whose file names end with .c. | set access ret "/home/devel/proja/*.c" node_3 user_c |
Give all users whose node names end with bldgb the authority to restore all backup versions from directories with the file name space of project. | set ac b {project} "*" "*bldgb" |
Give all users at all nodes access to all objects in the /acct/paid directory and any subdirectories below it. | set ac b "/acct/paid/*/*" "*" |
Give user serena at node_5 authority to restore all images of the filespace mounted on directory /home/devel/proja. | set acc backup "home/devel/proja/*/*" node_5 serena |
Options
TSM authorized user
The set password command changes the password for your workstation. If you do not specify the old and new password parameters, you are prompted once for your old password and twice for your new password.
Note: If you are using the Web client and you are logged on to an Enterprise Management server, then you are changing the password for the administrative user id.
A password can be up to 64 characters and is not case sensitive.
Valid values 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
Examples
The table below provides an example of using the set password
command.
Task | Command |
---|---|
TSM prompts you to change your password. | set password |