Using the TSM Client Command Line Interface for Backup & Restore

Transcription

1 Using the TSM Client Command Line Interface for Backup & Restore help.it.ox.ac.uk /hfs/help/dsmc 1. Introduction This section will first provide an introduction to the TSM Command Line Interface (CLI) and then describe how to manually back up and restore files on the local machine. The screen shots and descriptions that follow may refer to older TSM clients, but with the exception of the file specifications the syntax is generic to all platforms. 2. Starting the TSM Command Line client 2.1. Windows Run from. The TSM command line interface will open in a window on the Windows desktop. This window will be small but you can change its size, colour, or font by right clicking on the icon in the top left corner and selecting. You should see a prompt of the form: 2.2. Mac Open from and type sudo dsmc. You will be prompted for your Mac password then should see a prompt of the form: IBM Tivoli Storage Manager Command Line Backup-Archive Client Interface Client Version 6, Release 4, Level 1.5 Client date/time: :57:05 (c) Copyright by IBM Corporation and other(s) 1990, All Rights Reserved. Node Name: ABCD1234-LAPTOP-ITSERV Session established with server OX_HFS_B1: AIX Server Version 6, Release 3, Level Server date/time: :57:05 Last access: :34:35 tsm> 2.3. Unix/Linux Run dsmc as root from the shell prompt (e.g., in Ubuntu, run sudo dsmc). You should see a prompt of the form: 1/11

2 IBM Tivoli Storage Manager Command Line Backup-Archive Client Interface Client Version 6, Release 4, Level 1.7 Client date/time: :01:20 (c) Copyright by IBM Corporation and other(s) 1990, All Rights Reserved. Node Name: TEST-UBUNTU-OUCS Session established with server OX_HFS_B1: AIX Server Version 6, Release 3, Level Server date/time: :01:15 Last access: :01:04 tsm> 2.4. Netware Type load dsmc at the console. 3. Accessing Help Online help for TSM commands, options and error messages is available by typing help at the tsm> prompt. The result will be similar to below: 1.0 New for IBM Tivoli Storage Manager Version Using commands 2.1 Start and end a client command session Process commands in batch mode Process commands in interactive mode 2.2 Enter client command names, options, and parameters Command name Options Parameters File specification syntax 2.3 Wildcard characters 2.4 Client commands reference 2.5 Archive 2.6 Archive FastBack Enter 'q' to exit help, 't' to display the table of contents, press enter or 'd' to scroll down, 'u' to scroll up or enter a help topic section number, message number, option name, command name, or command and subcommand: Note that commands and options may be abbreviated to a short form as indicated by capitalisation of words in the syntax entry q for a command. Thus, for example, query filespace can be abbreviated to fi. Options and commands can also be load dsmc q included on the original command line so, using the above example, on a Netware machine you can run fi to just run a query of the current partitions backed up. Obviously, more complex queries and commands can be similarly run in the same manner. 4. Querying the server The following query commands illustrate typical command syntax and output Querying your scheduled backup slot q query To query your scheduled backup slot enter sched (which is short for schedule that below: ). The output should look similar to 2/11

3 tsm> q sched Schedule Name: WEEKLY_ITSERV Description: ITSERV weekly incremental backup Schedule Style: Classic Action: Incremental Options: Objects: Priority: 5 Next Execution: 149 Hours and 35 Minutes Duration: 15 Minutes Period: 1 Week Day of Week: Wednesday Month: Day of Month: Week of Month: Expire: Never 4.2. Querying what files are included/excluded for backup At the tsm> prompt enter q inclexcl to list output similar to the following: tsm> q inclexcl *** FILE INCLUDE/EXCLUDE *** Mode Function Pattern (match from top down) Source File Excl Filespace /var/run Excl Filespace /tmp Excl Directory /.../.opera/.../cache4 Excl Directory /.../.mozilla/.../cache Excl Directory /.../.netscape/.../cache Excl Directory /var/tmp Excl All /.../dsmsched.log Excl All /.../core Excl All /.../a.out No DFS include/exclude statements defined. Note that the include/exclude directives are listed at the partition level first, then the directory/folder level and finally at the file level. The order they are displayed above is the order in which these directives are applied by TSM. You will note that the order of the directives at any one level is the opposite of the order in which they appear in the options file. That is, TSM reads the directives listed in options file from the bottom up Querying what partitions have been backed up At the tsm> prompt enter Windows: q fi to list which partitions have been backed up: # Last Incr Date Type File Space Name :46:59 NTFS \\tentacles.oucs\c$ 3/11

4 Mac: tsm> q fi # Last Incr Date Type File Space Name :13:13 HFS / :26:09 HFS /Volumes/Disk 2 Linux: tsm> q fi # Last Incr Date Type File Space Name :13:13 EXT4 / :26:09 EXT3 /home Solaris: tsm> q fi # Last Incr Date Type File Space Name :13:13 UFS / :26:09 UFS /export/home Netware: # Last Incr Date Type File Space Name :23:46 NTW:LONG NSMS1\SYS: :22:42 NDS NSMS1\NDS: :25:33 NTW:LONG NSMS1\USR: :25:11 NTW:LONG NSMS1\APPS: 4.4. Querying what files have been backed up The syntax for querying what files you have backed up involves giving a file specification which is necessarily OS specific. Also, if an incorrect file specification is given it may appear that you have no backups. Consequently, several worked examples are displayed below for Windows, Mac, Linux/Unix and Netware environments. If you give just a path to a directory/folder you will only get the folder returned as the output: Windows: tsm> q ba c:\downloads 0 B :57:54 STANDARD A \\tentacles.oucs\c$\downloads Mac: 4/11

5 tsm> q ba /Users Size Backup Date Mgmt Class A/I File B :52:09 STANDARD A /Users Linux: tsm> q ba /home/ians/projects 512 B :52:09 STANDARD A /home/ians/projects Netware: tsm> q ba USR:/ians 0 B :25:32 STANDARD A USR:/ians Note that the Windows client lists the directory in UNC format. This format can also be used for the file specification in the query. If you just add a trailing * (star) as a wildcard in the above query, TSM will only return those files and directories backed up immediately below the directory path given in the query tsm>q ba /home/ians/projects/* :57:09 STANDARD A /home/ians/projects/hfs0106 1, :46:53 STANDARD A /home/ians/projects/hsm41perf :57:09 STANDARD A /home/ians/projects/hsm41test :22:56 STANDARD A /home/ians/projects/hsm42upg If you want to query all the current files and directories backed up under a directory and all its subdirectories you need to add the -subdir=yes option as below: tsm> q ba /home/ians/projects/* -subdir=yes :57:09 STANDARD A /home/ians/projects/hfs0106 1, :46:53 STANDARD A /home/ians/projects/hsm41perf :57:09 STANDARD A /home/ians/projects/hsm41test :22:56 STANDARD A /home/ians/projects/hsm42upg 1, :57:09 STANDARD A /home/ians/projects/hfs0106/test 1, :57:09 STANDARD A /home/ians/projects/hfs0106/test/test2 12, :01:29 STANDARD A /home/ians/projects/hsm41perf/tables 50, :35:26 STANDARD A /home/ians/projects/hsm42upg/pmr , :28:15 STANDARD A /home/ians/projects/hsm42upg/pmr , :22:56 STANDARD A /home/ians/projects/hsm42upg/md5check Note that file specifications with spaces in them will need to be quoted. Thus to query all the files backed up under C:\My Documents and any sub-directories below it, the following input would be required: tsm> q ba "C:\My Documents\*" -subdir=yes 5/11

6 By default only the current versions of files are listed. In order to query both current active and previous inactive versions of files, add the -inactive option to the query: tsm> q ba /home/ians/projects/* -subdir=yes -inactive :57:09 STANDARD A /home/ians/projects/hfs0106 1, :46:53 STANDARD A /home/ians/projects/hsm41perf :57:09 STANDARD A /home/ians/projects/hsm41test :22:56 STANDARD A /home/ians/projects/hsm42upg 1, :57:09 STANDARD A /home/ians/projects/hfs0106/test 1, :57:09 STANDARD A /home/ians/projects/hfs0106/test/test2 12, :01:29 STANDARD A /home/ians/projects/hsm41perf/tables 8, :31:18 STANDARD I /home/ians/projects/hsm41perf/tables 50, :35:26 STANDARD A /home/ians/projects/hsm42upg/pmr , :28:15 STANDARD A /home/ians/projects/hsm42upg/pmr , :22:56 STANDARD A /home/ians/projects/hsm42upg/md5check 11, :10:08 STANDARD I /home/ians/projects/hsm42upg/md5check Note how the previous versions of files are marked by an I (for Inactive) in the A/I column. Unix and Linux users should be aware of potential confusion of how TSM stores files in nested file spaces. This can arise in the following situation: A user backs-up a file myconf.txt on the /usr partition in the /usr/local/etc directory. Subsequently, a new disk partition is mounted at /usr/local, or it is defined as a virtualmountpoint. Running the command: tsm> q ba /usr/local/etc/* will not list the myconf.txt file. This is because TSM always looks for a file in the filespace (partition) with the longest name that matches the file specification you include in the command. In the above example, the file was not backed up under the /usr/local filespace but under the /usr filespace. To tell TSM to look for a file in latter filespace you must specify the filespace explicitly using braces, as below: tsm> q ba {/usr}/local/etc/* 5. Backing up your data 5.1. Backing up local disks The basic syntax for backing up local disk volumes is dsmc backup-type disk volume(s), where backup-type is one of incremental or selective. We recommend incremental backups only; selective backups cause data to be sent even if it disk already exists on the HFS. By default, if the volume is omitted, TSM will backup those volumes specified by the Domain option in the dsm.opt options file. If Domain is set to All-Local, then to backup all local volumes enter: tsm> incr where incr is an abbreviation for incremental. To incrementally back up specific volumes enter: tsm> incr C: D: F: ** Windows tsm> incr / ** Mac tsm> incr / /usr /usr/local /home ** Unix/Linux tsm> incr NDS: USR: SYS: APPS: ** Netware To run an incremental by date backup of the above, add the -incrbydate option, as in: 6/11

7 tsm> incr C: D: F: -incrbydate To back up entire disk volumes irrespective of whether files have changed since the last backup, use the selective command with a wildcard and -subdir=yes as below: tsm> sel C:\* D:\* F:\* -su=yes ** Windows tsm> sel /* -su=yes ** Mac tsm> sel /* /usr/* /home/* -su=yes ** Unix/Linux tsm> sel USR:* SYS:* APPS:* -su=yes ** Netware 5.2. Backing up selected files The basic syntax for backing up selected files is similar to that for backing up disk partitions. Be aware, however, that you cannot use wildcards in directory/folder names: tsm> incr /home/ians/projects/hsm*/* -su=yes ANS1071E Invalid domain name entered: '/home/ians/projects/hsm*/*' tsm> sel /home/ians/projects/hsm*/* -su=yes Selective Backup function invoked. ANS1081E Invalid search file specification '/home/ians/projects/hsm*/*' entered You can, however, enter several file specifications on the command line, as below: ** Windows ** tsm> incr "C:\My Documents\Word docs\*" "C:\My Documents\html docs\*" -su=yes ** Mac ** tsm> incr /Users/ians/* /Users/test/* -su=yes ** Linux/Unix ** tsm> incr /home/ians/projects/hsm41test/* /home/ians/projects/hsm41perf/* - su=yes ** Netware ** tsm> incr USR:ians/projects/tsm/* "USR:ians/projects/new html/*" -su=yes 6. Restoring your data dsmc restore source-file destinationfile. If the destination-file The basic syntax for restoring your data is is omitted then TSM will restore the file(s) to their original location. Be aware that, as with backup, you cannot use wildcards in directory/folder names. By default, TSM will restore the most current active version of a file Restoring selected files 7/11

8 ** Windows ** tsm> rest "C:\My Documents\Word docs\mydoc.doc" "C:\My Documents\restore\" tsm> rest "C:\My Documents\Word docs\mydoc.doc" "C:\My Documents\restore\myolddoc.doc" ** Mac ** tsm> rest /Users/ians/myfile.txt /Users/ians/restore/ tsm> rest /Users/ians/myfile.txt /Users/ians/restore/myoldfile.txt ** Linux/Unix ** tsm> rest /home/ians/myfile.txt /home/ians/restore/ tsm> rest /home/ians/myfile.txt /home/ians/restore/myoldfile.txt ** Netware ** tsm> rest USR:ians/myfile.txt* "USR:ians/restore/" tsm> rest USR:ians/myfile.txt* "USR:ians/restore/myoldfile.txt" Note from the first example of each restore above that in order to specify a directory as a destination, you need a trailing / (slash) at the end of the destination-filespec. Otherwise TSM may overwrite a file of the same name. The second example demonstrates a filename in the destination-filespec. Restores of single files cannot be restarted if interrupted. In this case you will need to restore the file afresh Restoring multiple files and directories ** Windows ** tsm> rest "C:\My Documents\Word docs\*" "C:\My Documents\restore\" -su=yes ** Mac ** tsm> rest /Users/ians/projects/hsm41test/* /Users/ians/projects/restore/ -su=yes ** Linux/Unix ** tsm> rest /home/ians/projects/hsm41test/* /home/ians/projects/restore/ -su=yes ** Netware ** tsm> rest USR:ians/projects/tsm/* "USR:ians/projects/restore/" -su=yes Note that in order to restore a full directory and the contents of all its sub-directories you need the -su=yes option. It is always good practice to terminate the destination-filespec with a trailing / (slash) if the element in the destination-filespec is a directory. As this restore is wild-carded, it can be restarted if interrupted due to user input (Ctrl-C), server error or communications error. q Restartable restores can be queried via rest and will restart at the point of interruption Restoring entire partitions Essentially, the syntax is the same as in 'Restoring multiple files and directories' above. However, the obvious caveats are to ensure enough space in the destination partition and to allow enough time. 8/11

9 ** Windows ** tsm> rest C:\* D:\restore\" -su=yes ** Mac ** tsm> rest /Users/* /tmp/restore/ - su=yes ** Linux/Unix ** tsm> rest /home/* /tmp/restore/ -su=yes ** Netware ** tsm> rest USR:* USR:restore/ -su=yes As with 'Restoring multiple files and directories' above, this restore is wild-carded and thus can be restarted if interrupted Restoring old and/or deleted files As with the GUI, TSM does not, by default, list or restore old and deleted inactive versions of files and directories. If you need to -inactive - restore such a file, you need the pick options. The -pick option, while not strictly necessary, causes TSM to display a list of files from which to pick. Issuing a restore as below will display the following pick window: 9/11

10 tsm> rest /home/ians/projects/* /tmp/restore/ -su=yes -inactive -pick TSM Scrollable PICK Window - Restore # Backup Date/Time File Size A/I File :57: B A /home/ians/projects/hsm41test/inclexcl.test :57: KB A /home/ians/projects/hsm41test/inittab.orig :57: KB A /home/ians/projects/hsm41test/inittab.test :57: KB A /home/ians/projects/hsm41test/md5.out :35: B A /home/ians/projects/hsm42125upg/pmr :02: B I /home/ians/projects/hsm42125upg/pmr :28: B A /home/ians/projects/hsm42125upg/pmr :17: B I /home/ians/projects/hsm42125upg/pmr :22: KB A /home/ians/projects/hsm42125upg/dsm.opt :22: KB A /home/ians/projects/hsm42125upg/dsm.sys :22: KB A /home/ians/projects/hsm42125upg/dsmmigfstab :22: KB A /home/ians/projects/hsm42125upg/filesystems :22: KB A /home/ians/projects/hsm42125upg/inclexcl :22: B A /home/ians/projects/hsm42125upg/inclexcl.dce :22: B A /home/ians/projects/hsm42125upg/inclexcl.ox_sys :22: B A /home/ians/projects/hsm42125upg/inclexcl.test :22: B A /home/ians/projects/hsm42125upg/inetd.conf :22: KB A /home/ians/projects/hsm42125upg/inittab :22: KB A /home/ians/projects/hsm42125upg/md5check :22: KB A /home/ians/projects/hsm42125upg/mkreport out :22: KB A /home/ians/projects/hsm42125upg/ssamap out :02: MB A /home/ians/projects/hsm42125upg/pmr70023/70023.tar :33: MB I /home/ians/projects/hsm42125upg/pmr70023/70023.tar <U>=Up <D>=Down <T>=Top <B>=Bottom <R#>=Right <L#>=Left <G#>=Goto Line # <#>=Toggle Entry <+>=Select All <->=Deselect All <#:#+>=Select A Range <#:#->=Deselect A Range <O>=Ok <C>=Cancel pick> You are now in the pick interface and can select individual files to restore via the number to the left, scroll up or down via U and D as described at the bottom of each listing of files. Remember to issue the destination-filespec with the original restore command if you want to prevent overwriting current versions of files with older versions. 7. Restoring your data to another machine In certain circumstances, it may be necessary to restore some, or all, of your data onto a machine other than the original from which it was backed up. Ideally the machine platform should be identical to that of the original machine. Where this is not possible or practical please note that restores are only possible for partition types that the operating system supports. Thus a restore of an NTFS partition to a Windows 9x machine with just FAT support may succeed but the file permissions will be lost. Please do not attempt cross-platform restores, e.g. by trying to restore files onto a Windows machine that have previously been backed up with a non-windows one: using TSM for Windows to try to access backups sent by other OS platforms can cause those backups to become inaccessible from the host system. To restore your data to another machine you will need the TSM software installed on the target machine. Entries in dsm.sys and/or dsm.opt will need to be edited if the node that you are restoring from does not reside on the same HFS server as the one that you are restoring to. Please see our help page section on TSM configuration files for their locations for your operating system. To check which HFS server is required, please go to View TSM Client Details, where the listed HFS Server will be the one needed for the Servername field in both dsm.sys (Mac/Unix/Linux only) and dsm.opt (all operating systems). If you do need to edit these files, it is recommended that you first of all make copies so that you can get your old settings back later. The 10/11

11 other two values which need to be changed are TCPServer and TCPPort, in dsm.sys (Mac/Unix/Linux) or dsm.opt (Windows/Netware): these can be got from our page on connecting to the HFS through a firewall, where the relevant fields are in the 'DNS Name' and 'Port' columns respectively. To access files from another machine you should then start the TSM client as below: dsmc -virtualnodename=dead.machine Unix/Linux load dsmc -virtualnodename=dead.machine ** Windows, Mac, ** Netware where DEAD.MACHINE should be substituted for the nodename of the machine to be restored. You will then be prompted for the TSM password for this machine. Querying and restoring the filestore is then as in the previous section, 6. Restoring your data. You will probably want to restore to a different destination to the original files to prevent overwriting files on the local machine, as below: tsm> rest D:\* D:\RESTORE\ -su=yes ** Windows tsm> rest /home/* /scratch/ -su=yes ** Mac, Unix/Linux tsm> rest SOURCE-SERVER\USR:* USR:restore/ -su=yes ** Netware 8. Changing your TSM password The TSM password is set to expire approximately one year after registration and at one-yearly intervals after that. Prior to this automatic expiry, you will be contacted to remind you to re-set this password. Note that even if you have the option PASSWORDACCESS Generate set in your options file, it is recommended you manually re-set your TSM password. To do this at the tsm> prompt enter: tsm> set password oldpassword newpassword 11/11