This document is for authorized service representatives and Tivoli Storage Manager development. The information contained in this document has not been submitted to any formal Tivoli test and is distributed AS IS. This document is not for customer use. The customer is responsible for using this information as it applies to their operational environment. Tivoli might review each item for accuracy in a specific situation. There is no guarantee that you will obtain simular results. Customers attempting to adapt these techniques to their own environments do so at their own risk.
If you run the trace facility on your system, you might receive output messages that are automatically generated by the process. You can ignore the output. The output is in a readable format so authorized users and service representatives can isolate problems.
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 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.
Or, you can review the Customer Support Handbook that is available on our Web site at http://www.tivoli.com/support/handbook/.
When you contact Tivoli Customer Support, be ready to provide identification information for your company so that support personnel can assist you. Company identification information also might 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 sending e-mail to swdist@tivoli.com. Please provide the publication number, part number, or order number of the document that you want. 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:
This book uses the following typographical
conventions:
Table 1. Typographical Conventions
Example | Description |
---|---|
autoexec.ncf | A series of lowercase letters with an extension indicates 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 an example. All other times in the text it
appears as regular font.
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 | Monospace type represents fragments of a program or information as it would appear on a display 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 part
of the Tivoli Storage Manager library. Some of these might be 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 |
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 Reference Cards for the Backup-Archive Clients | Tivoli Storage Manager Reference Cards for the Backup-Archive Clients | SH26-4118 |
TSM Trace Facility Guide | Tivoli Storage Manager Trace Facility Guide | SH26-4121 |
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 on the TSM Web site at the following URL:
http://www.tivoli.com/support/storage_mgr/tivolimain.html