Tivoli Storage Manager (TSM) is a client-server licensed product that provides storage management services in a multiplatform computer environment. The backup-archive client program permits users to back up and archive files from their workstations or file servers to storage, and restore and retrieve backup versions and archived copies of files to their local file systems.
In addition to the backup-archive client, TSM includes the following programs available on a variety of platforms:
IBM acknowledges and thanks Scott Stanchfield, author of the TabSplitter package that is used in the Web backup-archive client graphical user interface.
Associated with TSM, but sold separately, is the Tivoli Space Manager client program which was previously a feature of ADSM known as Hierarchical Storage Manager (HSM). Tivoli Space Manager automatically migrates eligible files to storage to maintain specific levels of free space on local file systems, and automatically recalls migrated files when they are accessed. It also permits users to migrate and recall specific files. This client program runs only on the following operating systems:
Unless otherwise specified:
This book explains how to install the TSM clients and how to perform initial setup tasks. For information about installation and levels of operating systems that are supported, refer to the installation chapter for your client. For information about environment variables, refer to the environment variables section for your client.
This book is for administrators or general users who need to install the TSM backup-archive or administrative client on a workstation.
This book assumes that you know how to use the workstation on which you plan to install the client and that you understand how the workstation's operating system works.
Information in this book directed specifically to authorized users is identified by the phrase, TSM authorized user. A TSM authorized user is any user running with a real uid of 0 (root) or a user who owns an executable whose owner execution permission bit is set to s. In the following example, the user tivoli is a TSM authorized user while running dsmc since the dsmc owner execution permission bit is set to s:
-rwsr-xr-x 1 tivoli dsmdev 2880479 Nov 5 13:42 dsmc*
TSM books are translated into other languages. Contact your TSM representative for a list of available translations.
This book uses the following typographical
conventions:
Table 1. Typographical Conventions
Example | Description |
---|---|
autoexec.ncf | A series of lowercase letters with an extension indicates TSM program file names. |
archive | Boldface type indicates a command that you type at a workstation, such as a command you type on a command line. |
dateformat | Boldface italic type indicates a TSM option. The bold type is used
to introduce the option, or in an example. All other times in the text
it appears as regular type.
Occasionally, file names are entered in boldface italic for emphasis. |
filespec | Italicized type indicates either the name of a parameter, a new term, or
a placeholder for information that you provide.
Italics are also used for emphasis in the text. |
maxcmdretries | Monospaced type represents fragments of a program or information as it would display on a screen. |
plus sign (+) | A plus sign between two keys indicates you should press both keys at the same time. |
This section describes how to read the syntax diagrams used in this book. To read a syntax diagram, follow the path of the line. Read from left to right, and top to bottom.
Syntax items, such as a keyword or variable, can be:
Syntax Diagram Description | Example |
---|---|
Abbreviations:
Uppercase letters denote the shortest acceptable truncation. If an item appears entirely in uppercase letters, it cannot be truncated. You can type the item in any combination of uppercase or lowercase letters. In this example, you can enter KEYWO, KEYWORD, or KEYWOrd. |
>>-KEYWOrd----------------------------------------------------->< |
Symbols:
Enter these symbols exactly as they appear in the syntax diagram. |
|
Variables:
Italicized lowercase items (var_name) denote variables. In this example, you can specify a var_name when you enter the KEYWORD command. |
>>-KEYWOrd--var_name------------------------------------------->< |
Repetition:
An arrow returning to the left means you can repeat the item. A character or space within the arrow means you must separate repeated items with that character or space. A footnote by the arrow references the number of times you can repeat the item. |
.-----------. V | >>----repeat---+-----------------------------------------------><
.-,---------. V | >>----repeat---+-----------------------------------------------><
.----------------. V (1) | >>----repeat--------+------------------------------------------><
Notes:
|
Required Choices:
When two or more items are in a stack and one of them is on the line, you must specify one item. In this example, you must choose A, B, or C. |
>>-+-A-+------------------------------------------------------->< +-B-+ '-C-' |
Optional Choice:
When an item is below the line, that item is optional. In the first example, you can choose A or nothing at all. When two or more items are in a stack below the line, all of them are optional. In the second example, you can choose A, B, C, or nothing at all. |
>>-+---+------------------------------------------------------->< '-A-'
>>-+---+------------------------------------------------------->< +-A-+ +-B-+ '-C-' |
Defaults:
Defaults are above the line. The default is selected unless you override it. You can override the default by including an option from the stack below the line. In this example, A is the default. You can override A by choosing B or C. You can also specify the default explicitly. |
.-A--. >>-+----+------------------------------------------------------>< +-B--+ '-C--' |
Repeatable Choices:
A stack of items followed by an arrow returning to the left means you can select more than one item or, in some cases, repeat a single item. In this example, you can choose any combination of A, B, or C. |
.--------. V | >>---+-A-+--+-------------------------------------------------->< +-B-+ '-C-' |
Syntax Fragments:
Some diagrams, because of their length, must fragment the syntax. The fragment name appears between vertical bars in the diagram. The expanded fragment appears between vertical bars in the diagram after a heading with the same fragment name. |
>>-| The fragment name |--------------------------------------->< The fragment name .-A--. |---+----+------------------------------------------------------| +-B--+ '-C--' |
Included here is a list of the publications that are
referred to in this manual.
Table 2. TSM Client Publications
Short Title | Publication Title | Order Number |
---|---|---|
TSM Messages | Tivoli Storage Manager Messages | GC35-0405 |
TSM Installing the Clients | Tivoli Storage Manager Installing the Clients | SH26-4119 |
TSM for Windows Using the Backup-Archive Clients | Tivoli Storage Manager for Windows Using the Backup-Archive Clients | SH26-4117 |
TSM for NetWare Using the Backup-Archive Client | Tivoli Storage Manager for NetWare Using the Backup-Archive Client | SH26-4116 |
TSM for UNIX Using the Backup-Archive Clients | Tivoli Storage Manager for UNIX Using the Backup-Archive Clients | SH26-4122 |
Using the HSM Clients | Tivoli Space Manager for UNIX Using the Hierarchical Storage Management Clients | SH26-4115 |
TSM AFS/DFS Backup Clients | Tivoli Storage Manager AFS/DFS Backup Clients | SH26-4124 |
Using the API | Tivoli Storage Manager Using the Application Programming Interface | SH26-4123 |
TSM Quick Reference for the Backup-Archive Clients | Tivoli Storage Manager Quick Reference for the Backup-Archive Clients | SH26-4118 |
TSM Trace Facility Guide | Tivoli Storage Manager Trace Facility Guide | SH26-4121 |
TSM for AIX Quick Start | Tivoli Storage Manager for AIX Quick Start | GC35-0402 |
TSM for AS/400 Quick Start | Tivoli Storage Manager for AS/400 Quick Start | GC35-0317 |
TSM for HP-UX Quick Start | Tivoli Storage Manager for HP-UX Quick Start | GC35-0412 |
TSM for MVS and OS/390 Quick Start | Tivoli Storage Manager for MVS and OS/390 Quick Start | GC35-0415 |
TSM for Sun Solaris Quick Start | Tivoli Storage Manager for Sun Solaris Quick Start | GC35-0406 |
TSM for Windows Quick Start | Tivoli Storage Manager for Windows Quick Start | GC35-0409 |
The Tivoli Storage Manager publications are available on the following
CD-ROM:
Tivoli Storage Manager Publications Version 4.1, SK3T-1417
TSM publications are available in softcopy at the following TSM Web page:
http://www.tivoli.com/support/_mgr/tivolimain.html
The IBM International Technical Support Center redbooks are available in softcopy on the IBM Redbooks Web site at the following Web page:
http://www.redbooks.ibm.com
You can order hardcopies of all our publications from the IBM Direct Publications Catalog Web site at the following Web page:
http://www.elink.ibmlink.ibm.com/pbl/pbl
For support for this or any Tivoli product, you can contact Tivoli Customer Support in one of the following ways:
Customers in the United States can also call 1-800-TIVOLI8 (1-800-848-6548). For product numbers 5697-TS9, 5697-DRS or 5697-DPM call 1-800-237-5511.
International customers should consult the Web site for customer support telephone numbers.
You can also review the Customer Support Handbook, which is available on our Web site at http://www.tivoli.com/support/handbook/.
When you contact Tivoli Customer Support, be prepared to provide identification information for your company so that support personnel can readily assist you. Company identification information may also be needed to access various online services available on the Web site.
The support Web site offers extensive information, including a guide to support services (the Customer Support Handbook); frequently asked questions (FAQs); and documentation for all Tivoli products, including Release Notes, Redbooks, and Whitepapers. The documentation for some product releases is available in both PDF and HTML formats. Translated documents are also available for some product releases.
You can order documentation by e-mail at swdist@tivoli.com. Please provide the publication number, part number, or order number of the desired document. Alternatively, you can provide the document title, version number, and date of publication.
We are very interested in hearing about your experience with Tivoli products and documentation. We also welcome your suggestions for improvements. If you have comments or suggestions about our documentation, please contact us in one of the following ways: