Tivoli Storage Manager for Windows Using the Backup-Archive Client


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. It also provides detailed information about each command. Table 27 shows a list of tasks related to entering commands.

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

Table 28. Commands

Command Description Page
archive Archives files from a workstation to Tivoli Storage Manager storage. Archive
backup activedirectory Backs up a Windows 2000 Active Directory database. Backup Activedirectory
backup certserverdb Backs up a Windows 2000 certificate server database. Backup Certserverdb
backup clusterdb Backs up the Microsoft cluster services cluster database on a Windows 2000 Server. Backup Clusterdb
backup complusdb Backs up the Windows 2000 COM+ database. Backup Complusdb
backup eventlog Backs up Windows NT, 2000 event logs. Backup Eventlog
backup frs Backs up replicated file systems on Windows 2000. Backup FRS
backup nas Creates an image backup of one or more file systems belonging to an NAS file server. Backup NAS
backup registry Backs up the Windows registry. Backup Registry
backup rsm Backs up the removable storage manager database on a Windows 2000 Server. Backup RSM
backup sysfiles Backs up Windows 2000 system and boot files. Backup Sysfiles
backup systemobject Backs up all valid Windows NT, 2000 system objects. Backup Systemobject
backup sysvol Backs up the Windows 2000 Server system volume. Backup Sysvol
cancel process Displays a list of current NAS backup and restore processes and permits you to select one process to cancel. Cancel Process
cancel restore Displays a list of restartable restore sessions and permits you to select one to cancel. Cancel Restore
delete access Revokes authorization for a user to restore or retrieve files. Delete Access
delete archive Deletes archived files from Tivoli Storage Manager storage. Delete Archive
delete filespace Deletes file spaces in Tivoli Storage Manager storage. Delete Filespace
expire Inactivates backup objects you specify. Expire
help Displays online command help. Help
incremental Backs up new and changed files. Incremental
loop Starts an interactive command session. Loop
macro Executes commands within a macro file you specify. Macro
monitor process Displays a list of current NAS backup and restore processes. You can then select one process to monitor. Monitor Process
query access Displays a list of current authorization rules. Query Access
query activedirectory Displays information about the active backup of the Active Directory system object. Query Activedirectory
query archive Displays a list of archived files. Query Archive
query backup Displays a list of backup versions. Query Backup
query backupset Queries a backup set from the server or a local file. Query Backupset
query certserverdb Displays information about the active backup of the certificate server database system object. Query Certserverdb
query clusterdb Displays information about the active backup of the Microsoft Cluster Services cluster database system object. Query Clusterdb
query complusdb Displays information about the active backup of the COM+ database system object. Query Complusdb
query eventlog Displays information about the active backup of the Windows 2000 event log system object. Query Eventlog
query filespace Displays a list of file spaces in Tivoli Storage Manager storage. Query Filespace
query frs Displays information about the active backup of the File Replication Services (FRS) system object. Query FRS
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 a particular administrative user ID has authority to perform operations. 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. Query Node
query registry Displays information about the active backup of the Windows 2000 registry system object. Query Registry
query restore Displays a list of your restartable restore sessions in the server database. Query Restore
query rsm Displays information about the active backup of the Removable Storage Manager (RSM) database system object. Query RSM
query schedule Displays information about scheduled events. Query Schedule
query session Displays information about the current session. Query Session
query sysfiles Displays information about the active backup of the Windows 2000 system and boot files system object. Query Sysfiles
query systemobject Displays information about the active backup of specific Windows 2000 system objects. Query Systemobject
query sysvol Displays information about the active backup of the Windows 2000 system volume system object. Query Sysvol
restart restore Displays a list of restartable restore sessions and permits you to select one to restart. Restart Restore
restore Restores backup versions from Tivoli Storage Manager storage. Restore
restore activedirectory Restores a Windows 2000 Server Active Directory database and associated logs. Restore Activedirectory
restore backupset Restores a backup set from the server or a local file. Restore Backupset
restore certserverdb Restores a Windows 2000 certificate server database. Restore Certserverdb
restore clusterdb Restores the Microsoft Cluster Services cluster database on a Windows 2000 Server. Restore Clusterdb
restore complusdb Restores a Windows 2000 COM+ database. Restore Complusdb
restore eventlog Restores the active Windows NT, 2000 event logs. Restore Eventlog
restore frs Restores a replicated file system on a Windows 2000 Server. Restore FRS
restore nas Restores the image of a file system belonging to an NAS file server. Restore NAS
restore registry Restores the Windows registry. Restore Registry
restore rsm Restores RSM database files on a Windows 2000 Server. Restore RSM
restore sysfiles Restores Windows 2000 system and boot files. Restore Sysfiles
restore systemobject Restores valid active Windows 2000 system objects stored on the server. Restore Systemobject
restore sysvol Restores the a Windows 2000 system volume. Restore Sysvol
retrieve Retrieves archived files from Tivoli Storage Manager storage. Retrieve
schedule Starts the client scheduler on the workstation. Schedule
selective Backs up selected files. Selective
set access Authorizes another user to access your backup versions or archive copies. Set Access
set password Changes the Tivoli Storage Manager password for your workstation. Set Password

Starting and Ending a Client Command Session

You can start or end a client command session in either batch mode or interactive mode. Use batch mode when you want to enter a single client command. Tivoli Storage Manager processes the command and returns to the 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. For example, to process the incremental command in batch mode, you would enter:

   dsmc incremental

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

You can also enter your password using the password option with a command, but your password 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.

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

Process Commands in Interactive Mode

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

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

   dsmc loop -password=secret

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


Entering Client Commands

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

The sections that follow describe each of these components.

Command Name

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

   query schedule
   q sc
   q sched
   query sc

Options

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

Parameters

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

   dsmc archive c:\project\budget.fin

Some commands have optional parameters. If you do not enter a value 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 c:\project\budget.fin to c:\newproj\newbudg.fin, you would enter:

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

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

File Specification Syntax

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

Maximum File Size for Operations

Table 29 specifies the maximum file sizes for backup, restore, archive, and retrieve operations.

Table 29. Maximum File Size for Backup, Restore, Archive, and Retrieve

Platform Max File Size (in bytes)
(FAT16) 2,147,483,647 (2GB)
(FAT32) 4,294,967,295 (4GB)
(NTFS) 17,592,185,978,880 (16TB-64K)

Remembering Previous Commands

If you specify the editor=yes option 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 specify the editor=no option, 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 30 lists other functions you can perform when you recall commands.

Table 30. 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 eight spaces to the right. Tab right
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
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, drives, or directories. Use wildcard characters when you want to specify multiple files with similar names in one command. Without wildcard characters, you must repeat the command for each file. Valid wildcard characters that you can use include:

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

Table 31 shows examples of each wildcard.

Table 31. Wildcard Characters

Pattern Matches Does Not Match
Asterisk (*)

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

ab? abc ab, abab, abzzz
ab?rs abfrs abrs, abllrs
ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs
ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs

Entering Commands

Follow the general rules below when you enter commands:


Client Commands Reference

The following sections contain detailed information about each of the Tivoli Storage Manager commands. These commands are arranged in alphabetical order. 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. Retrieve the archived files to your workstation whenever you need them again.

Migrating to Unicode-Enabled File Spaces

Please see Autofsrename for information about using the Unicode-enabled client.

Syntax

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

Parameters

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

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

filespec
Specifies path and name of the file you want to archive. You can use wildcards to specify groups of files or all the files in a directory. You can also enter more than one file specification in a command. See "Maximum File Size for Operations" for the maximum file size for archive processing.

Examples

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

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

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

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

Task
Archive all files in the c: drive.

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

Task
Archive all files in the Microsoft DFS volume, MyDfsVolume. You must specify subdir=yes to archive all files in the volume.

Command: archive \\myserver\mydfsroot\mydfsvolume\*.*

Backup Activedirectory

The backup activedirectory command backs up an Active Directory database on Windows 2000 Server operating system running Active Directory Services. Tivoli Storage Manager backs up the database and associated transaction logs. Tivoli Storage Manager deletes the logs after the database back up.

For information on system objects that you must back up together, see "Backing Up System Objects".

Syntax

>>-BACKup ACTIVEDirectory--+----------+------------------------><
                           '- options-'
 
 

Parameters

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

Examples

Task
Back up the Active Directory on the local server.

Command: backup actived

Backup Certserverdb

The backup certserverdb command backs up a Windows 2000 certificate server database, specifically the server database of client x.509 certificates. The Certificate Server Database must be on-line to perform a backup. For information on system objects that you must back up together, see "Backing Up System Objects".

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-BACKup CERTServerdb--+----------+---------------------------><
                        '- options-'
 
 

Parameters

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

Examples

Task
Back up the certificate server database.

Command: back certs

Backup Clusterdb

The backup clusterdb command backs up a Windows 2000 Microsoft Cluster Services cluster database for the local cluster. For information on system objects that you must back up together, see "Backing Up System Objects".

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-BACKup CLUSTERDB--+----------+------------------------------><
                     '- options-'
 
 

Parameters

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

Examples

Task
Back up the Microsoft Cluster Services cluster database.

Command: back clusterdb

Backup Complusdb

The backup complusdb command backs up the Windows 2000 COM+ database. COM is a system component model that creates non-graphic entities without the need to rely on language features of the entity's particular class. COM+ is the integration of Microsoft Transaction Server (MTS) and Microsoft Message Queuing (MSMQ) with the core operating system.

For information on system objects that you must back up together, see "Backing Up System Objects".

This command is valid for Windows 2000 Server, Windows 2000 Professional operating systems.

Syntax

>>-BACKup COMPlusdb--+----------+------------------------------><
                     '- options-'
 
 

Parameters

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

Examples

Task
Back up the COM+ database.

Command: back comp

Backup Eventlog

The backup eventlog command backs up the Windows NT and Windows 2000 event logs. For Windows NT, you can back up one or a combination of these logs: application, security, system.

For Windows 2000, this command backs up all event logs available to the operating system. The back up of the Windows 2000 event log will determine which logs will process by enumerating the sub-keys of registry key:

- HKLM\SYSTEM\CurrentControlSet\Services\Eventlog

This ensures that all Windows 2000 event logs will process.

Tivoli Storage Manager saves the log copies in the adsm.sys\eventlog directory under root directory of the system drive before sending them to the server for backup.

Syntax

For Windows 2000

>>-BACKup Eventlog---------------------------------------------><
 
 

For Windows NT

                        .-ENTIRE-.
>>-BACKup Eventlog--+- -+--------+----------+--+----------+----><
                    '- LOG-+- APPLICATION-+-'  '- options-'
                           +- SECURITY----+
                           '- SYSTEM------'
 
 

Parameters

Note:
For Windows 2000 there are no parameters.

The following parameters are for Windows NT.

ENTIRE
Backs up the application, security and system logs.

LOG
Backs up one of the following event logs:

APPLICATION
Backs up the application event log.

SECURITY
Backs up the security event log.

SYSTEM
Backs up the system event log.

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

Examples

Task
Back up the entire event log.

Command: back event entire

Task
Back up the security event log.

Command: back event log security

Backup FRS

The backup frs command backs up the File Replication Services (FRS) data on a Windows 2000 Server operating system. FRS maintains a list of replicated files; Tivoli Storage Manager backs up the files that display in this list.

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-BACKup FRs--+----------+------------------------------------><
               '- options-'
 
 

Parameters

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

Examples

Task
Back up replicated file systems.

Command: back frs

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 options file dsm.opt. The value in the client options file is the default, but can be overridden on the command line. See Nasnodename for more information.

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 since 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 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 back up processing. For more information, see Cancel Process.

The backup nas command is valid for Windows NT and Windows 2000 clients only.

A NAS file system specification uses the following conventions:

Syntax

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

Parameters

options
You can use these common options with the backup nas command: monitor, nasnodename, quiet, verbose. For more information, see Chapter 8, "Setting Common Options".

You can use the mode command line option with the backup nas command. For more information, see Chapter 9, "Using Options with Commands".

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 domain.nas=all-nas value is used 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

Backup Registry

The backup registry command backs up the Windows registry. The registry is a centralized database that contains information about hardware, applications, and operating system settings for each workstation on the network. Normally, Tivoli Storage Manager backs up the registry during incremental backups.

Use the backup registry command only if the backupregistry option is set at no, preventing back up of the registry. You may also use this command if you must back up the registry immediately.

Registry backups are copied to the adsm.sys directory under the root directory of the system drive. If you are using Windows 98 or Windows Me, the directory is adsm98.sys. The registry is then copied to the server. Tivoli Storage Manager will not back up the copied registry files in the adsm.sys directory if you exclude these files in your include-exclude list.

To back up all profiles in hkey_users, you can issue the command backup registry user curuser. The name of the profile will be the actual registry key with the following filename:

adsm.sys\registry\machine\users\userprofiledir\
S-1-5-21-8533442-1654749355-78804774-1152

In the above example, machine is the name of the workstation on which the profiles reside and userprofiledir is the user profile directory specified in the registry for that user.

This registry key also identifies the SID of the current user.

If the Web client service is run in the context of the local system account, Restore User Profile is not available. This happens because there is no user profile to restore on a local system account.

For information on system objects that must be backed up together, see "Backing Up System Objects".

Syntax

For Windows 2000

>>-BACKup REgistry---------------------------------------------><
 
 

For Windows NT

                        .-ENTIRE-.
>>-BACKup REgistry--+- -+--------+-----------+--+----------+---><
                    +- MACHINE-+- SAM------+-+  '- options-'
                    |          +- SECURITY-+ |
                    |          +- SOFTWARE-+ |
                    |          '- SYSTEM---' |
                    '- USER-+- CURUSER-+-----'
                            '- DEFAULT-'
 
 

For Windows 98, Me

                        .-ENTIRE-.
>>-BACKup REgistry--+- -+--------+-----------+--+----------+---><
                    +- MACHINE-+- CONFIG---+-+  '- options-'
                    |          +- ENUM-----+ |
                    |          +- HARDWARE-+ |
                    |          +- NETWORK--+ |
                    |          +- SECURITY-+ |
                    |          +- SOFTWARE-+ |
                    |          '- SYSTEM---' |
                    '- USER-+----------+-----'
                            '- DEFAULT-'
 
 

Parameters

Note:
For Windows 2000 there are no parameters. The backup registry command backs up the system registry hives listed in:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
Control\hivelist

The following parameters are for Windows 98, Me, and NT.

ENTIRE
Backs up all of the Machine and User hives listed below. This is the default.

MACHINE
Backs up one of the following machine root key hives (registry subkeys):

CONFIG
Valid for Windows 98 and Me only. Backs up the hive (hkey_local_machine\config subkey).

ENUM
Valid for Windows 98 and Me only. Backs up the hive (hkey_local_machine\enum subkey).

HARDWARE
Valid for Windows 98 and Me only. Backs up the hive (hkey_local_machine\hardware subkey).

NETWORK
Valid for Windows 98 and Me only. Backs up the hive (hkey_local_machine\network subkey).

SAM
Valid for Windows NT only. Backs up the Security Accounts Manager (SAM) hive (hkey_local_machine\sam subkey).

SECURITY
Backs up the security policy hive (hkey_local_machine\security subkey).

SOFTWARE
Backs up the local machine software configuration hive (hkey_local_machine\software subkey).

SYSTEM
Backs up the local machine system configuration hive (hkey_local_machine\system subkey).

USER
Backs up one of the following user root key hives (registry subkeys):

CURUSER
Valid for Windows NT only. Backs up the current (logged on) user profile.

DEFAULT
Backs up the default user profile hive (hkey_users\default subkey).

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

Examples

Task
Backup the entire registry.

Command: backup reg entire

Task
Backup the Security Accounts Manager (SAM).

Command: backup reg machine sam

Backup RSM

Removable Storage Manager (RSM) service runs on Windows NT Server and Windows 2000 Server operating systems. The backup rsm command backs up the RSM database. The backup copy is placed in \windows\system32\ntmsdata\export. Then the command performs a selective backup of the copy to the server. The RSM server continues to run during the backup process.

Note:
Although the backup rsm command backs up the RSM database, the command does not back up the data managed by Windows 2000 Remote Storage Service (RSS). To back up and restore offline data managed by RSS, you must use the Microsoft Backup Utility. Following are some recommendations for working with offline RSS-managed data:

Windows 2000 Servers (Server, Advanced Server and Datacenter Server) may allow many applications to share a bulk storage device. On these servers, RSM manages data on removable storage media that exists in a media pool. This data is accessible by media application and media management programs; the data can be shared and traced across applications. Tivoli Storage Manager servers support RSM by creating application pools for backup media. Tivoli Storage Manager clients support RSM recovery by creating a backup of the RSM database when running on a Windows 2000 Server.

Syntax

>>-BACKup RSm--+----------+------------------------------------><
               '- options-'
 
 

Parameters

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

Examples

Task
Perform a backup of the RSM database.

Command: back rsm

Backup Sysfiles

The backup sysfiles command backs up Windows 2000 system and boot files. System and boot files consist of the following:

These files are backed up as a single system object; individual files within this object are backed up as normal files.

For information on system objects that must be backed up together, see "Backing Up System Objects".

Syntax

>>-BACKup SYSFiles--+----------+-------------------------------><
                    '- options-'
 
 

Parameters

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

Examples

Task
Back up system and boot files.

Command: back sysf

Backup Systemobject

The backup systemobject command backs up all valid system objects. For Windows 2000, the following system objects are backed up:

For Windows NT, the registry and eventlog system objects are backed up.

Note:
Include-exclude statements do not affect system object processing. It is unnecessary to explicitly include the registry staging directory include c:\adsm.sys\...\* for back up, to ensure that the registry is backed up properly. If you accidently exclude a directory that is critical to a system object backup, the system object backup is not affected.

The restore systemobject command is not valid for Windows 98, Me, or NT. To restore the Windows 98, Me, or NT registry, use the restore registry command. To restore the Windows NT eventlog, use the restore eventlog command.

Syntax

>>-BACKup SYSTEMObject-----------------------------------------><
 
 

Parameters

There are no parameters for this command.

Examples

Task
Back up all valid system objects.

Command: backup systemobject

Backup Sysvol

The backup sysvol command backs up a Windows 2000 system volume. This is data that has been replicated from the Active Directory and is not part of the directory tree database. System volume data must be marked as such in the FRS set.

This system object is found only on a Windows 2000 Server functioning as a domain controller.

For information on system objects that must be backed up together, see "Backing Up System Objects".

Syntax

>>-BACKup SYSVol--+----------+---------------------------------><
                  '- options-'
 
 

Parameters

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

Examples

Task
Back up a system volume.

Command: back sysvol

Cancel Process

The cancel process command displays a list of current back up and restore processes for all NAS nodes. This command only displays those processes for which the administrative user has authority. From the list, the administrative user can select one process to cancel. Client owner privilege over a particular NAS node is sufficient authority to cancel the selected NAS process.

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

The cancel process command is valid for Windows NT and Windows 2000 clients only.

Syntax

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

Parameters

There are no parameters for this option.

Examples

Task
Cancel current NAS restore process number 2.

Command: cancel process

Cancel Restore

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

Use the cancel restore command when:

Syntax

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

Parameters

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

Examples

Task
Cancel a restore operation.

Command: cancel restore

Delete Access

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

Syntax

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

Parameters

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

Examples

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

Command: delete access

See the following screen example:

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

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

Delete Archive

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

Syntax

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

Parameters

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

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

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

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to delete. This is the name on the workstation drive from which the file was archived. You can specify UNC names; drive label names are only used for removable media.

Use the filespacename if the name has changed, or if you are deleting files archived from another node with drive labels that are different from yours. You must specify a mixed or lowercase NTFS file space name enclosed in quotes and braces. For example, {"NTFSDrive"}.

Single quotes or double quotes are valid in loop mode. For example, {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotes are valid. The single quotes requirement is a restriction of the operating system.

Examples

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

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

Task
Delete a file named budget.jan.

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

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

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

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

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

Delete Filespace

The delete filespace command deletes file spaces from server storage. 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 workstation drive from which you back up or archive files. The file space name is the same as the UNC name. Note that drive label names are only used for removable media. When you enter the delete filespace command, a list of your file spaces displays. From this list, select those file spaces 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 options file dsm.opt. The value in the client 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 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 3, "Backing Up and Restoring".

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

Syntax

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

Parameters

options
You can use these common options with the delete filespace command: scrollprompt, scrolllines, nasnodename. For more information, see Chapter 8, "Setting Common Options".

You can use the class command line option with the delete filespace command. For more information, see Class.

Examples

Task
Delete a file space.

Command: delete filespace

Task
Delete a file space. Use the dateformat and timeformat options to reformat the dates and times. These formats are in effect for the entire session unless you enter them again on a later command.

Command: del f -date=5 -time=4

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

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

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 the object is excluded by include-exclude 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.

Note:
Because the expire command changes the server's picture of the client file system without actually changing the client file system, the expire command is not allowed on files located on a file system monitored by the Tivoli Storage Manager journal service.

Syntax

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

Parameters

options
You can use these command line options with the expire command: pick and filelist. For more information about command line options, see Chapter 9, "Using Options with Commands".

Note: If the user specifies 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 c:\home\letter1.txt
 

Task
Inactivate all files in the admin\mydirdirectory.

Command:

expire c:\admin\mydir\*

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.

Syntax

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

Parameters

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

Examples

Task
Display a list of help choices.

Command: help

Incremental

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

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

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

Frequency
The number of days that must elapse between successive backups for the file. Use this attribute during a full incremental backup. For Windows NT, 2000: Do not use this attribute during a journal-based backup.

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

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

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

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

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

For Windows NT, 2000: If you are journaling a file system and the journal is valid, the full incremental backup reverts to a journal-based backup. See "Journal-Based Backup (Windows NT, 2000 only)" for more information. You can perform a full incremental backup without the journal by using the nojournal option. See Nojournal for more information.

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. 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 or the journal database (Windows NT, 2000) to determine the exact condition of your storage. Tivoli Storage Manager uses this information to:

Journal-Based Backup (Windows NT, 2000 only)

If the journal engine service is installed and running, then by default the incremental command performs a journal-based incremental backup on any journaled file systems. Tivoli Storage Manager does not use the journaling facility inherent in Windows NTFS 5 file systems or any other journaled file system.

The journal engine service records changes to an object or its attributes in a journal database. During a journal-based backup, the client obtains a list of files that are eligible for backup from the journal database. Performing backups on a regular basis maintains the size of the journal.

Journal-based backup can increase backup performance. With journal-based backup, the client does not scan the local file system or obtain information from the server to determine which files to process. Journal-based backup also reduces network traffic between the client and server.

Tivoli Storage Manager filters the list based on the current include-exclude list. Tivoli Storage Manager processes, expires, and updates the resulting files according to policy constraints, such as serialization. The management-class copy frequency attribute is ignored during journal-based backup.

The journal engine service excludes specific system files (pagefile, registry, etc.) from having changes recorded in the journal. Because changes to these files are not journaled, Tivoli Storage Manager does not back up these files. See the journal service configuration file tsmjbbd.ini located in the Tivoli Storage Manager installation directory for specific system files that are excluded.

To support journal-based backup, you must install the journaling engine service. Install this service by using the dsmcutil command or the GUI setup wizard. See Tivoli Storage Manager Installing the Clients, SH26-4119 for more information about using the dsmcutil command to install the journaling engine service.

If the file specification on the incremental command is a file space, Tivoli Storage Manager processes any journal entries for that file space. Tivoli Storage Manager processes directories and wildcarded file specifications in the same way. Tivoli Storage Manager uses the domain list if you do not specify a file specification.

When a user deletes a file with a long name, the Windows operating system may supply a short, or compressed, name to the journal engine service. After the object is deleted, the compressed name may be reused and the deletion notice may no longer identify a unique object. During a journaled incremental backup, the attempt to expire the file will fail because the compressed name is not known to the server. When this occurs, a record is placed in the journal indicating that the current directory is not exactly represented at the server. Use the incrthreshold option to specify what action is taken when this occurs. See Incrthreshold for more information.

Considerations

Under the following conditions, the journal database is considered invalid and the client reverts to the traditional full incremental backup:

Journal-based backup differs from the traditional full incremental backup in the following ways:

You can use the nojournal option with the incremental command to perform a traditional full incremental backup instead of the default journal-based backup. See Nojournal for more information.

Virtual Volume and Virtual Mount Point (Windows 2000 NTFS)

If you perform an incremental backup of a file space on which a volume is mounted, Tivoli Storage Manager does not traverse the mount junction and back up all mounted data. For example, if you have a mounted volume named c:\mount on file space c:, Tivoli Storage Manager backs up only the junction point, not the data under c:\mount.

To back up all data for a file system, including virtual volumes and virtual mount points, run an incremental backup on each virtual volume. You must also perform an incremental backup on the file system.

The exclude.dir option is not valid for a mounted virtual volume if the volume is backed up as a file space. Exclude.dir is valid for a mount point that is backed up.

Backing Up Microsoft DFS Root

If you perform an incremental backup of Microsoft DFS root with dfsbackupmntpnt=yes specified, Tivoli Storage Manager backs up only the junction points, not the subtree under the junctions.

If you want to traverse the DFS tree and back up the files and subdirectories of any junction it encounters, specify the dfsbackupmntpnt=no option.

This option has no effect if you are backing up individual junctions. The exclude.dir option behavior for DFS junctions is same as for mounted virtual volumes. For more information, see Dfsbackupmntpnt.

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. 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 use a partial incremental backup on weekdays and a full incremental backup on weekends to maintain current server storage of your workstation files.

If the incremental command is retried because of a communication failure or session loss, the transfer statistics will display the number of bytes 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.

Adaptive Subfile Backups

If you plan to perform a backup over a network device with limited bandwidth, such as a modem, you can reduce the network traffic by using the subfilebackup option. If you plan to use this option, ensure that you specify the subfilebackup, subfilecachepath and subfilecachesize options during the initial backup of your file. The options specify whether to perform an adaptive subfile backup along with the path and size of the data to be transferred. For information on these options, see Chapter 8, "Setting Common Options". For information about adaptive subfile backups, see "Performing a Backup with Limited Bandwidth".

Migrating to Unicode-Enabled File Spaces

Please see Autofsrename for information about using the Unicode-enabled client.

Windows 2000 Considerations

Tivoli Storage Manager backs up named streams on a file basis only. Backup of a named stream containing sparse file data is not supported. Tivoli Storage Manager will back up a sparse file as a regular file if the client compression is off. Enable file compression (compression=yes) when backing up sparse files to minimize network transaction time and to maximize server storage space.

Microsoft disk quotas do not affect the amount of data you can back up.

Syntax

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

Parameters

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

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

filespec
Specifies the path and file name that you want to back up. Use wildcards to select a group of files or all the files in a directory. You can also enter up to 20 file specifications in a command by separating the file specifications with a space. If a file specification is not specified, the default domain or the domain specified as an option is backed up. See "Maximum File Size for Operations" for the maximum file size for back up processing.

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

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

Examples

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

Command: Incremental

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

Command: i c: d: e:

Task
Run an incremental backup of the \home\ngai directory and its contents on the current drive.

Command: i \home\ngai\

Loop

The loop command starts an interactive command line session that is maintained until you enter quit. In an interactive command line session, it is unnecessary to precede each command name with dsmc and your password, if one is required. After you start an interactive session, most of the options you enter with other commands are in effect throughout the session, unless you enter them again using a different setting.

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

Some options cannot be used within 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 8, "Setting Common Options" for options that cannot be used in interactive mode.

Syntax

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

Parameters

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

Examples

Task
Start an interactive command line session.

Command: dsmc

Macro

The macro command 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 specified for the macro command.

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:
c:\devel\project\proja
c:\devel\project\projb
c:\devel\project\projc

Command: macro backabc.mac

where backabc.mac contains the following statements:

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

Monitor Process

The monitor process command displays a list of current backup and restore processes for all NAS nodes for which the administrative user has authority. The administrative user can then select one process to monitor. Client owner privilege over a particular NAS node is sufficient authority to monitor the selected NAS process.

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

The monitor process command is valid for Windows NT and Windows 2000 clients only.

Syntax

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

Parameters

There are no parameters for this command.

Examples

Task
Monitor a current NAS backup process.

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 User Access List on the graphical user interface (GUI) Utilities menu. The information includes:

Syntax

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

Parameters

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

Examples

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

Command: query access

Query Activedirectory

The query activedirectory command queries a Windows 2000 Server running Active Directory Services. The command displays information about the active backup of the Active Directory system object on the server.

Syntax

>>-Query ACTIVEDirectory--+----------+-------------------------><
                          '- options-'
 
 

Parameters

options
You can use these command line options with the query activedirectory command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Active Directory system object on the server.

Command: query actived

Query Archive

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

Syntax

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

Parameters

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

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

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

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to query. This is the name on the workstation drive from which the file was archived. The following example is valid for specifying a UNC name: {'\\machine\C$'}.

Use the filespacename if the name has changed or if you are querying files archived from another node with drive labels that are different from yours.

Note:
You must specify a mixed or lowercase NTFS filespacename enclosed in quotes and braces. For example, {"NTFSDrive"}. Single quotes or double quotes are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotes are valid. The single quotes requirement is a restriction of the operating system.

Examples

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

Command: q ar c:\proj\*

Task
Display a list of archived files from your c: drive with the description "January Ledgers."

Command: query archive c:\ -su=y -descr="January Ledgers"

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

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

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

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

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

Command: q ar {store}\proj\*

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

Command: q ar {docs}\*

Query Backup

The query backup command displays a list of backup versions of your files. File information includes the file specification, size, backup date, whether the file is active or inactive, and the management class asigned to the file. Only the first ten characters of the management class name appears.

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 options file dsm.opt. The value in the client 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, will not change the current query backup behavior. See Class for more information.

Syntax

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

Parameters

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

With the query backup command, you can use the following common options: subdir, scrolllines, nasnodename, scrollprompt. See Chapter 8, "Setting Common Options" for information about these common options.

filespec
Specifies the path and file name that you want to query. Use wildcard characters to specify a group of files or all the files in a directory. Do not use wild cards when you query NAS file system images with -class=nas option.
Note:
If you include filespacename, do not include a drive letter in the file specification. Drive label names are only used for removable media.

{filespacename}
Specifies the file space (enclosed in braces) on the server that contains the file you want to query. This is the drive label or UNC name on the workstation drive from which the file was backed up. The following example is valid for specifying a UNC name: {'\\machine\C$'}.

Use the filespacename if the name has changed, or if you want to query files backed up from another node with drive label names that are different from yours.

Note:
You must specify a mixed or lowercase NTFS file space name enclosed in quotes and braces. For example, {"NTFSDrive"}. Single quotes or double quotes are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotes are valid. The single quotes requirement is a restriction of the operating system.

Examples

Task
Query files from the abc file space proj directory.

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

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

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

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

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

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

Command: q b {docs}\*

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 server. See Location for information on how to specify supported tape devices. This command displays the backup set name, generation date, retention, and description.

Syntax

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

Parameters

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

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

backupsetname
This parameter is used when -location=server is in effect and specifies the name of the backup set on the server you want to query. Wildcards can be used to specify the backup set name. If backup set name is not specified, all backup sets display.

filename
This parameter is required when -location=file is in effect and specifies the file name on your local workstation that contains the backup set you want to query.

Examples

Task
Query a backup set on the server called mybackupsetname.

Command: query backupset mybackupsetname -loc=server

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

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

Query Certserverdb

The query certserverdb command displays information about the active backup of the Windows 2000 certificate server database system object on the Tivoli Storage Manager server.

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-Query CERTServerdb--+----------+----------------------------><
                       '- options-'
 
 

Parameters

options
You can use these command line options with the query certserverdb command: inactive, nasnodename, mode, monitor, password, pitdate, pittime. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the certificate server database system object on the Tivoli Storage Manager server.

Command: query certs

Query Clusterdb

The query clusterdb command displays information about the active backup of the Microsoft Cluster Services cluster database system object on the server.

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-Query CLUSTERDB--+----------+-------------------------------><
                    '- options-'
 
 

Parameters

options
You can use these command line options with the query clusterdb command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Microsoft Cluster Services cluster database system object on the server.

Command: query clusterdb

Query Complusdb

The query complusdb command displays information about the active backup of the COM+ database system object on the server.

This command is valid for Windows 2000 Server and Windows 2000 Professional operating systems.

Syntax

>>-Query COMPlusdb--+----------+-------------------------------><
                    '- options-'
 
 

Parameters

options
You can use these command line options with the query complusdb command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the COM+ database system object on the server.

Command: query complusdb

Query Eventlog

The query eventlog command displays information about the active backup of the event log system object on the server.

This command is valid on the Windows 2000 Server operating systems.

Syntax

>>-Query Eventlog--+----------+--------------------------------><
                   '- options-'
 
 

Parameters

options
You can use these command line options with the query eventlog command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Windows 2000 event log system object on the server.

Command: query eventlog

Query Filespace

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

For Windows NT and Windows 2000 clients: A Unicode file space name may not display correctly if the server is unable to display the Unicode name. In this case, use the file space identifier (fsID) to identify these file spaces on the server. Use the query filespace command with the detail option to determine the fsID of a file space. The fsID is also displayed in the file information dialog in the Windows and Web client GUIs.

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 options file dsm.opt. The value in the client 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 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.

Syntax

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

Parameters

options
You can use the fromnode and class command line options with the query filespace command. For more information, see Fromnode and Class.

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

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
Query a file space from the nas2 NAS file server.

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

Query FRS

The query frs command displays information about the active backup of the File Replication Services (FRS) system object on the server.

This command is valid for Windows 2000 Server operating systems.

Syntax

>>-Query FRS--+----------+-------------------------------------><
              '- options-'
 
 

Parameters

options
You can use these command line options with the query frs command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the File Replication Services (FRS) system object on the server.

Command: query frs

Query Inclexcl

The query inclexcl command displays a list of include-exclude statements in the order in which they will process 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.

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 options file dsm.opt. If you do not assign a management class to a file, Tivoli Storage Manager uses the default management class.

Syntax

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

Parameters

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

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

Examples

Task
Display available management classes.

Command: query mgmtclass

Query 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 both the NAS node and 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.

Syntax

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

Parameters

options
You can use the type command line option with the query node command. See Type for more information.

Use the scrolllines and scrollprompt common options with the query node command. For more information, see Chapter 8, "Setting Common Options".

Examples

Task
Display all NAS nodes.

Command: query node -type=nas

Query Registry

The query registry command displays information about the active backup of a Windows 2000 registry system object on the server. The registry is a centralized database that contains information about hardware, applications, and operating system settings.

Syntax

>>-Query REgistry--+----------+--------------------------------><
                   '- options-'
 
 

Parameters

options
You can use these command line options with the query registry command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Windows 2000 registry system object on the server.

Command: query re

Query Restore

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

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

Syntax

>>-Query Restore--+----------+---------------------------------><
                  '- options-'
 
 

Parameters

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

Examples

Task
The following example displays the output when you use query restore:
Sess      Restore        Elapsed    Node Name    file space
Number    State          Minutes                 Name
------    -----------    -------    ---------    ---------
     2    active               5    byufan       EDISK
    -1    restartable        107    crockett     OS2

Query RSM

The query rsm command displays information about the active backup of the Removable Storage Manager (RSM) database system object on the server. The query rsm command indicates whether there is previously backed up RSM data to be restored.

This command is valid for the Windows 2000 Server operating systems.

Syntax

>>-Query RSM--+----------+-------------------------------------><
              '- options-'
 
 

Parameters

options
You can use these command line options with the query rsm command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Removable Storage Manager (RSM) database system object on the server.

Command: query rsm

Query Schedule

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

Syntax

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

Parameters

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

Examples

Task
Display your scheduled events.

Command: query schedule

Query Session

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

Syntax

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

Parameters

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

Examples

Task
Display your session information.

Command: query session

Query Sysfiles

The query sysfiles command displays information about the active backup of the Windows 2000 system object and boot files on the server. System and boot files consist of the following:

Syntax

>>-Query SYSFiles--+----------+--------------------------------><
                   '- options-'
 
 

Parameters

options
You can use these command line options with the query sysfiles command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Windows 2000 system and boot files system object on the server.

Command: query sysfiles

Query Systemobject

The query systemobject command displays information about the active backup of the following valid Windows 2000 system objects on the server:

Syntax

>>-Query SYSTEMObject--+----------+----------------------------><
                       '- options-'
 
 

Parameters

options
You can use these command line options with the query systemobject command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of all the system objects on the server.

Command: query systemo

Query Sysvol

The query sysvol command displays information about the active backup of the Windows volume system object on the server.

This system object is found only on a Windows 2000 Server functioning as a domain controller.

Syntax

>>-Query SYSVol--+----------+----------------------------------><
                 '- options-'
 
 

Parameters

options
You can use these command line options with the query sysvol command: inactive, pitdate, pittime. For more information, see Chapter 9, "Using Options with Commands".

Examples

Task
Display information about the active backup of the Windows 2000 system volume system object on the server.

Command: query sysv

Restart Restore

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

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

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

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

Syntax

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

Parameters

options

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

Examples

Task
Restart a restore.

Command: restart restore

Restore

The restore command obtains copies of backup versions of your files from a 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.

Note:
An error will occur if you attempt to restore a file whose name is the same as an existing file's short name. For example, if you attempt to restore a file you specifically named ABCDEF~1.DOC into the same directory where a file named abcdefghijk.doc exists, the restore will fail because the Windows operating system equates the file named abcdefghijk.doc to a short name of ABCDEF~1.DOC. The restore function treats this as a duplicate file.

If this error should occur, perform any of the following actions to correct it:

See the Microsoft Knowledge Base article Q121007, How to Disable the 8.3 Name Creation on NTFS Partitions, for more information.

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

Virtual Volume and Virtual Mount Point (Windows 2000 NTFS)

When restoring all file system data, including virtual volumes and mount points, restore the virtual mount point before restoring any data inside the virtual volume. Otherwise, all data in the virtual volume is restored to the parent directory of the virtual volume.

Attention: When the client is instructed to restore the files on the mount volume, it first determines whether a mount point exists for the specified mount volume. If a mount volume exists in the specified location, the following error message appears:

  ANS5179E Restoring a volume mount point to a non-empty directory
and Tivoli Storage Manager will not overwrite the mount volume to avoid potential data loss. To restore the mount volume, first delete the mount point associated with it.

You can restore a virtual mount point to a network drive; however, the restored mount point indicates the virtual volume in the network workstation, not the local client virtual volume. For best results, only restore a virtual mount point to a network drive when the network workstation already has the identical virtual mount point defined. To restore the mount volume, first delete the mount point associated with it.

To restore a mount point using the GUI or Web client, you must restore the root of the drive where the mount point is defined. If you select the mount point itself, Tivoli Storage Manager restores all mounted data, but not the mount junction.

If you use the command line client to restore mounted data, back up the mount point in addition to backing up the mounted data. If the mount point is not backed up, you cannot use the command line client to restore any data inside the mounted volume. For best results, back up at least one mount point for any virtual volume you want to restore.

Restoring Microsoft DFS Junctions

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

Restoring Active Files

When restoring active and inactive versions of the same file using the replace option, only the most recently restored file is replaced.

Performing Restores with version 3.1.0.5 or Later

If you are using client version 3.1.0.5 or later, the workstation name is part of the file name. Therefore, if you back up files on one workstation and you want to restore them to another workstation, you must specify a destination. This is true even if you are restoring to the same physical workstation, but the workstation has a new name. For example, to restore the c:\doc\h2.doc file to its original directory on the workstation, named star, you would enter:

   dsmc restore c:\doc\h2.doc \\star\c$\

To restore the file to star which has now been renamed meteor, you would enter:

   dsmc restore c:\doc\h2.doc \\meteor\c$\

You could also enter:

   dsmc restore c:\doc\h2.doc \\star\c$\

This example is valid because the workstation name is not included in the specification, so the local workstation is assumed (meteor, in this case).

Restoring from File Spaces that are not Unicode Enabled

For Windows NT and Windows 2000 clients: If you want to restore from file spaces that are not Unicode enabled, you must specify the source on the server and a destination on the client. For example, you backed up your H-disk, named \\your-node\h$, prior to installing the Unicode-enabled client. After the installation, you issue the following command for a selective backup:

   sel h:\logs\*.log

Before the backup takes place, the server renames the file space to \\your-node\h$_OLD. The backup continues placing the data specified in the current operation into the Unicode-enabled file space named \\your-node\h$. That file space now contains only the \logs directory and the *.log files. If you want to restore a file from the (old) renamed file space to its original location, you must enter both the source and destination as follows:

   restore \\your-node\h$_OLD\docs\myresume.doc h:\docs\

Windows 2000 Considerations

Tivoli Storage Manager restores named streams on a file basis only. Directories in Windows 2000 can contain named streams. Named streams attached to a directory will always be overwritten (regardless of the value of the prompt option) during a restore operation.

When restoring sparse files to a non-NTFS file system, set the Tivoli Storage Manager server communication time out value (idletimeout) to the maximum value of 255 to avoid client session timeout. Tivoli Storage Manager is restricted to restoring sparse files that are less then 4 gigabytes in size.

The following issues apply if more data is restored than the Microsoft disk quota allows:

Syntax

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

Parameters

file
This parameter specifies that the source file specification is an explicit filename. This parameter is required when you 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. See "Maximum File Size for Operations" for the maximum file size for restore processing.

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

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

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

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

Use the filespacename if the drive label name has changed or if you are restoring files backed up from another node with drive labels that are different from yours. This is the drive label name or UNC name on the workstation drive from which the file was backed up. The following example is valid for specifying a UNC name: {'\\machine\C$'}.

Note:
You must specify a mixed or lowercase NTFS file space name enclosed in quotes and braces. For example, {"NTFSDrive"}. Single quotes or double quotes are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotes are valid. The single quotes requirement is a restriction of the operating system.

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

When entering the destinationfilespec, please consider the following:

Note:
If the destination path or any part of it does not exist, Tivoli Storage Manager will create it.

Examples

Task
Restore a single file named budget.fin.

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

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

Command: restore file budget.fin

Task
Restore files from the abc NTFS file space proj directory.

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

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

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

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

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

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

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

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

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

Task
Restore a file from the renamed file space \\your-node\h$_OLD to its original location. Enter both the source and destination as follows:

Command: res \\your-node\h$_OLD\docs\myresume.doc h:\docs\

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

Command: res -filelist=c:\avi\restorelist.txt c:\NewRestoreLocation\

Restore Activedirectory

The restore activedirectory command restores a Windows 2000 Active Directory database and associated logs from the server. The Active Directory must be offline before you begin the restore. To begin the restore, reboot the system in the inactive directory restore mode. While the directory is offline, all user validation occurs using the Security Accounts Manager (SAM) in the registry.For information on system objects that must be restored together, see "Backing Up System Objects".

Syntax

>>-REStore ACTIVEDirectory--+----------+-----------------------><
                            '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore activedirectory command: inactive, pittime, pitdate, pick. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Restore the Active Directory on the local server.

Command: res actived

Restore Backupset

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

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 {\\machinename\c$}\* c:\destdir
-subdir=yes

You can restore one or all system objects from a backup set using the systemobjectname parameter. On the GUI you can only restore the entire backup set, which may contain system objects.

A backup set can also be restored from a tape device on the Windows NT and Windows 2000 clients. See Location for information on supported tape devices and how to specify these devices.

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

Note:
There is no support in the API for the backup set format. Therefore, backup set data that was backed up via the API cannot be restored or used.

Attention: If the object you want to restore is part of a backup set generated on a node, and the node name is changed on the server, any backup set objects that were generated prior to the name change will not match the new node name. Ensure that the node name is the same as the node for which the backup set was generated.

Restoring Backup Sets in a SAN Environment

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

Syntax

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

Parameters

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

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

backupsetname
Specifies the name of the backup set on the server from which to perform a restore operation. Wildcard characters cannot be used to specify the backup set name. Tivoli Storage Manager restores the backup set from the server via LAN.

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.

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

SYSTEMObject
Specifies that you want to restore all Windows 2000 system objects from the backup set.

destinationfilespec
Specifies the destination path for the restored files. If you do not specify a destination, Tivoli Storage Manager restores the files to the original source path. Windows 2000 system objects can only be restored 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: restore backupset mybackupsetname -loc=server

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

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

Task
Restore a backup set from the \\.\tape0 device.

Command: dsmc restore backupset \\.\tape0 -loc=tape

Task
Restore the system objects contained in backup set backupsetfile.name file in the recovery directory.

Command: dsmc restore backupset c:\recovery\backupsetfile.name systemobject

Restore Certserverdb

The restore certserverdb command restores a Windows 2000 certificate server database. For information on system objects that must be restored together, see "Backing Up System Objects".

Syntax

>>-REStore CERTServerdb--+----------+--------------------------><
                         '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore certserverdb command: inactive, pittime, pitdate, pick. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Restore the certificate server database.

Command: res certs

Restore Clusterdb

The restore clusterdb command restores a Windows 2000 Microsoft Cluster Services cluster database for the local cluster. For information on system objects that must be restored together, see "Backing Up System Objects".

Syntax

>>-REStore CLUSTERDB--+----------+-----------------------------><
                      '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore clusterdb command: inactive, pittime, pitdate, pick. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Restore the Microsoft Cluster Services cluster database.

Command: res clusterdb

Restore Complusdb

The restore complusdb command restores a Windows 2000 COM+ database. For information on system objects that must be restored together, see "Backing Up System Objects".

Syntax

>>-REStore COMPlusdb--+----------+-----------------------------><
                      '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore complusdb command: inactive, pittime, pitdate, pick. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Restore the COM+ database.

Command: restore compl

Restore Eventlog

The restore eventlog command restores the active Windows NT and Windows 2000 event logs previously stored on the server.

Event logs are restored to the adsm.sys\eventlog.res directory under the root directory of the system drive or to a destination you specify.

Syntax

For Windows 2000

>>-REStore Eventlog--+----------+------------------------------><
                     '- options-'
 
 

For Windows NT

                         .-ENTIRE-.
>>-REStore Eventlog--+- -+--------+----------+------------------>
                     '- LOG-+- APPLICATION-+-'
                            +- SECURITY----+
                            '- SYSTEM------'
 
>-- destinationfilespec--+----------+--------------------------><
                         '- options-'
 
 

Parameters

The following parameters are for Windows NT.

ENTIRE
Restores all event logs stored on the server.

LOG
Restores one of the following event logs:

APPLICATION
Restores the application event log.

SECURITY
Restores the security event log.

SYSTEM
Restores the system event log.

destinationfilespec
Identifies the path where you want to place the restored files. If you do not specify a destination, Tivoli Storage Manager restores the files to the adsm.sys\eventlog.res directory on the system drive root directory.

options
Windows 2000: You can use these command line options with the restore eventlog command: inactive, pittime, pitdate, pick. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore the entire event log.

Command: rest event entire

Task
Restore the security event log.

Command: rest event log security

Task
Restore the system event log.

Command: rest event log system c:\tempdir

Restore FRS

The restore frs command restores Windows 2000 replicated files. Replicated file systems are part of system state data and must be restored along with the other components of that data such as the registry, system volumes, and the certificate server database.

Syntax

>>-REStore FRS--+----------+-----------------------------------><
                '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore frs command: inactive, pittime, pitdate, pick. For more information about command line options, see Chapter 9, "Using Options with Commands".

Examples

Task
Restore replicated file systems..

Command: res frs

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.

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 options file dsm.opt. The value in the client 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.

The restore nas command is valid for Windows NT and Windows 2000 clients only.

A NAS file system specification uses the following conventions:

Syntax

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

Parameters

options
You can use these common options with the restore nas command: monitor, nasnodename, quiet, verbose. For more information, see Chapter 8, "Setting Common Options".

You can use these command line options with the restore nas command: inactive, pick, pitdate, pittime. For more information, seeChapter 9, "Using Options with Commands".

sourcefilespec
Specifies the name of the NAS file system image you want to restore. This parameter is required 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 Registry

The restore registry command restores the Windows registry. For information on system objects that must be restored together, see "Backing Up System Objects".

When you restore a registry key, you have a choice of whether or not to activate the key. A backup copy of the active registry and registry key is made in the adsm.sys\registry.sav file on the system drive root directory before the registry is restored. If Windows does not boot with the newly restored registry, you can used this saved copy to reboot. If you are using Windows 98 or Windows Me, the file will be adsm98.sys\registry.sav. The directory structure is the same as c:\adsm.sys\registry, which is described below.

If you cannot boot Windows, you might be able to manually restore the registry if you can boot another operating system that does not use the registry. During backup and restore, copies of the registry are saved on the workstation in the following directories (assuming that your system drive is c:):

c:\adsm.sys\registry
This directory contains subdirectories that are named after the Windows workstation name. For example, if the workstation name is tanenhaus, the directory would be: c:\adsm.sys\registry\tanenhaus

Note: For Windows 98 or Windows Me, the directory name is adsm98.sys\registry.

Attention: Restore the registry to the same workstation from which it was backed up, since the registry contains specific hardware and software information. If you try to restore to another workstation, you may not be able to boot the computer after the restore.

If you have the NT Server Resource Kit installed, you can use the regrest standalone utility to restore the registry file created with the backup registry command. For example, assume that a user profile is backed up to a file named guest and you want to save the active copy of the registry to a file named guest.sav. The hive type you want to save to is users, and the hive name is the user SID, which is found in hk_users. You would enter the following statement:

restore registry c:\adsm.sys\registry\machine\users\guest 
c:\guest.sav users S-1-5-21-8533442-1654749355-78804774-1152
For Windows 2000, registry backup will enumerate and process all hives listed in:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Eventlog
For the restore to take effect, you must reboot your machine.

For complete information on the restore registry command, see the documentation for your NT Server Resource Kit.

Syntax

For Windows 2000

                                  .-Yes-.
>>-REStore REgistry-- ACTIVATEkey-+-----+--+----------+--------><
                                  '-No--'  '- options-'
 
 

For Windows NT

                         .-ENTIRE-.
>>-REStore REgistry--+- -+--------+-----------+----------------->
                     +- MACHINE-+- SAM------+-+
                     |          +- SECURITY-+ |
                     |          +- SOFTWARE-+ |
                     |          '- SYSTEM---' |
                     '- USER-+- CURUSER-+-----'
                             '- DEFAULT-'
 
                .-Yes-.
>-- ACTIVATEkey-+-----+----------------------------------------><
                '-No--'
 
 

For Windows 98, Me

                         .-ENTIRE-.
>>-REStore REgistry--+- -+--------+-----------+----------------->
                     +- MACHINE-+- CONFIG---+-+
                     |          +- ENUM-----+ |
                     |          +- HARDWARE-+ |
                     |          +- NETWORK--+ |
                     |          +- SAM------+ |
                     |          +- SECURITY-+ |
                     |          +- SOFTWARE-+ |
                     |          '- SYSTEM---' |
                     '- USER-+----------+-----'
                             '- DEFAULT-'
 
                .-Yes-.
>-- ACTIVATEkey-+-----+----------------------------------------><
                '-No--'
 
 

Parameters

The following parameters are for Windows 98, Me, and NT.

ENTIRE
Restores the registry keys previously backed up. This is the default.

MACHINE
Restores one of the following machine root key hives (registry subkeys):

CONFIG
Valid for Windows 98 and Me only. Restores the local workstation config hive (hkey_local_machine\config subkey).

ENUM
Valid for Windows 98 and Me only. Restores the local machine enumerate hive (hkey_local_machine\enum subkey).

HARDWARE
Valid for Windows 98 and Me only. Restores the local machine hardware hive (hkey_local_machine\hardware subkey).

NETWORK
Valid for Windows 98 and Me only. Restores the local machine network hive (hkey_local_machine\network subkey).

SAM
Valid for Windows NT only. Restores the Security Accounts Manager (SAM) hive (hkey_local_machine\sam subkey).

SECURITY
Restores the security policy hive (hkey_local_machine\security subkey).

SOFTWARE
Restores the local machine software configuration hive (hkey_local_machine\software subkey).

SYSTEM
Restores the local machine system configuration hive (hkey_local_machine\system subkey).

USER
Restores one of the following user root key hives (registry subkeys):

CURUSER
Valid for Windows NT only. Restores the current (logged on) user profile.

DEFAULT
Restores the default user profile hive (hkey_users\default subkey).

ACTIVATEkey
Specifies whether to activate the registry key after restoring the files. You may specify this option on the command line or in the dsm.opt file. See Activatekey for more information.

Yes
Update the registry. You must reboot for the changes to take effect. This is the default.

No
Tivoli Storage Manager restores the files, but does not update the registry.

options
Windows 2000: You can use these command line options with the restore registry command: inactive, pittime, pitdate, pick. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore the entire directory.

Command: rest reg entire

Task
Restore the Security Accounts Manager (SAM).

Command: rest reg machine sam

Task
Update the registry.

Command: rest reg machine same -activate=y

Restore RSM

Removable Storage Manager (RSM) runs on Windows NT Server and Windows 2000 Server operating systems. The restore rsm command restores backups of RSM database files on the server. Changes are effective after the server is restarted.

Note:
Although the backup rsm command backs up the RSM database, the command does not back up the data managed by Windows 2000 Remote Storage Service (RSS). To back up and restore offline data managed by RSS, you must use the Microsoft Backup Utility. Following are some recommendations for working with offline RSS-managed data:

Windows 2000 Servers (Server, Advanced Server, and Datacenter Server) may allow many applications to share a bulk storage device. On these servers, RSM manages data on removable storage media that exists in a media pool. This data is accessible by media application and media management programs and can be shared and traced across applications. Tivoli Storage Manager servers support RSM by creating application pools for backup media. Tivoli Storage Manager clients support RSM recovery by creating a backup of the RSM database when running on a Windows 2000 Server.

Syntax

>>-REStore RSM--+----------+-----------------------------------><
                '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore rsm command: inactive, pittime, pitdate, pick. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore the RSM database.

Command: res rsm

Restore Sysfiles

The restore sysfiles command restores Windows 2000 system and boot files. These files make changes to the registry and should not be restored at the same time as the registry. If you are restoring both the registry and the system and boot files, restore the registry first. System and boot files are part of the system state data and must be restored along with the other components of that data such as the registry, cluster service information and the certificate server database.

Syntax

>>-REStore SYSFiles--+----------+------------------------------><
                     '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore sysfiles command: inactive, pittime, pitdate, pick. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore system and boot files.

Command: res sysf

Restore Systemobject

The restore systemobject command restores all of the following active and inactive Windows 2000 system objects stored on the server:

The restore systemobject command is only valid for Windows 2000. To restore the active Windows NT registry system object stored on the server, use the restore registry command. To restore the active Windows NT eventlog stored on the server, use the restore eventlog command.

Syntax

>>-REStore SYSTEMObject--+----------+--------------------------><
                         '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore systemobject command: pittime and pitdate. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore all active system objects.

Command: restore systemobject

Restore Sysvol

The restore sysvol command restores a Windows 2000 system volume. This system object is part of system state data and must be restored with other components of that data such as the registry, system files, and the certificate server database.

Syntax

>>-REStore SYSVol--+----------+--------------------------------><
                   '- options-'
 
 

Parameters

options
Windows 2000: You can use these command line options with the restore sysvol command: inactive, pittime, pitdate, pick. See Chapter 8, "Setting Common Options" for more information.

Examples

Task
Restore a system volume.

Command: res sysv

Retrieve

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

You can also use the pick option on the command line to display a list of your archives. From this list, you can select the desired archive to retrieve.

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

Note:
An error will occur if you attempt to retrieve a file whose name is the same as the short name of an existing file. For example, if you attempt to retrieve a file you specifically named ABCDEF~1.DOC into the same directory where a file named abcdefghijk.doc exists, the retrieve will fail because the Windows operating system equates the file named abcdefghijk.doc to a short name of ABCDEF~1.DOC. The retrieve function treats this as a duplicate file.

If this error should occur, perform any of the following actions to correct it:

If you are using client version 3.1.0.5 or later, the workstation name is part of the file name. Therefore, if you archive files on one workstation and you want to retrieve them to another workstation, you must specify a destination. This is true even if you are retrieving to the same physical workstation, but the workstation has a new name. For example, to retrieve the c:\doc\h2.doc file to its original directory on the workstation, named star, you would enter:

   dsmc retrieve c:\doc\h2.doc \\star\c$\

To retrieve the file to star which has now been renamed meteor, you would enter:

   dsmc retrieve c:\doc\h2.doc \\meteor\c$\

You could also enter:

   dsmc retrieve c:\doc\h2.doc \\star\c$\

This example is valid because if the workstation name is not included in the specification, the local workstation is assumed (meteor, in this case).

Retrieving from File Spaces that are not Unicode Enabled

For Windows NT and Windows 2000 clients: If you want to retrieve archives from file spaces that were renamed by the Unicode-enabled client, you must specify the source on the server and a destination on the client. For example, you archived files from your H-disk, named \\your-node\h$ prior to installing the Windows NT or Windows 2000 client. After the installation, you issue the following archive command:

   arc h:\logs\*.log

Before the archive takes place, the server renames the file space to \\your-node\h$_OLD. The archive continues placing the data specified in the current operation into the Unicode-enabled file space named \\your-node\h$. That file space now contains only the \logs directory and the *.log files. If you want to retrieve a file from the (old) renamed file space to its original location, you must enter both the source and destination as follows:

   retrieve \\your-node\h$_OLD\docs\myresume.doc h:\docs\

Windows 2000 Considerations

Tivoli Storage Manager retrieves named streams on a file basis only. Directories in Windows 2000 can contain named streams. Named streams attached to a directory will always be overwritten (regardless of the value of the prompt option) during the retrieve.

When retrieving sparse files to a non-NTFS file system, set the Server communication time out value (idletimeout) to the maximum value of 255 to avoid client session timeout.

The following issues apply if more data is restored than the Microsoft disk quota allows:

Syntax

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

Parameters

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

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

sourcefilespec
Specifies the path and file name that you want to retrieve. Use wildcard characters to specify a group of files or all the files in a directory. See "Maximum File Size for Operations" for the maximum file size for retrieve processing.
Note:
If you include filespacename, do not include a drive letter in the file specification.

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

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

Note:
You must specify a mixed or lowercase NTFS file space name enclosed in quotes and braces. For example, {"NTFSDrive"}. Single quotes or double quotes are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only single quotes are valid. The single quotes requirement is a restriction of the operating system.

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

When entering the destinationfilespec please consider the following:

Note:
If the destination path or any part of it does not exist, Tivoli Storage Manager will create it.

Examples

Task
Retrieve a single file named budget.fin.

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

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

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

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

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

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

Command: ret c:\devel\*

Task
Retrieve files from the abc file space proj directory.

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

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

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

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

Command: ret c:\project\* -pick

Task
Retrieve a file from the renamed file space \\your-node\h$_OLD to its original location. Enter both the source and destination as follows:

Command: ret \\your-node\h$_OLD\docs\myresume.doc h:\docs\

Schedule

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

If the schedmode option is set to polling, when you start the client scheduler it continuously contacts the server for scheduled events based on the time you specified with the queryschedperiod option in your client options file dsm.opt. If your administrator sets the queryschedperiod option for all nodes, that setting overrides your setting.

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

Note:
Tivoli Storage Manager does not support the client scheduler running in prompted mode across a firewall. Use the client scheduler in polling mode across a firewall.

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

Note:
You cannot enter this command in interactive mode.

Syntax

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

Parameters

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

Examples

Task
Start the client scheduler.

Command: dsmc sch -password=notell

Selective

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

During a selective backup, 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.

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 c:\dir1\dir2\bogus.txt

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

If the selective command is retried because of a communication failure or session loss, the transfer statistics will display the number of bytes 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.

Adaptive Subfile Backups

If you perform a backup over a network device with limited bandwidth, such as with a modem, you can reduce network traffic by using the subfilebackup option. In order to use this feature, you must first specify the adaptive subfile backup options during a normal backup. For information about adaptive subfile backups, see "Performing a Backup with Limited Bandwidth". For more information about using the subfilebackup option, see Subfilebackup.

Migrating to Unicode-Enabled File Spaces

Please see Autofsrename for information about using the Unicode-enabled client.

Windows 2000 Considerations

Tivoli Storage Manager backs up named streams on a file basis only. Backup of a named stream containing sparse file data is not supported. A sparse file is backed up as a regular file if Client compression is off. Enable file compression (compression=on) when backing up sparse files to minimize network transaction time and to maximize server storage space.

Microsoft disk quotas do not affect the amount of data you can back up.

Syntax

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

Parameters

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

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

filespec
Specifies the path and file name that you want to back up. Use wildcard characters to select a group of files or all the files in a directory. You can also enter up to 20 file specifications in a command by separating the file specifications with a space. When backing up a file system, specify the file system with a trailing slash.

Examples

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

Command: sel c:\devel\proja.dev

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

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

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

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

Set Access

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

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

Syntax

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

Parameters

Archive
Permits access to archived files.

Backup
Permits access to backup versions of files.

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

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

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

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

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

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

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

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

user
This is an optional keyword command modifier that restricts access to the user at the specified node.

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

Examples

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

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

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

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

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

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

Set Password

The set password command changes the Tivoli Storage Manager password for your workstation. You are prompted twice for your new password.

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

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

Syntax

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

Parameters

oldpw
Specifies the current password for your workstation.

newpw
Specifies the new password for your workstation.

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

Examples

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

Task
Change your password from osecret to nsecret.

Command: set password osecret nsecret


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