Operation, commands and options of Storage Protect

ISP can be operated via two user interfaces:

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

Using the command interface

All ISP functions can be called up with commands so that they can also be used in scripts. You can use one of the following two modes:

  • The shell command dsmc is used and all other specifications are given as parameters:
    dsmc query backup "*"
  • you call the shell command dsmc once without parameters and are then asked for the subcommands:
    dsmc
    dsmc> query backup "*"
    dsmc> quit

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

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

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

CommandCommand FunctionClient version
V 8.1.17
dsmc helpContents of the helpDEU ENU
dsmc query filespaceDisplay a list of filespacesENU ENU
dsmc query inclexclDisplay the list of include/exclude statementsENU ENU
dsmc query optionsDisplay the client optionsDEU ENU
dsmc query scheduleDisplay the backup times of the clientENU ENU
dsmc query sessionDisplay information about the current 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 backupDisplay a list of the backup versions of the files in the backupENU ENU
dsmc restoreRestore files from the backupENU ENU
dsmc query restoreDisplay a list of restartable restoresDEU ENU
dsmc restart restoreStart a restartable restoreDEU ENU
dsmc cancel restoreDelete a restartable restoreDEU ENU
Commands for archive operations
dsmc archiveArchiving filesENU 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 archiveENU ENU
dsmc delete archiveDelete files from the archiveENU ENU
optionFunctionClient version
V8.1.17
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 for searching for backup or archive copies of filesDEU ENU
fromtimeStart time to search for backup or archive copies of filesDEU ENU
ifnewerReplace a file with a more recent backup versionDEU ENU
inactiveDisplay active and inactive objectsDEU ENU
latestReplace a file with the latest backup versionDEU ENU
pickCreating a list of backup versions or archiving copiesDEU ENU
pitdateTime (date) for displaying/writing back the last backup versionDEU ENU
pittimePoint in time (time) for displaying/writing back the last backup versionDEU ENU
preservepathSpecifies how much of the source path is to be restored as part of the target pathDEU ENU
querysummaryProvision of statistics on files, directories and objectsDEU ENU
replaceHandling the overwriting of existing filesDEU ENU
todateEnd date for searching for backup or archive copies of filesDEU ENU
totimeEnd time for searching for backup or archiving copies of filesDEU ENU
v2archiveArchiving files without taking directories into accountDEU ENU

Graphical interface

If you call dsm or dsmj instead of dsmc , a new window appears for interaction between the TSM client and the TSM server; the prerequisite for the dsm command is that an X Window server is running. Behind the call to dsmj is a Java program. This allows you to select both the files to be archived and the files to be restored using the mouse, which can be more convenient than the command interface. A few tips on this:

  • The graphical interface knows much less about working directories or symbolic links than the command interface. For this reason, you must always specify the entire path when you are asked for a file path, e.g. /how/is/they/now/my/path.
    At the very end you can use wildcards again, but only there.
  • Great care should be taken when the offer by directory tree appears in a menu. All directories are offered there for selection and clicking, even if there are thousands of them.

Otherwise, the graphical user interface is self-describing. Of the directories offered in the left-hand area of the window, only the File Level directory is normally important. You should be able to find the saved file spaces on your computer under this directory.