Operation, commands and options of Spectrum Protect

ISP can be operated via two user interfaces:

  • the command line interface (CLI):
    * command dsmc
  • the graphical user interface (GUI):
    * Command dsm (Windows)
    * command dsmj (UNIX/Linux)

Use of the command interface

All functions of ISP can be called with commands, so that they can also be used in scripts. One of the two following modes can be used:

  • one uses the shell command dsmc and gives it all additional information as parameters:
    dsmc query backup "*"
  • one calls the shell command dsmc once without parameters and is then asked for the subcommands:
    dsmc> query backup "*"
    dsmc> quit

The two possibilities look very similar, but they are not: in the first case the shell interprets the command and therefore replaces the shell variable, in the second case TSM interprets the command and does not provide this service.
So in many cases the first variant is more convenient to use. Therefore it is always assumed in the examples.
The second option is advantageous if a large number of commands are to be issued, since otherwise a separate connection to the server is called for each call of dsmc .

Each command starts with a command name (in the example above query ) , sometimes followed by an object (in the example archive). This may be followed by further parameters (e.g. the names of the files to be processed) and options. Command name, object, and options may be set off.

Where file names are required, simple wildcards may be used: * stands for any substring (unlike in Unix, there is no special rule for file names beginning with .) and ? for single characters. In this case, the whole parameter must always be enclosed in double quotes.
Unlike in Unix, wildcards are only allowed at the very end of file names, but not in the names of directories. Description of the most important commands and options in German (DEU) and English (ENU).

CommandFunctionClient version
V 8.1.12
dsmc helpTable of contents of the helpDEU ENU
dsmc query filespaceDisplaying a list of filespacesDEU ENU
dsmc query inclexclDisplay list of include/exclude statementsDEU ENU
dsmc query optionsDisplay the client optionsDEU ENU
dsmc query scheduleDisplay the backup times of the clientDEU ENU
dsmc query sessionDisplay information about the running TSM sessionDEU ENU
dsmc set passwordChange the TSM passwordDEU ENU
Commands for backup operations
dsmc incrementalStart incremental backupDEU ENU
dsmc preview backupSimulation of a backup commandENU ENU
dsmc query backupDisplaying a list of backup versions of the files in backupDEU ENU
dsmc restoreRestore files from backupDEU ENU
dsmc query restoreDisplay a list of restores that can be restartedDEU ENU
dsmc restart restoreStart a restartable restoreDEU ENU
dsmc cancel restoreDelete a restartable restoreDEU ENU
Commands for archive operations
dsmc archiveArchiving filesDEU ENU
dsmc preview archiveSimulation of an archiving commandDEU ENU
dsmc query archiveDisplay a list of files in the archiveDEU ENU
dsmc retrieveRetrieve files from the archiveDEU ENU
dsmc delete archiveDelete files from archiveDEU ENU
OptionFunctionClient version
archmcSpecification of a management class (archiving)DEU ENU
descriptionDescription of a file (archiving)DEU ENU
encryptiontypeSelection of the algorithm for data encryptionDEU ENU
encryptkeyHandling of the encryption key passwordDEU ENU
fromdateStart date to search for backup or archive copies of filesDEU ENU
fromtimeStart time to search for backup or archive copies of filesDEU ENU
ifnewerReplacing a file with a more recent backup versionDEU ENU
inactiveDisplay active and inactive objectsDEU ENU
latestReplace a file with the latest backup versionDEU ENU
pickCreation of a list of backup versions or archiving copiesDEU ENU
pitdateTime (date) for displaying/restoring the last backup versionDEU ENU
pittimeTime (clock) for displaying/restoring the last backup versionDEU ENU
preservepathSpecification of how much of the source path is to be restored as part of the target pathDEU ENU
querysummaryProvide statistics on files, directories, and objectsDEU ENU
replaceHandling of overwriting existing filesDEU ENU
todateEnd date to search for backup or archive copies of filesDEU ENU
totimeEnd time to search for backup or archive copies of filesDEU ENU
v2archiveArchiving of files without consideration of directoriesDEU ENU

Graphical interface

If you call dsm or dsmj instead of dsmc , a new window for interaction of the TSM client with the TSM server will appear; precondition for the command dsm is that an X-Window server is running. Behind the call of dsmj there is a Java program. With it you can select the files to archive as well as the files to restore with the mouse, which can be more comfortable than the command interface. A few tips:

  • The graphical interface knows much less about working directories or symbolic links than the command interface. That's why you always have to specify the whole path when asked for a file path, e.g. /what/is/then/my/path.
    At the very end you may use wildcards again, but only there.
  • Be very careful when the offer by directory tree appears in a menu. There all directories are offered for selection and clicking; even if there are thousands.

Otherwise, the graphical user interface is self-describing. Of the directories offered in the left part of the window, only the File Level directory is normally important. Under this directory you should find the saved filespaces of your computer.