IBM Tivoli Software IBM Tivoli Software

[ | | | ]


IBM Tivoli Storage Manager for UNIX: Backup-Archive Clients Installation and User's Guide


Chapter 10. Using commands

Tivoli Storage Manager provides a command line interface (CLI) that you can use as an alternative to the graphical user interface (GUI). This chapter describes how to start or end a client command session and how to enter commands. Table 60 shows a list of tasks related to entering commands.

Table 60. 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 61 provides an alphabetical list of the commands, a brief description, and where to locate more information.

Table 61. Commands

Command Description Page
archive Archives files from a workstation to Tivoli Storage Manager storage. Archive
backup group Creates and backs up a group containing a list of files from one or more file space origins to a virtual file space on the Tivoli Storage Manager server. Backup Group
backup image Creates an image backup of one or more file systems or logical volumes that you specify. Backup Image
backup nas Creates an image backup of one or more file systems belonging to a Network Attached Storage (NAS) file server. Backup NAS
backup was Backs up the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server to the Tivoli Storage Manager server. Backup WAS
cancel process Displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. Cancel Process
cancel restore Displays a list of restartable restore sessions from which you can select one to cancel. Cancel Restore
delete access Deletes authorization rules for files or images that are stored on the server. Delete Access
delete archive Deletes archived files from Tivoli Storage Manager server storage. Delete Archive
delete filespace Deletes file spaces in Tivoli Storage Manager server storage. Delete Filespace
delete group Deletes a group backup on the Tivoli Storage Manager server. Delete Group
expire Inactivates backup objects that you specify in the file specification or with the filelist option. Expire
help Displays a Table of Contents of help topics for the command line client.. Help
incremental Backs up all new or changed files or directories in the default client domain or from file systems, directories, or files you specify, unless you exclude them from backup services. Incremental
loop Starts an interactive command session. Loop
macro Executes commands within a macro file that you specify. Macro
monitor process Displays a list of current NAS image backup and restore processes from which you can select one to cancel. Monitor Process
query access Displays a list of current authorization rules. Query Access
query archive Displays a list of archived files. Query Archive
query backup Displays a list of backup versions. Query Backup
query backupset Queries a backup set from a local file, tape device, or the Tivoli Storage Manager server. Query Backupset
query filespace Displays a list of file spaces in Tivoli Storage Manager storage. You can also specify a single file space name to query. Query Filespace
query group Displays information about group backups and their members. Query Group
query image Displays information about image backups. Query Image
query inclexcl Displays a list of include-exclude statements in the order in which they are processed during backup and archive operations. Query Inclexcl
query mgmtclass Displays information about available management classes. Query Mgmtclass
query node Displays all the nodes for which an administrative user ID has authority to perform operations. Query Node
query options Displays all or part of your options and their current settings. Query Options
query restore Displays a list of your restartable restore sessions in the server database. Query Restore
query schedule Displays information about scheduled events for your node. Query Schedule
query session Displays information about your session, including the current node name, when the session was established, server information, and server connection information. Query Session
query systeminfo Gathers Tivoli Storage Manager system information and outputs this information to a file or the console. Query Systeminfo
query was Displays backups of the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server that match the node name and type of the WAS group backup that you specify. Query WAS
restart restore Displays a list of restartable restore sessions from which you can one to restart. Restart Restore
restore Restores copies of backup versions of your files from a Tivoli Storage Manager server. Restore
restore backupset Restores a backup set from the Tivoli Storage Manager server or a local file. You can also restore a backup from a tape device. Restore Backupset
restore group Restores specific members or all members of a group backup. Restore Group
restore image Restores a file system or raw volume image backup. Restore Image
restore nas Restores the image of a file system belonging to a Network Attached Storage (NAS) file server. Restore NAS
restore was Restores the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server from the Tivoli Storage Manager server. Restore WAS
retrieve Retrieves copies of archived files from the Tivoli Storage Manager server. 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, archived copies, or image backups.. Set Access
set password Changes the Tivoli Storage Manager password for your workstation. Set Password
set waspassword When WAS security is enabled, this command allows you to set your WebSphere node name, user name, and password for the WAS Network Deployment Manager or the Application Server. Set Waspassword

Starting and ending a client command session

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

Use interactive mode when you want to enter a series of commands. Since Tivoli Storage Manager establishes connection to the server only once for interactive mode, a series of commands can process more quickly. Tivoli Storage Manager 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, dsmc. Tivoli Storage Manager processes the command and returns to the shell command prompt. For example, to process the incremental command in batch mode, you would enter:

   dsmc incremental

Tivoli Storage Manager prompts you each time you enter a command if the passwordaccess option is set to prompt and authentication on the server is set to On. Type your password and press Enter.

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

   dsmc incremental -password=secret

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

Process commands in interactive mode

Use the interactive mode (or loop mode) to enter a series of commands. Enter dsmc on the command line and press Enter. When the tsm> command prompt appears, type the command name and press Enter. Do not precede each command with the executable program name, dsmc. Alternatively, you can enter dsmc loop on the command line to start a client command session in interactive mode. Loop is the default command for dsmc.

If a password is required, Tivoli Storage Manager prompts you before you enter the first command. Type your user ID and password and press Enter. You can also enter your password using the password option with the loop command, but your password appears on the screen. For example, if your password is secret, enter:

   dsmc loop -password=secret

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

Notes:

  1. In loop mode, following a restore operation directly from tape, the mount point is not released in case additional restore requests are made to that volume. If you request a backup operation in the same session and that mount point is the only one available, the backup operation will stop with the following message:
      Waiting for mount of offline media
    
    In this case, the mount point is not released until one of the following conditions is met:

  2. In interactive mode, you cannot enter a file specification that contains national language characters. If a command contains national characters, process the command in batch mode by preceding the command with the executable program name, dsmc.

Entering client commands

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

The sections that follow describe each of these components.

Command name

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

   query schedule
   q sc
   q sched
   query sc

Options

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

Options handling in interactive mode

In interactive mode, options you enter on the initial command line will override the value that you specified in your client user options file (dsm.opt) or client system options file (dsm.sys). This value remains in effect for the entire interactive session unless overridden by a different value on a given interactive command. For example, if you set the subdir option to yes in your client user options file (dsm.opt), and you specify -subdir=no on the initial command line, the -subdir=no setting remains in effect for the entire interactive session unless overridden by the -subdir=yes value on a given interactive command. However, the subdir=yes value only affects the command it is entered on. When that command completes, the value reverts back to -subdir=no, the value at the beginning of the interactive session.

Parameters

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

   dsmc archive /project/budget.fin

Some commands have optional parameters. If you do not enter a value for an optional parameter, Tivoli Storage Manager uses the default value. For example, the restore command includes a required parameter, sourcefilespec, that specifies the path and file name in storage that you want to restore. The optional parameter, destinationfilespec, specifies the path and file name where you want to place the restored files. If you do not specify the destinationfilespec, by default Tivoli Storage Manager 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 /project/budget.fin file to /newproj/newbudg.fin, enter:

   dsmc restore /project/budget.fin /newproj/newbudg.fin

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

File specification syntax

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

Notes:

  1. You can overcome these limitations by using the filelist option to process a list of files. The Tivoli Storage Manager client opens the file you specify with this option and processes the list of files within according to the specific command. See Filelist for more information.

  2. |You can also use the removeoperandlimit option to specify |that Tivoli Storage Manager removes the 20-operand limit for UNIX-family |platforms. If you specify the removeoperandlimit option with |the incremental, selective, or archive |commands, the 20-operand limit is not enforced and is restricted only by |available resources or other operating system limits. See Removeoperandlimit

Remembering previous commands

If you set the editor option to yes in your client options file (dsm.opt), Tivoli Storage Manager permits you to recall and edit as many as 20 previously entered commands by using the Up arrow and Down arrow keys. If you set the editor option to no, the feature to recall previous commands is not active. If the editor and command retrieve functions are not working on a specific workstation setting, you should turn off the editor option. For more information regarding the editor option, see Editor.

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

Note: Because of the limited functionality of the dtterm application, not all function keys of the command line clients operate as expected. The Control-Left and Control-Right combinations and the Home and End key do not work.

Table 62. Command recall and edit functions

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

Using wildcard characters

In a command, you can use wildcard characters in the file name or file extension only. You cannot use them to specify destination files, file systems, or directories. You cannot specify a directory whose name contains an asterisk (*) or a question Mark (?). Tivoli Storage Manager recognizes these 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 must repeat the command for each file. Valid wildcard characters that you can use include:

*
Asterisk. Matches zero or more characters.

?
Question mark. Matches any single character at the present position.

Table 63 shows examples of each wildcard.

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

Note: In batch mode, you must enclose values containing wildcards in double quotes. For example:

   dsmc selective "/home/me/*.c"

Because the shell expands unquoted wildcards, it is easy to exceed the 20 operand limit in batch mode. It is more efficient to let the client process wildcard file specifications because many fewer server interactions are needed to complete the task.


Entering commands

Follow the general rules below when you enter commands:


Client commands reference

The following sections contain detailed information about each of the Tivoli Storage Manager commands. Information for each command includes:

Archive

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

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

See File system and ACL support for supported file systems and ACL support.

|Removing operand limits

|You can use the removeoperandlimit option to specify that Tivoli |Storage Manager removes the 20-operand limit for UNIX-family platforms. |If you specify the removeoperandlimit option with the |archive command, the 20-operand limit is not enforced and is |restricted only by available resources or other operating system |limits. See Removeoperandlimit

Associating a local snapshot with a server file space

Use the snapshotroot option with the archive command in conjunction with a third-party application that provides a snapshot of a logical volume, to associate the data on the local snapshot with the real file space data that is stored on the Tivoli Storage Manager server. The snapshotroot option does not provide any facilities to take a volume snapshot, only to manage data created by a volume snapshot. See Snapshotroot for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 64. Archive command: Related options

Option Where to use Page
archmc Command line only. Archmc
archsymlinkasfile Client user options file (dsm.opt) or command line. Archsymlinkasfile
changingretries Client system options file (dsm.sys) or command line. Changingretries
compressalways Client user options file (dsm.opt) or command line. Compressalways
compression Client system options file (dsm.sys) within a server stanza or command line. Compression
deletefiles Command line only. Deletefiles
description Command line only. Description
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only. Filesonly
preservelastaccessdate Client user options file (dsm.opt) or command line. Preservelastaccessdate
removeoperandlimit Command line only. Removeoperandlimit
snapshotroot Command line only. Snapshotroot
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
v2archive Command line only. V2archive
filespec
Specifies path and name of the file you want to archive. You can use wildcards to specify groups of files or all the files in a directory. See Maximum file size for operations for the maximum file size for archive processing.

Examples

Task
Archive a single file named budget in the /home/proj1 directory.

Command: archive /home/proj1/budget

Task
Archive all files in the /home/proj1 directory with a file extension of .txt.

Command: archive "/home/proj1/*.txt"

Task
Archive all files in the directory tree headed by the /home directory.

Command: archive -subdir=yes "/home/*"

Task
Assuming that you initiated a snapshot of the /usr file system and mounted the snapshot as /snapshot/day1, archive the /usr/dir1/sub1 directory tree from the local snapshot and manage it on the Tivoli Storage Manager server under the file space name /usr.

Command: dsmc archive /usr/dir1/sub1/ -subdir=yes -snapshotroot=/snapshot/day1

Backup Group

Authorized User

Use the backup group command to create and back up a group containing a list of files from one or more file space origins to a virtual file space on the Tivoli Storage Manager server.

A group backup allows you to create a consistent point-in-time backup of a group of files that is managed as a single logical entity:

The backup group command requires the following options:

filelist
Specifies a list of files to add to a new group. See Filelist for more information.

groupname
Specifies the fully qualified name of the group containing a list of files. See Groupname for more information.

virtualfsname
Specifies the name of the virtual file space for the group on which you want to perform the operation. See Virtualfsname for more information.

mode
Specifies whether you want to back up all of the files in the filelist or only files that have changed since the last full backup. See Mode for more information.

Notes:

  1. If any file in the group backup fails, the entire group backup will fail.

  2. Use the query group command to query members of a group backup on the Tivoli Storage Manager server. See Query Group for more information.

  3. Use the restore group command to restore specific members or all members of a group backup on the Tivoli Storage Manager server. See Restore Group for more information.

  4. Use the delete group command to delete a specific group backup from the Tivoli Storage Manager server. See Delete Group for more information.

  5. Use the query filespace command to display virtual file space names for your node that are stored on the Tivoli Storage Manager server. See Query Filespace for more information.

  6. A group backup can be added to a backup set. See Restoring data from a backup set for more information about backup sets.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Backup GRoup- options---------------------------------------><
 
 

Parameters

options

Table 65. Backup Group command: Related options

Option Where to use Page
filelist Command line only. Filelist
groupname Command line only. Groupname
mode Command line only. Mode
virtualfsname Command line only. Virtualfsname

Examples

Task
Perform a full backup of all the files in the /home/dir1/filelist1 file to the virtual file space name /virtfs containing the group leader /home/group1 file.

Command:

backup group -filelist=/home/dir1/filelist1 -groupname=group1
-virtualfsname=/virtfs -mode=full

Backup Image

The backup image command creates an image backup of one or more volumes on your system.

Notes:

  1. |For the Linux clients, image backup is only supported on partitions |with id 0x83 or logical volumes created with the Linux Logical Volume |Manager. Backing up other partitions, such as extended partitions that |contain mounted file systems or database data, may produce inconsistent backup |data if the data changes during the image backup operation.
  2. Open file support, the usage of GPFS snapshot, and image backup is not supported for GPFS file systems on Linux86, Linux iSeries, and Linux pSeries.
  3. |Image backup of the Sun QFS and IBM TotalStorage SAN File Systems is |not supported.
  4. The Tivoli Storage Manager API must be installed to use the backup image command.

The Tivoli Storage Manager client must support the raw device type on the specific platform to perform an image backup of a raw device. You can only perform an image backup on local devices. Clustered devices or file systems as well as devices or file systems shared between two or more systems are not supported. If you want to perform an image backup for a file system mounted on a raw device, the raw device must be supported. See Volume device type support for an image backup for specific information about supported devices for the backup image command.

Use the include.image option to include a file system or logical volume for image backup, or to specify volume-specific options for image backup.

The backup image command uses the compression option value specified in the dsm.sys. You can also specify the compression option with the backup image command.

Static, dynamic, and snapshot image backup

The traditional image backup prevents write access to the volume by other system applications during the operation. Use the imagetype=dynamic option to back up the volume as is without remounting it read-only. Corruption of the backup may occur if applications write to the volume while the backup is in progress. In this case, run fsck after a restore.

For Linux86 and Linux IA64 clients only: Tivoli Storage Manager performs a snapshot image backup of file systems residing on a logical volume created by the Linux Logical Volume Manager during which the volume is available to other system applications. Snapshot image backup requires a Version 5.1 Tivoli Storage Manager server.

You can use the imagetype option with the backup image command or the include.image option to specify whether to perform a static, dynamic, or snapshot image backup. See Imagetype for more information.

The Linux Logical Volume Manager allows the creation of a snapshot of a logical volume while the logical volume itself is still online. The snapshot is created inside the same volume group as the source logical volume. You must ensure that the volume group provides enough free disk space to create the snapshot. The snapshot contains the old data blocks while the modified data is stored in the source logical volume. Use the snapshotcachesize option with the backup image command, in the dsm.opt file, or with the include.image option to specify an appropriate snapshot size so that all old data blocks can be stored while the image backup occurs. A snapshot size of 100 percent will ensure a valid snapshot. See Snapshotcachesize for more information.

Utilizing image backup to perform file system incremental backup

There are two methods of utilizing image backups to perform efficient incremental backups of your file system. These backup methods allow you to perform point-in-time restore of your file systems and improve backup and restore performance. You can perform the backup only on formatted volumes; not on raw logical volumes. You can use one of the following methods to perform image backups of volumes with mounted file systems.

Method 1 Using image backup with file system incremental
  1. Perform a full incremental backup of the file system, for example:
      dsmc incremental /myfilesystem
    
  2. Perform an image backup of the same file system, for example:
      dsmc backup image /myfilesystem
    
  3. Periodically, perform incremental backups, for example:
      dsmc incremental /myfilesystem
    
    You must follow these steps in the order shown to ensure that the server records additions and deletions accurately.
  4. The following command restores the file system to its exact state as of the last incremental backup:
      dsmc restore image /myfilesystem -incremental -deletefiles
    
    During the restore, the client does the following:

If you do not follow the steps exactly, two things can occur:

Method 2 Using image backup with image incremental mode
  1. Perform an image backup of the same file system, for example:
      dsmc backup image /myfilesystem
    
  2. Perform an incremental image backup of the file system, for example:
      dsmc backup image /myfilesystem -mode=incremental
    
    This sends only those files that were added or changed since the last image backup to the server. For more information, see Mode.
  3. Periodically, perform full image backups, for example:
      dsmc backup image /myfilesystem
    
  4. Restore the image as follows:
      dsmc restore image /myfilesystem -incremental
    
    On restore, Tivoli Storage Manager ignores the deletefiles option when the image+image incremental technique of backing up has been used. The restore will include files that were deleted after the last full image backup plus the latest versions of files added or changed after the last image backup.
Note:
You should perform full image backups periodically in the following cases: This will improve restore time because fewer changes are applied from incrementals.

The following restrictions apply when using method 2:

To help you decide which method is appropriate for your environment, see Comparing methods 1 and 2.

Supported Clients

This command is valid for AIX, HP-UX, all Linux clients, and Solaris.

Syntax

                               .-----------------.
                               V                 |
>>-Backup Image--+----------+----+-------------+-+-------------><
                 '- options-'    +- filespec---+
                                 '- "filespec"-'
 
 

Parameters

options

Table 66. Backup Image command: Related options

Option Where to use Page
compressalways Client user options file (dsm.opt) or command line. Compressalways
compression Client system options file (dsm.sys) or command line. Compression
imagetype Use with the backup image command or the include.image option in your client system options file (dsm.sys). Imagetype
mode Command line only. Mode
snapshotcachesize Use with the backup image command, the include.image option, or in the dsm.opt file. Snapshotcachesize
filespec
Specifies the name of one or more logical volumes. If you want to back up more than one file system, separate their names with spaces. Do not use pattern matching characters. If you do not specify a volume name, the logical volumes specified with the domain.image option will process. If you do not use the domain.image option to specify file systems to process, an error message displays and no image backup occurs.

Specify the file space over which the logical volume is mounted or the logical volume name. If there is a file system configured in the system for a given volume, you cannot back up the volume with the device name. For example, if /dev/lv01 is mounted on /home you can issue backup image /home but backup image /dev/lv01 will fail with an error: ANS1063E Invalid path specified.

For Sun systems: Specify either a file system name or a raw device name (block device type).

Examples

Task
Back up the /home/test file space over which the logical volume is mounted and perform an image incremental backup that backs up only new and changed files after the last full image backup.

Command: dsmc backup image /home/test -mode=incremental

Task
Perform a static image backup of the logical volume mounted at the /home directory.

Command: dsmc backup image /home -imagetype=static

Task
Perform a snapshot image backup of the /home directory.

Command: dsmc backup image /home -imagetype=snapshot

Task
Back up the /dev/lv01 raw logical volume.

Command: dsmc backup image /dev/lv01

Backup NAS

The backup nas command creates an image backup of one or more file systems belonging to a Network Attached Storage (NAS) file server. The NAS file server performs the outboard data movement. A server process starts in order to perform the backup.

Use the nasnodename option to specify the node name for the NAS file server. When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID. The NAS node name identifies the NAS file server to the Tivoli Storage Manager server; the NAS node name must be registered at the server. Place the nasnodename option in your client system options file (dsm.sys). The value in the client system options file is the default, but can be overridden on the command line. See Nasnodename for more information.

Use the toc option with the backup nas command or the include.fs.nas option to specify whether Tivoli Storage Manager saves Table of Contents (TOC) information for each file system backup. See Toc for more information. If you save TOC information, you can use the query toc server command to determine the contents of a file system backup in conjunction with the restore node server command to restore individual files or directory trees. You can also use the Tivoli Storage Manager Web client to examine the entire file system tree and select files and directories to restore. Creation of a TOC requires that you define the TOCDESTINATION attribute in the backup copy group for the management class to which this backup image is bound. Note that TOC creation requires additional processing, network resources, storage pool space, and possibly a mount point during the backup operation. If you do not save TOC information, you can still restore individual files or directory trees using the restore node server command, provided that you know the fully qualified name of each file or directory and the image in which that object was backed up. The toc option is only supported for images backed up by version 5.2 or later client and server.

Use the mode option to specify whether to perform a full or differential NAS image backup. A full image backup backs up the entire file system. The default is a differential NAS image backup on files that change after the last full image backup. If an eligible full image backup does not exist, a full image backup is performed. See Mode for more information.

Use the monitor option to specify whether you want to monitor a NAS file system image backup and display processing information on your screen. See Monitor.

Use the monitor process command to display a list of all processes for which an administrative user ID has authority. The authorized administrative user ID should have at least client owner authority over both the NAS node and the client workstation node they are using either from command line or from the web.

Use the cancel process command to stop NAS back up processing. For more information, see Cancel Process.

Regardless of client platform, NAS file system specifications use the forward slash (/) separator, as in this example: /vol/vol0.

Supported Clients

This command is valid for AIX and Solaris clients only.

Syntax

                             .---------------.
                             V               |
>>-Backup NAS--+----------+------ filespec---+-----------------><
               '- options-'
 
 

Parameters

options

Table 67. Backup NAS command: Related options

Option Where to use Page
mode Command line only. Mode
monitor Command line only. Monitor
nasnodename Client system options file (dsm.sys) or command line. Nasnodename
toc Command line or with the include.fs.nas option in your client system options file (dsm.sys). Toc
filespec
Specifies the name of one or more file systems on the NAS file server. If you do not specify this parameter, Tivoli Storage Manager processes all of the file systems defined by the domain.nas option. For more information about this option, see Domain.nas.

If you do not specify the filespec or the domain.nas option, the default all-nas value is used for domain.nas and all file systems on the NAS file server are backed up.

Examples

Task
Perform the NAS image backup of the entire file system.

Command: backup nas -mode=full -nasnodename=nas1 /vol/vol0 /vol/vol2

Task
Perform the NAS image backup of the entire file server.

Command: backup nas -nasnodename=nas1

Task
Perform the NAS image backup of the entire file system and save Table of Contents (TOC) information for the file system backup.

Command: backup nas -mode=full -nasnodename=netappsj /vol/vol0 -toc=yes

Backup WAS

Root User

The backup was command specifies whether to back up the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server (also contains setup, application files, and configuration information) to the Tivoli Storage Manager server. You can back up both the Network Deployment Manager and the Application Server using separate sessions.

Notes:

  1. |If WAS security is enabled, user name and password validation for |Data Protection for WebSphere Application Server is required. To avoid |backup failure, you must use the set waspassword command |to set the user name and password for each installation of WAS on your |machine. You only need to perform this task once, unless you change |your WAS user name or password. See Set Waspassword for more information.

    |To determine if WAS security is enabled, enter the following command:

    |  dsmc query was -wast=local

    |Tivoli Storage Manager displays the WAS security status under the |Sec heading.

  2. Multiple backup sessions of the same node are not supported.

  3. Use the mode option to specify whether to perform a full (the default) or differential backup. See Mode for more information.

  4. Use the wastype option to specify whether to back up the Network Deployment Manager (ND) or Application Server (APP) associated with the node name of the instance of WAS that you want to back up. The default is ND. See Wastype for more information.

  5. Use the include option in your client system options file (dsm.sys) to assign a management class to a WAS group backup. For example:

  6. WAS backups can also be added to a backup set. See Restoring data from a backup set for more information about WAS backups.

Supported Clients

This command is valid for AIX, Solaris, and Linux86 clients.

Syntax

>>-Backup WAs--+----------+-- --nodename-----------------------><
               '- options-'
 
 

Parameters

options

Table 68. Backup WAS command: Related options

Option Where to use Page
mode Command line only. Mode
wastype Command line only. Wastype
nodename
Specifies the node name of the instance of WAS to back up. This is a required parameter.

Examples

Task
Back up the Network Deployment Manager associated with the node name wasnode.

Command: backup was wasnode

Task
Back up the Application Server associated with the node name and instance ednode_instance1.

Command: backup was ednode_instance1 -wastype=app

Task
Perform a differential backup of the Network Deployment Manager associated with the node name and instance ednode_instance2.

Command: backup was ednode_instance2 -wastype=nd -mode=differential

Cancel Process

The cancel process command displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. From the list, the administrative user can select one process to cancel. Client owner privilege is sufficient authority to cancel the selected NAS image backup or restore processes.

When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID.

Note:
If you use the cancel process command on the initial command line, no server contact is made and no password is needed.

Supported Clients

This command is valid for AIX and Solaris clients only.

Syntax

>>-Cancel Process----------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Cancel current NAS image backup or restore processes.

Command: cancel process

Cancel Restore

The cancel restore command displays a list of your restartable restore sessions in the server database. 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:

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Cancel Restore----------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Cancel a restore operation.

Command: cancel restore

Delete Access

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Delete ACcess-----------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

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

Command: delete access

See the following screen example:

Index   Type       Node    Owner   Path  
_____   _______    ____________________________________
1       Backup     NODE1   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:

To delete the authorization rules that let luie and user2s access your files or images, type: 2 4 or (2,4) and press Enter.

Delete Archive

The delete archive command deletes archived files from Tivoli Storage Manager server 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.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Delete ARchive--+----------+--+- filespec---+---------------><
                   '- options-'  '- "filespec"-'
 
 

Parameters

options

Table 69. Delete Archive command: Related options

Option Where to use Page
dateformat Client user options file (dsm.opt) or command line. Dateformat
description Command line only. Description
filelist Command line only. Filelist
noprompt Command line only. Noprompt
numberformat Client user options file (dsm.opt) or command line. Numberformat
pick Command line only. Pick
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line, Tapeprompt
timeformat Client user options file (dsm.opt) or command line. Timeformat
filespec
Specifies the path and file name that you want to delete from storage. Use wildcard characters to specify a group of files or all files in a directory.

Examples

Task
Delete a file named budget.

Command: delete archive /user/home/proj1/budget

Task
Delete all files archived from the /user/home/proj1 directory with a file extension of .txt.

Command: del arch "/user/home/proj1/*.txt"

Task
Delete files archived from the /user/project directory using the pick option to display a list of archive copies that match the file specification. From the list, you can select the versions to process.

Command: delete archive "/user/project/*" -pick

Delete Filespace

Authorized User

The delete filespace command deletes file spaces in Tivoli Storage Manager server storage. A file space is a logical space on the server that contains files or images you backed up or archived. Tivoli Storage Manager assigns a separate file space on the server for each workstation file system 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, a list of your file spaces displays. From this list, select the file space that you want to delete.

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.

Deleting NAS file spaces

You can use the delete filespace command to interactively delete NAS file spaces from server storage.

Use the nasnodename option to identify the NAS file server. When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID. Place the nasnodename option in your client system options file (dsm.sys). The value in the client system options file is the default, but this value can be overridden on the command line. If the nasnodename option is not specified in the client system options file, you must specify this option on the command line when processing NAS file systems. See Nasnodename for more information.

Use the class option to specify the class of the file space to delete. To display a list of file spaces belonging to a NAS node so that you may choose one to delete, use the -class=nas option. Using the default, -class=client, will not change the current delete filespace behavior. See Class for more information.

To delete NAS file spaces using the Web client, see Chapter 4, Backing up your data.

Deleting WebSphere Application Server (WAS) file spaces

Use the delete filespace command to delete a WAS file space on the Tivoli Storage Manager server.

Use the delete group command to delete WAS group backups on the Tivoli Storage Manager server. See Delete Group for more information.

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 70. Delete Filespace command: Related options

Option Where to use Page
class Command line only. Class
detail Command line only. Detail
nasnodename Client system options file (dsm.sys) or command line. Nasnodename
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt

Examples

Task
Delete a file space.

Command: delete filespace

Task
Delete NAS file spaces from the dagordon NAS file server stored on the server.

Command: delete filespace -nasnodename=dagordon -class=nas

Task
Delete WAS file spaces stored on the server.

Command: delete filespace

Delete Group

Authorized User

Use the delete group command to delete a group backup on the Tivoli Storage Manager server. You can also delete WAS group backups using this command.

After deleting a group, the group leader (virtualfsname) remains on the Tivoli Storage Manager server. It contains no members (file or directories) but is reported in a subsequent query filespace command. It will have no files listed if the showmembers option is added. Deleting a group does not remove the file space that it resides in because there may be other groups in it. Use delete filespace if you want to remove the file space and all the data it contains.

Notes:

  1. Use the inactive option to display both active and inactive group backup versions. By default, Tivoli Storage Manager only displays active versions. See Inactive for more information.

  2. Use the pick option to select a specific group to delete from the Tivoli Storage Manager server. See Pick for more information.

  3. Use the noprompt option if you want to suppress the confirmation prompt that normally appears before you delete a group backup version. By default, Tivoli Storage Manager prompts you for confirmation before deleting the group backup. Using this option can speed up the delete procedure. However, it also increases the danger of accidentally deleting a group backup version that you want to save. Use this option with caution. See Noprompt for more information.

  4. Use the query filespace command to display virtual file space names for your node that are stored on the Tivoli Storage Manager server. See Query Filespace for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Delete GRoup- filespec-+----------+-------------------------><
                          '- options-'
 
 

Parameters

filespec
Specifies the virtual file space name and the group name on the server that you want to delete.
options

Table 71. Delete Group command: Related options

Option Where to use Page
inactive Command line only. Inactive
noprompt Command line only. Noprompt
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime

Examples

Task
Delete the current active version of the /vfs/group1 group.

Command:

delete group /vfs/group1

Task
Delete a backup version of the /vfs/group1 group from a list of active and inactive versions.

Command:

delete group /vfs/group1 -inactive -pick

Task
Delete the current active APP/ND WAS group.

Command: delete group /WAS_APPNODE/WASGROUP

Task
Delete a backup version of the WAS ND/APP group from a list of active and inactive versions.

Command: delete group /WAS_ND_NDNODE/WASGROUP -inactive -pick

Expire

The expire command inactivates the backup objects you specify in the file specification or with the filelist option.

When working in interactive mode, a prompt notifies you before files are expired.

The expire command does not remove workstation files. If you expire a file or directory that still exists on your workstation, the file or directory is backed up again during the next incremental backup unless you exclude the object from backup processing.

If you expire a directory that contains active files, those files will not appear in a subsequent query from the GUI. However, these files will display on the command line if you specify the proper query with a wildcard character for the directory.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-EXPire--+----------+---- filespec---------------------------><
           '- options-'
 
 

Parameters

options

Table 72. Expire command: Related options

Option Where to use Page
dateformat Client user options file (dsm.opt) or command line. Dateformat
filelist Command line only. Filelist
noprompt Command line only. Noprompt
numberformat Client user options file (dsm.opt) or command line. Numberformat
pick Command line only. Pick
timeformat Client user options file (dsm.opt) or command line. Timeformat
Note: If you specify filelist, then pick is ignored.
filespec
Specifies a path and a filename that you want to expire. You can enter only one file specification on this command. However, you can use wildcards to select a group of files or all the files in a directory. If you specify the filelist option, the filespec designation is ignored.

Examples

Task
Inactivate the letter1.txt file in the home directory.

Command: expire "u/home/letter1.txt"

Task
Inactivate all files in the admin/mydir directory.

Command: expire u/admin/mydir/*

Task
Inactivate all files in the /home/avi/filelist.txt file.

Command: expire -filelist=/home/avi/filelist.txt

Help

The help command displays a Table of Contents of help topics 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 list. To exit, type q and press Enter.

Note:
If you use the help command on the initial command line, no server contact is made and no password is needed.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Help--------------------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Display a list of help topics.

Command: help

Incremental

The incremental command backs up all new or changed files or directories in the default client domain or from file systems, directories, or files you specify, unless you exclude them from backup services.

To incrementally back up selected files or directories, enter a file specification in the command. If you do not enter a file specification, the default is to back up files or directories in the default domain. See Domain for information on how to change which objects are included in the default domain.

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

Frequency
The number of days that must elapse between successive backups for the file. The frequency attribute applies only to a full incremental backup.

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

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

For more information on management classes, see Chapter 8, "Understanding storage management policies".

Using the include option in an include-exclude list, you can override" the default management class for a file or group of files.

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

You can also use the selective command to perform a selective backup that backs up only the files, directories or empty directories that you specify regardless of whether they have changed. For more information, see Selective.

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

|Removing operand limits

|You can use the removeoperandlimit option to specify that Tivoli |Storage Manager removes the 20-operand limit for UNIX-family platforms. |If you specify the removeoperandlimit option with the |incremental command, the 20-operand limit is not enforced and is |restricted only by available resources or other operating system |limits. See Removeoperandlimit

Incremental-by-Date

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

If an incremental-by-date is performed on only part of a file system, the date of the last full incremental is not updated, and the next incremental-by-date will back up these files again. Changes to the access control lists (ACL) are not backed up during an incremental-by-date. Use the query filespace command to determine the date and time of the last incremental backup of the entire file system.

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

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

For these reasons, if you have limited time during the week to perform backups, but extra time on the weekends, you can perform an incremental-by-date backup on weekdays and a full incremental backup on weekends to maintain current server storage of your workstation files.

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

Associating a local snapshot with a server file space

Use the snapshotroot option with the incremental command in conjunction with a third-party application that provides a snapshot of a logical volume, to associate the data on the local snapshot with the real file space data that is stored on the Tivoli Storage Manager server. The snapshotroot option does not provide any facilities to take a volume snapshot, only to manage data created by a volume snapshot. See Snapshotroot for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 73. Incremental command: Related options

Option Where to use Page
changingretries Client system options file (dsm.sys) or command line. Changingretries
compressalways Client user options file (dsm.opt) or command line. Compressalways
compression Client system options file (dsm.sys) within a server stanza or command line. Compression
dirsonly Command line only. Dirsonly
domain Client system options file (dsm.sys) or the client user options file (dsm.opt) or command line only. Domain
filelist Command line only. Filelist
filesonly Command line only. Filesonly
incrbydate Command line only. Incrbydate
memoryefficientbackup Client user options file (dsm.opt) or command line. Memoryefficientbackup
preservelastaccessdate Client user options file (dsm.opt) or command line. Preservelastaccessdate
removeoperandlimit Command line only. Removeoperandlimit
snapshotroot Command line only. Snapshotroot
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
filespec
Specifies the path and file name that you want to back up. Use wildcards to select a group of files or all the files in a directory. If you do not specify a file specification, the default domain or the domain specified as an option is backed up. See Maximum file size for operations for the maximum file size for back up processing.

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

If you specify a file system, specify the file system without a trailing slash.

Examples

Task
Run an incremental backup of the default client domain specified in your client user options file (dsm.opt).

Command: Incremental

Task
Run an incremental backup for the /home, /usr, and /proj file systems.

Command: Incremental /home /usr /proj

Task
Run an incremental backup for the /proj/test directory.

Command: Incremental /proj/test/

Task
Run an incremental-by-date backup for the /home file system.

Command: Incremental -incrbydate /home

Task
Run an incremental backup of the abc file in the /fs/dir1 directory.

Command: Incremental -subdir=yes /fs/dir1/abc

Task
Run an incremental backup of the directory object /fs/dir1, but not any of the files in the /fs/dir1 directory.

Command: Incremental /fs/dir1

Task
Run an incremental backup of the directory object /fs/dir1 and all of the files in the /fs/dir1 directory.

Command: Incremental -subdir=yes /fs/dir1/

Task
Assuming that you initiated a snapshot of the /usr file system and mounted the snapshot as /snapshot/day1, run an incremental backup of all files and directories under the local snapshot and manage them on the Tivoli Storage Manager server under the file space name /usr .

Command: dsmc inc /usr -snapshotroot=/snapshot/day1

Loop

The loop command starts an interactive command line session that is maintained until you enter quit.

If you are required to enter a password, you will be prompted for it before the loop mode prompt appears.

Note:
It is no longer possible to enter loop mode without a valid server contact. One of the consequences is that certain commands, such as restore backupset -location=file, will only be accepted on the initial command line when a valid server is not available.

In an interactive command line session, it is unnecessary to precede each command name with dsmc and your password, if one is required.

In interactive mode, options you enter on the initial command line will override the value that you specified in your client user options file (dsm.opt) or client system options file (dsm.sys). This value remains in effect for the entire interactive session unless overridden by a different value on a given interactive command. For example, if you set the subdir option to yes in your client user options file (dsm.opt), and you specify -subdir=no on the initial command line, the -subdir=no setting remains in effect for the entire interactive session unless overridden by the -subdir=yes value on a given interactive command. However, the subdir=yes value only affects the command it is entered on. When that command completes, the value reverts back to -subdir=no, the value at the beginning of the interactive session.

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

There are some options that you cannot use in the interactive session created by the loop command and are identified in the option description by this statement: This option is valid only on the initial command line. It is not valid in interactive mode.

See Chapter 9, Using processing options for options that you cannot use in interactive mode.

Notes:

  1. In loop mode, following a restore operation directly from tape, the mount point is not released in case additional restore requests are made to that volume. If you request a backup operation in the same session and that mount point is the only one available, the backup operation will stop with the following message:
      Waiting for mount of offline media
    
    In this case, the mount point is not released until one of the following conditions is met:

  2. In interactive mode, you cannot enter a file specification that contains national language characters. If a command contains national characters, process the command in batch mode by preceding the command with the executable program name, dsmc.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-LOOP--------------------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Start an interactive command line session.

Command: dsmc

At the tsm> prompt, enter a command.

Macro

The macro command executes 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.

Comment lines are not supported within the macro file that you specify for the macro command.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

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

Examples

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

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

Command: macro backabc.mac

where backabc.mac contains the following statements:

 Selective /devel/project/proja/
 Selective /devel/project/projb/
 Selective /devel/project/projc/

Monitor Process

The monitor process command displays a list of current NAS (if NDMP support is enabled) image backup and restore processes for which the administrative user has authority. The administrative user can then select one process to monitor. Client owner privilege is sufficient authority to monitor the selected NAS image backup or restore processes.

When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID.

Supported Clients

This command is valid for AIX and Solaris clients only.

Syntax

>>-MONitor Process---------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Monitor current NAS image backup or restore processes.

Command: monitor process

Query Access

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query ACcess------------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

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

Command: query access

Query Archive

The query archive command displays a list of your archived files and the following information about each file:

If you use the detail option with the query archive command, the client displays the following additional information:

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query ARchive--+----------+--+- filespec---+----------------><
                  '- options-'  '- "filespec"-'
 
 

Parameters

options

Table 74. Query Archive command: Related options

Option Where to use Page
dateformat Client user options file (dsm.opt) or command line. Dateformat
description Command line only. Description
detail Command line only. Detail
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only. Filesonly
fromdate Command line only. Fromdate
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
fromtime Command line only. Fromtime
numberformat Client user options file (dsm.opt) or command line. Numberformat
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt
subdir Client user options file (dsm.opt) or command line. Subdir
timeformat Client user options file (dsm.opt) or command line. Timeformat
todate Command line only. Todate
totime Command line only. Totime
filespec
Specifies the path and file name that you want to query. Use wildcard characters to specify a group of files or all the files in a directory. If you use wildcard characters, enclose the file specification in double quotation marks. Specify an asterisk (*) to query all archived files in the current directory.

Examples

Task
Display a list of all your archived files in the current working directory.

Command: q archive "*"

Task
Display a list of all your archived files in the /devel directory and all of its subdirectories.

Command: query archive "/devel/*" -subdir=yes

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

Command: q ar -date=5 -time=1 "*"

Task
Display a list of all your archived files in the current directory. Use the detail option to display the last modification date and the last access date of each file.

Command: q ar -detail "*"

Task
Display a list of archived files in the /home/proj directory whose first four characters of the file name begin with proj.

Command: q ar "/home/proj/proj*"

Query Backup

The query backup command displays a list of backup versions of your files. File information includes the following:

If you use the detail option with the query archive command, the client displays the following additional information:

Querying NAS file system images

You can use the query backup command to display information about file system images backed up for a NAS file server.

Use the nasnodename option to identify the NAS file server to query. When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID. Place the nasnodename option in your client system options file (dsm.sys). The value in the client system options file is the default, but this value can be overridden on the command line. See Nasnodename for more information.

Use the class option to specify the class of the file space to query. To display a list of images belonging to a NAS node, use the -class=nas option. Using the default -class=client option will not change the current query backup behavior. See Class for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query Backup--+----------+--+- filespec---+-----------------><
                 '- options-'  '- "filespec"-'
 
 

Parameters

options

Table 75. Query Backup command: Related options

Option Where to use Page
class Command line only. Class
dateformat Client user options file (dsm.opt) or command line. Dateformat
detail Command line only. Detail
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only. Filesonly
fromdate Command line only. Fromdate
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
fromtime Command line only. Fromtime
inactive Command line only. Inactive
nasnodename Client system options file (dsm.sys) or command line. Nasnodename
numberformat Client user options file (dsm.opt) or command line. Numberformat
pitdate Command line only. Pitdate
pittime Command line only. Pittime
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt
subdir Client user options file (dsm.opt) or command line. Subdir
timeformat Client user options file (dsm.opt) or command line. Timeformat
todate Command line only. Todate
totime Command line only. Totime
filespec
Specifies the path and file name that you want to query. Use wildcard characters to specify a group of files or all the files in a directory. If you use wildcard characters, enclose the file specification in double quotation marks. Specify an asterisk (*) to display information about backup versions for all of your files in the current directory. Do not use wild cards when you query NAS file system images with -class=nas option.

Examples

Task
Display a list of all active and inactive backup versions of your files in the current directory.

Command: query backup -inactive "*"

Task
Display a list of all your backups in the current directory. Use the detail option to display the last modification date and the last access date of each file.

Command: q backup -detail "*"

Task
Display a list of files that were backed up from the /home/proj directory with file names that begin with proj. Use the dateformat and timeformat options.

Command: q b -date=1 -time=4 "/home/proj/proj*"

Task
Display a list of active and inactive backup file versions in the /home file system. Use the dateformat and timeformat options.

Command: q b -date=5 -time=1 -ina -su=yes /home/

Task
Query file system images from the nas2 NAS file server.

Command: query backup -nasnodename=nas2 -class=nas

Query Backupset

The query backupset command queries a backup set from a local file, tape device, or the Tivoli Storage Manager server. See Location for information on specifying locally-resident backup sets. This command displays the backup set name, generation date, retention, and description.

You can use this command to query backup sets on a tape device with AIX, Solaris, and HP-UX clients only.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 76. Query Backupset command: Related options

Option Where to use Page
description Command line only. Description
location Command line only. Location
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt
backupsetname
Specifies the name of the backup set on the server you want to query when -location=server is in effect. You can use wildcards to specify the backup set name. If you use wildcards or do not specify a backup set name, all backup sets that you own display on the screen. When a backup set is created, the server assigns root as the owner of the backup set. When querying a backup set on the server, a non-root user will not see the backup set listed, even if they know the backup set name and use it in the query.
filename
Specifies the file name on your local workstation that contains the backup set you want to query when -location=file is in effect.

Examples

Task
Query a backup set called mybackupsetname on the server.

Command: query backupset "mybackupsetname" -loc=server

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

Command: dsmc query backupset "/home/budget/backupsetfile.name" -loc=file

Task
Query the backup set on the /dev/rmt0 tape device.

Command: dsmc query backupset /dev/rmt0 -loc=tape

Query Filespace

The query filespace command displays a list of file spaces for a node that are stored on the Tivoli Storage Manager server. You can also specify a single file space name to query. A file space is a logical space on the server that contains files you backed up or archived. Tivoli Storage Manager 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.

Querying NAS file spaces

Use the nasnodename option to identify the NAS file server to query. When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID. Place the nasnodename option in your client system options file (dsm.sys). The value in the client system options file is the default, but this value can be overridden on the command line. If the nasnodename option is not specified in the client system options file, it must be specified on the command line when processing NAS file systems. See Nasnodename for more information.

Use the class option to specify the class of the object to query. To display a list of file spaces belonging to a NAS node, use the -class=nas option. Using the default, -class=client, will not change the current query filespace behavior. See Class for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

filespacename
Specifies an optional character string which can include wildcards. Use this argument to specify a subset of file spaces. The default is to display all file spaces.
options

Table 77. Query Filespace command: Related options

Option Where to use Page
class Command line only. Class
dateformat Client user options file (dsm.opt) or command line. Dateformat
detail Command line only. Detail
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
nasnodename Client system options file (dsm.sys) or command line. Nasnodename
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt
timeformat Client user options file (dsm.opt) or command line. Timeformat

Examples

Task
Display your file spaces.

Command: query filespace

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

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

Task
Display the /home file space.

Command: query filespace /home

Task
Display file space names that include the pattern smith.

Command: query filespace "*smith*"

Task
Query a file space from the nas2 NAS file server.

Command: query filespace -nasnodename=nas2 -class=nas

Query Group

Authorized User

Use the query group command to display information about a group backup and its members.

Notes:

  1. Use the pick option to display a list of groups from which you can select one group to query.

  2. Use the showmembers option to display and select individual group members that you want to query. The showmembers option is not valid with the inactive option. If you want to display members of a group that are not currently active, use the pitdate and pittime options to specify the backup date and time of the member you want to query.

  3. Use the query filespace command to display virtual file space names for your node that are stored on the Tivoli Storage Manager server. See Query Filespace for more information.

  4. If you perform a full and differential group backup, a query of this group using the -inactive option displays two active backups of the same name, one of type FULL and one of type DIFF. These backups inactivate any previous full and differential backups:
    +--------------------------------------------------------------------------------+
    |Size      Backup Date          Mgmt Class  A/I Type File                        |
    |----      -----------          ----------  --- ---- ----                        |
    |433  B  10/09/2002 14:40:07    NOARCH       A  FULL VFS/GROUP1                  |
    |433  B  10/10/2002 07:58:43    NOARCH       A  DIFF VFS/GROUP1                  |
    |433  B  10/09/2002 14:39:58    NOARCH       I  FULL VFS/GROUP1                  |
    |433  B  10/09/2002 14:39:53    NOARCH       I  DIFF VFS/GROUP1                  |
    |                                                                                |
    +--------------------------------------------------------------------------------+

    If you query a group backup without the -inactive option, the query displays only the latest group backup, whether it is type FULL or type DIFF:

    +--------------------------------------------------------------------------------+
    |Size      Backup Date        Mgmt Class A/I Type File                           |
    |----      -----------        ---------- --- ---- ----                           |
    |433  B  10/10/2002 07:58:43    NOARCH    A  DIFF VFS/GROUP1                     |
    +--------------------------------------------------------------------------------+

Supported Clients

This option is valid for all UNIX clients.

Syntax

>>-query group- filespec-+----------+--------------------------><
                         '- options-'
 
 

Parameters

options

Table 78. Query Group command: Related options

Option Where to use Page
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
inactive Command line only. Inactive
pitdate Command line only. Pitdate
pittime Command line only. Pittime
showmembers Command line only. Showmembers
filespec
Specifies the virtual file space name and the group name on the server that you want to query.

Examples

Task
Display all the groups in the /vfs file space.

Command:

query group /vfs/*

Task
Display active and inactive versions of the /vfs/group1 filespec.

Command:

query group /vfs/group1 -inactive

Task
Display the /vfs/group1 filespec. Use the showmembers option to display a list of group members from which you can select one or more to query.

Command:

query backup /vfs/group1 -showmembers 

Query Image

The query image command displays the following information about file system images backed up by a client:

Note:
The Tivoli Storage Manager API must be installed to use the query image command.

Supported Clients

This command is valid for AIX, HP-UX, all Linux clients, and Solaris.

Syntax

>>-Query Image--+----------+--+- logicalvolumename-+-----------><
                '- options-'  '- filespacename-----'
 
 

Parameters

options

Table 79. Query Image command: Related options

Option Where to use Page
dateformat Client user option file (dsm.opt) or command line. Dateformat
fromnode Command line only. Fromnode
fromowner Command line only Fromowner
inactive Command line only. Inactive
numberformat Client user option file (dsm.opt) or command line. Numberformat
pitdate Command line only. Pitdate
pittime Command line only. Pittime
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt
timeformat Client user option file (dsm.opt) or command line. Timeformat
logicalvolumename
The name of a logical volume you want to query. You must specify the exact name of the image. You cannot use wildcards. The default is all active images (unless restricted by one or more options).
filespacename
Specifies the file system name that you want to query.

Omitting logicalvolumename and filespacename causes all images to display.

Examples

Task
Display all backed up images.

Command: q image

Task
Display all backed up images owned by kutras at node avalon.

Command: query image -fromnode=avalon -fromowner=kutras

Task
Display active and inactive version of the /usr image.

Command: q i /usr -inactive

Query Inclexcl

The query inclexcl command displays a list of include-exclude statements in the order in which they are processed during backup and archive operations. The list displays the type of option, the scope of the option (archive, all, etc.), and the name of the source file.

You can test the validity of patterns you wish to use in your include-exclude list before you actually insert them in your options file. See the test pattern explanation below.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query INCLexcl- -+--------------+---------------------------><
                    '-test pattern-'
 
 

Parameters

test pattern
Use for testing the validity of patterns you wish to use in your include-exclude list. When you use a test pattern with this command, the following occurs:

If the test pattern has no errors, the compiled pattern result is the same as the test pattern.

Examples

Task
Display a list of include-exclude statements.

Command: query inclexcl

Task
Test the validity of this pattern: /.../?x?/*.log

Command: query inclexcl /.../?x?/*.log

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. Management classes also determine how backups and archives are managed on 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 user options file (dsm.opt). If you do not assign a management class to a file, Tivoli Storage Manager uses the default management class.

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 80. Query Mgmtclass command: Related options

Option Where to use Page
detail Command line only. Detail
fromnode Command line only. Fromnode

Examples

Task
Display default and available management classes.

Command: query mgmtclass

Query Node

The query node command displays all the nodes for which an administrative user ID has authority to perform operations. The authorized administrative user ID should have at least client owner authority over the client workstation node they are using either from command line or from the web.

When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID.

Use the type option to specify the type of node to filter for. Valid values are nas, client, server, and any. The default is any. See Type for more information.

Supported Clients

This command is valid for AIX and Solaris clients only.

Syntax

>>-Query Node-+----------+-------------------------------------><
              '- options-'
 
 

Parameters

options

Table 81. Query Node command: Related options

Option Where to use Page
type Command line only. Type
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt

Examples

Task
Display all NAS nodes.

Command: query node -type=nas

Query Options

Use the query options command to display all or part of your options and their current settings.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query Options--+----------+---- pattern---------------------><
                  '- options-'
 
 

Parameters

pattern
An optional character string which can include wildcards. Use this argument to specify a subset of options. The default is to display all options.
options

Table 82. Query Options command: Related options

Option Where to use Page
scrolllines Client user options file (dsm.opt) or command line. Scrolllines
scrollprompt Client user options file (dsm.opt) or command line. Scrollprompt

Examples

Task
Display all options and their values.

Command: query options

Task
Display only options beginning with comm.

Command: query options comm*

Task
Display the value of the replace option.

Command: query options replace

Query Restore

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

A restartable restore session is created when a wildcard restore command fails because of network outage, client failure, server outage, or a similar problem. When such a failure occurs, the file space is locked on the server and its files cannot be moved off the server's sequential volumes. To unlock the file space, either restart the restore and allow it to complete (restart restore command), or cancel the restore (cancel restore command). Use query restore to determine if you have any restartable restore sessions and which file spaces are affected.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

There are no parameters for this command.

Examples

Task
Display your restartable restore session in the server database.

Command: query restore

Query Schedule

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query SChedule----------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Display your scheduled events.

Command: query schedule

Query Session

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-Query SEssion-----------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Display your session information.

Command: query session

A sample query session display follows:

Tivoli Storage Manager
Command Line Backup Client Interface - Version 5, Release 1,
Level 0.0 (C) Copyright IBM Corporation, 1990, 2002 All
Rights Reserved.
 
Node Name: EPSILON3
Session established with server FIJI_0918GA: AIX-RS/6000
  Server Version 5, Release 1, Lev. 0.0
  Server date/time: 03/04/2002 15:09:52  
  Last access: 03/04/2002 15:09:40
 
Server Connection Information
 
Server Name.............: FIJI_0918GA
Server Type.............: AIX-RS/6000
Server Version..........: Ver. 5, 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

Query Systeminfo

Use the query systeminfo command to gather information on one or more of the following items and output this information to a file or the console:

Notes:

  1. Use the filename option to specify a file name in which to store the information gathered from the items you specify. If you do not specify a file name, by default the information is stored in the dsminfo.txt file . See Filename for more information.

  2. Use the console option if you want to output the information to the console. See Console for more information.
    Note:
    This command is intended primarily as an aid for IBM support to assist in diagnosing problems, although users who are familiar with the concepts addressed by this information may also find it useful. If you use the console option, no special formatting of the output is performed to accommodate screen height or width. Therefore, the console output may be difficult to read due to length and line-wrapping. In this case, it is recommended that you use the filename option with the query systeminfo command to allow the output to be written to a file that can subsequently be submitted to IBM support.

Supported Clients

This command is valid for all UNIX clients.

Syntax

                     .-----------.
                     V           |
>>-Query SYSTEMInfo------ item---+--+----------+---------------><
                                    '- options-'
 
 

Parameters

item
Specifies one or more items from which you want to gather information and output the information to the file name that you specify with the filename option or to the console.
options

Table 83. Query Systeminfo command: Related options

Option Where to use Page
console Command line only. Console
filename Command line only. Filename

Examples

Task
Gather and store the contents of the dsm.opt file and the Tivoli Storage Manager error log file in the tsminfo.txt file.

Command: query systeminfo dsmoptfile errorlog -filename=tsminfo.txt

Query WAS

Authorized User

Use the query was command to display backups of the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server that match the node name and type of the WAS group backup that you specify.

Use the wastype option to specify whether to query the Network Deployment Manager (ND), Application Server (APP), or both (ANY), that are associated with the node name of the instance of WAS that you want to query. The default is ANY. You can also set the wastype option to LOCAL to query all the instances of the Application server and Network Deployment Manager on your local machine. See Wastype for more information.

Supported Clients

This command is valid for AIX, Solaris, and Linux86 clients.

Syntax

>>-Query WAs--+----------+-- --nodename------------------------><
              '- options-'
 
 

Parameters

options

Table 84. Query WAS command: Related options

Option Where to use Page
fromnode Command line only. Fromnode
fromowner Command line only Fromowner
inactive Command line only. Inactive
pitdate Command line only. Pitdate
pittime Command line only. Pittime
showmembers Command line only. Showmembers
wastype Command line only. Wastype
nodename
Specifies the node name of the group that you want to query. If you do not specify a node name, Tivoli Storage Manager queries all WAS backups.

Examples

Task
Query all WAS backups (Network Deployment Manager and Application Server) on the Tivoli Storage Manager server.

Command: query was -ina -wastype=any

Task
Query the group backups of the Network Deployment Manager associated with the node name wasnode. Use the showmembers option to display a list of group members from which you can select one or more to query.

Command: query was wasnode -showmembers

Restart Restore

The restart restore command displays a list of your restartable restore sessions in the server database. You can only restart one restartable restore session at a time. Run the restart restore command again to restart additional restores.

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

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

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-RESTArt Restore---------------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Restart a restore.

Command: restart restore

Restore

The restore command obtains copies of backup versions of your files from a Tivoli Storage Manager server. To restore files, specify the directories or selected files, or select the files from a list. Restore files to the directory from which you backed them up or to a different directory. Tivoli Storage Manager uses the preservepath option with the subtree value as the default for restoring files. For more information, see Preservepath.

See File system and ACL support for supported file systems and ACL support.

Note:
On UNIX systems when a symbolic link is created its modification time is set to the current system time and cannot be changed. So, when restoring a symbolic link its modification date and time is set to the date and time of the restore, not to the date and time the link had when it was backed up. As a result, Tivoli Storage Manager will back up the symbolic link during the next incremental backup because its modification time changed since the last backup.

If you set the subdir option to yes when restoring a specific path and file, Tivoli Storage Manager recursively restores all subdirectories under that path, and any instances of the specified file that exist under any of those subdirectories.

When you restore an entire directory or directory tree, and you do not specify the inactive, latest, pick, todate, and fromdate options on the restore command, Tivoli Storage Manager tracks which objects are 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. Further backups of the file system cannot be performed unless the restartable restore completes using the restart restore command or is cancelled using the cancel restore command.

Supported Clients

This command is valid for all UNIX clients.

Syntax

            .- FILE-.
>>-REStore--+-------+--+----------+--+- sourcefilespec---+------>
                       '- options-'  '- "sourcefilespec"-'
 
>--+----------------------+------------------------------------><
   '- destinationfilespec-'
 
 

Parameters

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

Table 85. Restore command: Related options

Option Where to use Page
dateformat Client user options file (dsm.opt) or command line. Dateformat
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only. Filesonly
followsymbolic Client user options file (dsm.opt) or command line. Followsymbolic
fromdate Command line only. Fromdate
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
fromtime Command line only. Fromtime
ifnewer Command line only. Ifnewer
inactive Command line only. Inactive
latest Command line only. Latest
numberformat Client user options file (dsm.opt) or command line. Numberformat
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime
preservepath Command line only. Preservepath
replace Client user options file (dsm.opt) or command line. Replace
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
timeformat Client user options file (dsm.opt) or command line. Timeformat
todate Command line only. Todate
totime Command line only. Totime
sourcefilespec
Specifies the path and file name in storage that you want to restore. Use wildcard characters to specify a group of files or all the files in a directory.
destinationfilespec
Specifies the path and file name where you want to place the restored files. If you do not specify a destination, Tivoli Storage Manager restores the files to the original source path.
Note:
If you do not specify a destination, Tivoli Storage Manager determines whether the original file system can be reached. If the original file system cannot be reached, Tivoli Storage Manager will not restore the file. This failure can also occur if you remove the virtualmountpoint option from the dsm.sys file. In this case, you can specify a different destination or restore the original virtualmountpoint option to the dsm.sys file, restart the client, and retry the command.

Examples

Task
Restore a single file named budget in the /Users/user1/Documents directory.

Command: restore /home/devel/projecta/budget

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

Command: restore file budget

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

Command: restore "/home/devel/projecta/*.c"

Task
Restore files in the /user/project directory. Use the pick and inactive options to select active and inactive backup versions.

Command: restore "/user/project/*" -pick -inactive

Task
Restore all files from the /home/devel/projecta directory that end with the character .c to the /home/newdevel/projectn/projecta directory. If the projectn or the projectn/projecta directory does not exist, it is created.

Command: restore "/home/devel/projecta/*.c" /home/newdevel/projectn/

Task
Restore all files in the /home/mydir directory to their state as of 1:00 PM on August 17, 2002.

Command: restore -pitd=8/17/2002 -pitt=13:00:00 /home/mydir/

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

Command: res /home/myid/*

Task
Restore files specified in the filelist to a different location.

Command: res -filelist=/home/avi/restorelist.txt /home/NewRestoreLocation/

Restore Backupset

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

Use the location option with the restore backupset command to specify where Tivoli Storage Manager searches for a backup set during the restore operation. See Location for more information.

If you are restoring a file space from a backup set to a system that did not perform the original backup, you may need to:

dsmc restore backupset backupsetname {/fsname}/* /destfs/ -subdir=yes

You can restore a group from a backup set with the following considerations:

Considerations:

Restoring backup sets in a SAN environment

You can restore backup sets in a storage area network (SAN) in the following ways:

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-REStore BACKUPSET--+---------+--+- backupsetname-+----------->
                      '-options-'  '- filename------'
 
>--+- sourcefilespec---+--+----------------------+-------------><
   '- "sourcefilespec"-'  '- destinationfilespec-'
 
 

Parameters

options

Table 86. Restore Backupset command: Related options

Option Where to use Page
dirsonly Command line only. Dirsonly
filesonly Command line only. Filesonly
ifnewer Command line only. Ifnewer
location Command line only. Location
preservepath Command line only. Preservepath
quiet Client user options file (dsm.opt) or command line. Quiet
replace Client user options file (dsm.opt) or command line. Replace
subdir Client user options file (dsm.opt) or command line. Subdir
backupsetname
Specifies the name of the backup set on the server from which to perform a restore operation. You cannot use wildcard characters to specify the backup set name. Tivoli Storage Manager restores the backup set from the server via LAN. If the backup set contains files from several owners, the backup set itself will be owned by root, and non-root users will not see the backup set. In this case, non-root users can restore their files by obtaining the backup set name from the Tivoli Storage Manager administrator.
filename
Specifies the name of a local file or device from which to perform a restore operation.
sourcefilespec
Specifies the source path which can be a portion of the backup set. The default is to restore the entire backup set.
destinationfilespec
Specifies the destination path for the restored files. If you do not specify a sourcefilespec, you cannot specify a destinationfilespec. If you do not specify a destination, Tivoli Storage Manager restores the files to the original source path. If you are restoring more than one file, you must end the specification with a directory delimiter (/), otherwise, Tivoli Storage Manager assumes the last name is a file name and reports an error. If you are restoring a single file, you can optionally end the specification with a file name if you want to give the restored file a new name.

Examples

Task
Restore a backup set called mybackupsetname from the server.

Command: dsmc restore backupset mybackupsetname -loc=server

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

Command: dsmc restore backupset "/home/budget/backupsetfile.name" -loc=file

Task
Restore a backup set from the /dev/rmt0 device.

Command: dsmc restore backupset "/dev/rmt0" -loc=tape

Task
Restore a single file named budget.dev from the /dev/rmt0 device, to the original source path.

Command: dsmc restore backupset /dev/rmt0 "/home/jones/budget.dev" -loc=tape

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

Command: dsmc restore backupset /dev/rmt0 "/home/budget/*.txt" -loc=tape

Task
Restore the backup set bset01.001 from the Tivoli Storage Manager server.

Command: dsmc restore backupset bset01.001 -loc=server

Task
Restore a group from the backup set mybackupset on the Tivoli Storage Manager server to the /home/devel/projectb directory.

Command:restore backupset mybackupset /virtfs/ /home/devel/projectb/ -loc=server -subdir=yes

Task
Restore a group from the local backup set mybackupset to the /home/devel/projectb/ directory.

Command:restore backupset mybackupset {/virtfs}/ /home/devel/projectb/ -loc=server -subdir=yes

Task
Restore the backup set contained in local file "/home/jones/bset01.file".

Command: dsmc restore backupset "/home/jones/bset01.file" -loc=file

Restore Group

Authorized User

Use the restore group command to restore specific members or all members of a group backup.

Notes:

  1. Use the pick option to display a list of groups from which you can select one group to restore.

  2. Use the showmembers option with the pick option to display and restore one or more members of a group. In this case, you first select the group from which you want to restore specific members, then you select one or more group members to restore.

  3. You can restore a group from a backup set. See Restore Backupset for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-restore group-+----------+--- sourcefilespec---+----------------------+-><
                 '- options-'                     '- destinationfilespec-'
 
 

Parameters

options

Table 87. Restore Group command: Related options

Option Where to use Page
followsymbolic Client user options file (dsm.opt) or command line. Followsymbolic
fromdate Command line only. Fromdate
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
fromtime Command line only. Fromtime
ifnewer Command line only. Ifnewer
inactive Command line only. Inactive
latest Command line only. Latest
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime
replace Client user options file (dsm.opt) or command line. Replace
showmembers Command line only. Showmembers
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
todate Command line only. Todate
totime Command line only. Totime
sourcefilespec
Specifies the virtual file space name and the group name on the server that you want to restore.
destinationfilespec
Specifies the path where you want to place the group or one or more group members. If you do not specify a destination, the client restores the files to their original location.

Examples

Task
Restore all members in the /virtfs/group1 group backup to their original location on the client machine.

Command:

restore group /virtfs/group1

Task
Display all groups within the /virtfs virtual file space. Use the showmembers option to display a list of group members from which you can select one or more to restore.

Command:

restore group /virtfs/* -pick -showmembers

Task
Display a list of groups within the /virtfs virtual file space from which you can select one or more groups to restore.

Command:

restore group /virtfs/* -pick

Restore Image

The restore image command restores a file system or raw volume 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.

You can use the verifyimage option with the restore image command to specify that you want to enable detection of bad sectors on the destination target volume. If bad sectors are detected on the target volume, Tivoli Storage Manager issues a warning message on the console and in the error log. See Verifyimage for more information.

If bad sectors are present on the target volume, you can use the imagetofile option with the restore image command to specify that you want to restore the source image to a file. Later, you can use a 'dd' utility (available on UNIX) or its equivalent to copy data from this file to a logical volume. See Imagetofile for more information.

Considerations:

Supported Clients

This command is valid for AIX, HP-UX, all Linux clients, and Solaris.

Syntax

>>-REStore Image--+----------+--+- sourcefilespec---+----------->
                  '- options-'  '- "sourcefilespec"-'
 
>--+----------------------+------------------------------------><
   '- destinationfilespec-'
 
 

Parameters

options

Table 88. Restore Image command: Related options

Option Where to use Page
dateformat Client user option file (dsm.opt) or command line. Dateformat
deletefiles Command line only. Deletefiles
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
imagetofile Command line only. Imagetofile
inactive Command line only. Inactive
incremental Command line only. Incremental
noprompt Command line only. Noprompt
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime
timeformat Client user option file (dsm.opt) or command line. Timeformat
verifyimage Command line only. Verifyimage
sourcefilespec
Specifies the name of a source image file system to be restored. Only a single source image may be specified; you cannot use wildcard characters.
destinationfilespec
Specifies the name of an existing mounted file system or the path and file name to which the source file system will be restored. The default is the original location of the file system.

The restore image command does not define or mount the destination file space. The destination volume must exist, must be large enough to hold the source, and if it contains a file system, must be mounted. If an image backup contains a file system, and you restore them to a different location, be aware of the following points:

Examples

Task
Restore the /home/test directory over which the logical volume is mounted, to its original location.

Command: dsmc rest image /home/test

Task
Restore the /home/proj directory over which the logical volume is mounted, 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.

Command: dsmc restore image /home/proj -incremental -deletefiles

Task
Restore the /usr file system to its original location. Use the verifyimage option to enable detection of bad sectors on the target volume.

Command: dsmc restore image /usr -verifyimage

Task
If bad sectors present on the target volume, use the imagetofile option to restore the /usr file system to the /home/usr.img file to avoid data corruption.

Command: dsmc restore image /usr /home/usr.img -imagetofile

Restore NAS

The restore nas command restores the image of a file system belonging to a Network Attached Storage (NAS) file server. The NAS file server performs the outboard data movement. A server process performs the restore.

If you used the toc option with the backup nas command or the include.fs.nas option to save Table of Contents (TOC) information for each file system backup, you can use the query toc server command to determine the contents of a file system backup in conjunction with the restore node server command to restore individual files or directory trees. You can also use the Web client to examine the entire file system tree and select files and directories to restore. If you do not save TOC information, you can still restore individual files or directory trees using the restore node server command, provided that you know the fully qualified name of each file or directory and the image in which that object was backed up.

Use the nasnodename option to specify the node name for the NAS file server. When using an interactive command line session with a non-administrative ID, Tivoli Storage Manager prompts for an administrator ID. The NAS node name identifies the NAS file server to the Tivoli Storage Manager server. You must register the NAS node name at the server. Place the nasnodename option in your client system options file (dsm.sys). The value in the client system options file is the default, but this value can be overridden on the command line. See Nasnodename for more information.

You can use the pick option to display a list of NAS images owned by the NAS node you specify. From this list you can select one or more images to restore. If you select multiple images to restore using the pick option, do not use the monitor option or you will serialize the restores. To start multiple restore processes simultaneously when restoring multiple images, do not specify monitor=yes.

Use the monitor option to specify whether you want to monitor a NAS file system image restore and display processing information on your screen. See Monitor.

Use the monitor process command to display a list of current restore processes for all NAS nodes for which your administrative user ID has authority. The authorized administrative user ID should have at least client owner authority over both the NAS node and the client workstation node they are using either from command line or from the web.

Use the cancel process command to stop NAS restore processing. For more information, see Cancel Process.

Regardless of client platform, NAS file system specifications use the forward slash (/) separator, as in this example: /vol/vol0.

Supported Clients

This command is valid for AIX and Solaris clients only.

Syntax

>>-REStore NAS--+----------+---- sourcefilespec----------------->
                '- options-'
 
>--+----------------------+------------------------------------><
   '- destinationfilespec-'
 
 

Parameters

options

Table 89. Restore NAS command: Related options

Option Where to use Page
dateformat Client user option file (dsm.opt) or command line. Dateformat
inactive Command line only. Inactive
mode Command line only. Mode
monitor Command line only. Monitor
nasnodename Client system options file (dsm.sys) or command line. Nasnodename
numberformat Client user option file (dsm.opt) or command line. Numberformat
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime
timeformat Client user option file (dsm.opt) or command line. Timeformat
sourcefilespec
Specifies the name of the NAS file system image you want to restore. This parameter is required unless you use the pick option to display a list of NAS images from which to choose. You cannot use wildcard characters when specifying the sourcefilespec.
destinationfilespec
Specifies the name of an existing mounted file system on the NAS device over which you want to restore the image. This parameter is optional. The default is the original location of the file system on the NAS device.

Examples

Task
Restore the NAS file system image /vol/vol1 to the /vol/vol2 file system on the NAS file server called nas1.

Command: restore nas -nasnodename=nas1 /vol/vol1 /vol/vol2

Task
Restore inactive NAS images.

Command: restore nas -nasnodename=nas2 -pick -inactive

Restore WAS

Root User

The restore was command specifies whether to restore the WebSphere Application Server (WAS) Network Deployment Manager (contains setup, application files, and configuration information) or the Application Server from the Tivoli Storage Manager server. The Application Server must be stopped for the restore to proceed.

You can also restore the Network Deployment Manager, the Application Server, and their instances simultaneously in separate sessions.

Use the wastype option to specify whether to restore the Network Deployment Manager (ND) or Application Server (APP) associated with the node name of the instance of WAS that you want to restore. The default is ND. See Wastype for more information.

WAS instance restore procedures

You can use the following procedure if your entire WebSphere installation is corrupted and it must be reinstalled, or you are installing WAS on a new machine:

  1. Install WAS on a machine with the same name and IP address as the machine on which the back up was performed. If you backed up a Network Deployment Manager on machine ebarton, the restore must also be performed on machine ebarton. Install the same type of WAS as the back up (either ND or APP). When installing, choose the same node and cell names as the backup. For example, if you backed up an ND with a cell name of EdCell and node name of EdNode then the new server must also use these names. Install to the same location in which the backup was performed. For example, if the backup was performed on an APP server installed at /home/WebSphere/App, the new server must also be installed at /home/WebSphere/App. After installation ensure that that the server is stopped.

    Notes:

    1. You can use the washome option in your client user options file (dsm.opt) to specify an override base install path for the Application Server. See Washome for more information.

    2. You can use the wasndhome option in your client user options file (dsm.opt) to specify an override base install path for the Network Deployment manager. See Wasndhome for more information.
  2. Restore the WAS node.
  3. Start the server.
  4. If the server is an ND, you can now attach any remote nodes. The ND and remote nodes will then synchronize.

Use the following procedure to restore to the same existing instance of a server. This procedure assumes that there is a preexisting WAS installation that is running and has a backup stored on the Tivoli Storage Manager server:

  1. Stop the WAS server to be restored.
  2. Restore the correct WAS node (same wastype and node name as the server that was stopped) to the same location.
  3. Start the server.

On an ND, the server will synchronize the restored data with the remote nodes since they are already connected.

Notes:

  1. For proper operation, the was node must be restored to same location and under same name.

  2. WARNING! Restoring data other than at the group level can corrupt your WAS installation. It is strongly recommended that you restore data at the Network Deployment Manager node or Application Server node level only. See IBM Tivoli Storage Manager for Application Servers 5.2: Data Protection for WebSphere Application Server Installation and User's Guide, SC32-9075, for more information.

Supported Clients

This command is valid for AIX, Solaris, and Linux86 clients.

Syntax

>>-REStore WAS--+----------+-- --nodename----------------------><
                '- options-'
 
 

Parameters

options

Table 90. Restore WAS command: Related options

Option Where to use Page
fromdate Command line only. Fromdate
fromnode Command line only. Fromnode
fromowner Command line only. Fromowner
fromtime Command line only. Fromtime
ifnewer Command line only. Ifnewer
inactive Command line only. Inactive
latest Command line only. Latest
pick Command line only. Pick
pitdate Command line only. Pitdate
pittime Command line only. Pittime
preservepath Command line only. Preservepath
replace Client user options file (dsm.opt) or command line. Replace
showmembers Command line only. Showmembers
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
todate Command line only. Todate
totime Command line only. Totime
wastype Command line only. Wastype
nodename
Specifies the node name of the instance of WAS that you want to restore.

Examples

Task
Restore the Network Deployment Manager associated with the node name wasnode. Use the pick option to restore a specific group backup. Use the showmembers option to display a list of group members from which you can select one or more to restore.

Command: restore was wasnode -showmembers -pick

Task
Restore the Network Deployment Manager wasnode to the original location.

Command: restore was wasnode -wastype=nd

Retrieve

The retrieve command obtains copies of archived files from the Tivoli Storage Manager server. You can retrieve specific files or entire directories.

Use the description option to specify the descriptions assigned to the files you want to retrieve.

Use the pick option to display a list of your archives from which you can select an archive to retrieve.

Retrieve the files to the same directory from which they were archived, or to a different directory. Tivoli Storage Manager uses the preservepath option with the subtree value as the default for restoring files. For more information, see Client options reference.

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-RETrieve--+----------+--+- sourcefilespec---+---------------->
             '- options-'  '- "sourcefilespec"-'
 
>--+----------------------+------------------------------------><
   '- destinationfilespec-'
 
 

Parameters

options

Table 91. Retrieve command: Related options

Option Where to use Page
dateformat Client user options file (dsm.opt) or command line. Dateformat
description Command line only. Description
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only Filesonly
followsymbolic Client user options file (dsm.opt) or command line. Followsymbolic
fromdate Command line only Fromdate
fromnode Command line only. Fromnode
fromowner Command line only Fromowner
fromtime Command line only Fromtime
ifnewer Command line only Ifnewer
pick Command line only. Pick
preservepath Command line only. Preservepath
replace Client user options file (dsm.opt) or command line. Replace
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line Tapeprompt
timeformat Client user options file (dsm.opt) or command line. Timeformat
todate Command line only. Todate
totime Command line only. Totime
sourcefilespec
Specifies the path and file name that you want to retrieve. Use wildcard characters to specify a group of files or all the files in a directory. See Maximum file size for operations for the maximum file size for retrieve processing.
destinationfilespec
Specifies the path and file name where you want to retrieve the files to. If you do not specify a destination, Tivoli Storage Manager restores the files to the original source path.
Note:
If you do not specify a destination, Tivoli Storage Manager determines whether the original file system can be reached. If the original file system cannot be reached, Tivoli Storage Manager will not restore the file. This failure can also occur if you remove the virtualmountpoint option from the dsm.sys file. In this case, you can specify a different destination or restore the original virtualmountpoint option to the dsm.sys file, restart the client, and retry the command.

Examples

Task
Retrieve a single file named budget.

Command: retrieve /home/devel/projecta/budget

Task
Retrieve all files with an extension of .c from the /home/devel/projecta directory.

Command: retrieve "/home/devel/projecta/*.c"

Task
Retrieve all files in the /home directory.

Command: retrieve /home/

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

Command: retrieve "/home/devel/projecta/*.c" /home/newdevel/projectn/

Task
Retrieve files in the /user/project directory. Use the pick option.

Command: ret "/user/project/*" -pick

Task
Retrieve all files archived from the /proj directory with the description "2002 survey results."

Command: retrieve "/proj/*" -desc="2002 survey results"

Task
Retrieve archived file /home/devel/budget with description "my budget" to the /dev/rmt1 tape drive.

Command:

mkfifo fifo
dd if=fifo of=/dev/rmt1&
dsmc retrieve -replace=yes -description="mybudget"
/home/devel/budget fifo

Schedule

Authorized User

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

Notes:

  1. The schedule command cannot be used if the managedservices option is set to schedule.

  2. This command is valid only on the initial command line. It is not valid in interactive mode.

If the schedmode option is set to polling, the client scheduler contacts the server for scheduled events at the hourly interval you specified with the queryschedperiod option in your client user options file (dsm.opt). If your administrator sets the queryschedperiod option for all nodes, that setting overrides the client 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 user options file (dsm.opt) or on the schedule command.

You can use the sessioninitiation option with the schedule command to control whether the server or client initiates sessions through a firewall. See Sessioninitiation for more information. See Configuring Tivoli Storage Manager client/server communication across a firewall for more information about Tivoli Storage Manager firewall support.

 After 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 workstation again, or turn off the workstation to end it. 

Note:
You cannot enter this command in interactive mode.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 92. Schedule command: Related options

Option Where to use Page
maxcmdretries Client system options file (dsm.sys) or command line. Maxcmdretries
password Client user options file (dsm.opt) or command line. Password
queryschedperiod Client system options file (dsm.sys) or command line. Queryschedperiod
retryperiod Client system options file (dsm.sys) or command line. Retryperiod
schedlogname Client system options file (dsm.sys) or command line. Schedlogname
schedmode Client system options file (dsm.sys) or command line. Schedmode
sessioninitiation Client system options file (dsm.sys) or command line. Sessioninitiation
tcpclientport Client system options file (dsm.sys) or command line. Tcpclientport

Examples

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

Command: tsm::once:/usr/lpp/adsm/bin/dsmc sched > /dev/null 2>&1 #TSM Scheduler

Task
Interactively start the scheduler and keep it running in the background.

Command: nohup dsmc sched 2> /dev/null &

When you run the schedule command, all messages regarding scheduled work are sent to the dsmsched.log file or to the file you specify with the schedlogname option in your client system options file (dsm.sys). If you do not specify a directory path with the file name in the schedlogname option, the dsmsched.log file will reside in the default installation directory.

Selective

The selective command backs up files that you specify. If these files become damaged or lost, you can replace them with backup versions from the server. When you run a selective backup, all the files are candidates for back up unless you exclude them from backup, or they do not meet management class requirements for serialization. See File system and ACL support for supported file systems and ACL support.

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

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

If you set the subdir option to yes when backing up a specific path and file, Tivoli Storage Manager recursively backs up all subdirectories under that path, and any instances of the specified file that exist under any of those subdirectories.

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

   selective "/dir1/dir2/bogus.txt"

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

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

|Removing operand limits

|You can use the removeoperandlimit option to specify that Tivoli |Storage Manager removes the 20-operand limit for UNIX-family platforms. |If you specify the removeoperandlimit option with the |selective command, the 20-operand limit is not enforced and is |restricted only by available resources or other operating system |limits. See Removeoperandlimit

Associating a local snapshot with a server file space

Use the snapshotroot option with the selective command in conjunction with a third-party application that provides a snapshot of a logical volume, to associate the data on the local snapshot with the real file space data that is stored on the Tivoli Storage Manager server. The snapshotroot option does not provide any facilities to take a volume snapshot, only to manage data created by a volume snapshot. See Snapshotroot for more information.

Supported Clients

This command is valid for all UNIX clients.

Syntax

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

Parameters

options

Table 93. Selective command: Related options

Option Where to use Page
changingretries Client system options file (dsm.sys) or command line. Changingretries
compressalways Client user options file (dsm.opt) or command line. Compressalways
compression Client system options file (dsm.sys) within a server stanza or command line. Compression
dirsonly Command line only. Dirsonly
filelist Command line only. Filelist
filesonly Command line only. Filesonly
preservelastaccessdate Client user options file (dsm.opt) or command line. Preservelastaccessdate
removeoperandlimit Command line only. Removeoperandlimit
snapshotroot Command line only. Snapshotroot
subdir Client user options file (dsm.opt) or command line. Subdir
tapeprompt Client user options file (dsm.opt) or command line. Tapeprompt
filespec
Specifies the path and file name that you want to back up. Use wildcard characters to select a group of files or all the files in a directory. When backing up a file system, specify the file system with a trailing slash; for example: /home/.

Examples

Task
Back up the proja file in the /home/devel directory.

Command: selective /home/devel/proja

Task
Back up all files in the /home/devel directory whose file names begin with proj.

Command: selective "/home/devel/proj*"

Task
Back up all files in the /home/devel directory whose file names begin with proj. Back up the single file named budget in the /user/home directory.

Command: selective "/home/devel/proj*" /user/home/budget

Task
Back up the /home file system.

Command: selective /home/ -subdir=yes

Task
Assuming that you initiated a snapshot of the /usr file system and mounted the snapshot as /snapshot/day1, run a selective backup of the /usr/dir1/sub1 directory tree from the the local snapshot and manage it on the Tivoli Storage Manager server under the file space name /usr.

Command: dsmc sel "/usr/dir1/sub1/*" -subdir=yes -snapshotroot=/snapshot/day1

Set Access

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 in a directory. When you give access to another user, that user can restore or retrieve your objects. Specify in the command whether you are giving access to archives or backups.

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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-SET Access--+- Archive-+--+- filespec-+-- node--+-------+---><
               '- Backup--'  '-image-fs--'         '- user-'
 
 

Parameters

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

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

To specify all files in a named directory, enter /home/mine/proj1/* on the command line.

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

Attention: Use of the form /*/* alone will not give access to objects in the named directory; only those in directories below the named directory will be accessible.

The rules are essentially the same when considering the root directory. Enter /* on one set access command and /*/* on another if you want another user to have access to all files and directories in and below the root directory. The first /* gives access to all directories and all files in the root directory. The second /* allows access to all directories and files below the root directory.

For example:

To allow access to all files in the /home/sub1/sub2 directory, enter:

  set access backup /home/sub1/sub2/* * *

To allow access to only those files in the /home directory, enter:

  set access backup /home/* * *

To allow access to all files in all directories in and below the /home directory, enter:

  set access backup /home/* * *
  set access backup /home/*/* * *
image-fs
The name of the image file system to be shared. This may be specified as an asterisk (*) to allow access to all images owned by the user granting access.
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.
user
This is an optional parameter that restricts access to the named user at the specified node.

Examples

Task
Give the user at node_2 authority to restore the budget file from the /home/user directory.

Command: set access backup /home/user/budget node_2

Task
Give node_3 authority to retrieve all files in the /home/devel/proja directory whose file names end with .c.

Command: set access archive "/home/devel/proja/*.c" node_3

Task
Give node_3 the authority to retrieve all files in the /home/devel/proja directory.

Command: set ac archive /home/devel/proja/ node_3

Task
Give all nodes whose names end with bldgb the authority to restore all backup versions from directories with a file space name of project.

Command: set ac b "{project}/*" "*bldgb"

Task
Give user serena at node_5 authority to restore all images of the file space mounted on directory /home/devel/proja.

Command: set acc backup "home/devel/proja/*/*" node_5 serena

Set Password

Authorized User

The set password command changes the Tivoli Storage Manager password for your workstation. If you omit the old and new passwords when you enter the set password command, you are prompted once for the old password and twice for the new password.

A password is not case-sensitive, and it can be as many as 63 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

Supported Clients

This command is valid for all UNIX clients.

Syntax

>>-SET Password--+--------------+------------------------------><
                 '- oldpw newpw-'
 
 

Parameters

oldpw
Specifies the current password for your workstation.
newpw
Specifies the new password for your workstation.

Examples

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

Task
Change your password from osecret to nsecret.

Command: set password osecret nsecret

|Set Waspassword

| | | | | |

|Root User

|If WAS security is enabled, user name and password validation for Data |Protection for WebSphere Application Server is required. If you do not |set the WAS password for the security, the backup will failover to an offline |backup. It is recommended to set the was security password to perform |consistent backups. Use the set waspassword command to set |the user name and password for each installation of WAS on your |machine. You only need to perform this task once, unless you change |your WAS user name or password. You can only perform this task on the |Tivoli Storage Manager command line.

|To determine if WAS security is enabled, enter the following command:

|  dsmc query was -wast=local

|Tivoli Storage Manager displays the WAS security status under the |Sec heading.

|Supported Clients

|This command is valid for AIX, Solaris, and Linux86 clients.

|Syntax

|>>-SET WASPassword--+------------------------------+-----------><
|                    '- WASNode-- WASType-- WASUser-'
| 
| 

|Parameters |

|WASNode
|Specifies the node name on which each installation of WAS is |installed. This parameter is required. If you do not specify a |value for this parameter, Tivoli Storage Manager prompts you. See Wasnode for more information.
|WASType
|Specifies the WAS Network Deployment Manager (ND) or Application Server |(APP). This parameter is required. If you do not specify a value |for this parameter, ND is the default value. See Wastype for more information.
|WASUser
|Specifies WAS user name. This parameter is required. If you |do not specify a value for this parameter, Tivoli Storage Manager prompts |you. See Wasuser for more information. |

|Examples |

|Task:
|Set the WebSphere user name and password for each installation of WAS on |your machine.

|Command: dsmc set waspassword -wasnode=wasnode |-wastype=app -wasuser=ed

|Tivoli Storage Manager prompts for the WebSphere password, as |follows:

|+--------------------------------------------------------------------------------+
||Please enter the WebSphere password:                                            |
|+--------------------------------------------------------------------------------+

|If you do not specify the wasnode or wasuser |options, Tivoli Storage Manager prompts for this information as follows:

|+--------------------------------------------------------------------------------+
||Please enter WebSphere node name:                                               |
||                                                                                |
||Please enter the WebSphere user name:                                           |
||                                                                                |
|+--------------------------------------------------------------------------------+
|


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