2444

Tivoli Storage Manager TeradataExtension

Installation and User GuideRelease 13.00.00

B035-2444-088KOctober 2008

The product or products described in this book are licensed products of Teradata Corporation or its affiliates.

Teradata, BYNET, DBC/1012, DecisionCast, DecisionFlow, DecisionPoint, Eye logo design, InfoWise, Meta Warehouse, MyCommerce, SeeChain, SeeCommerce, SeeRisk, Teradata Decision Experts, Teradata Source Experts, WebAnalyst, and You’ve Never Seen Your Business Like This Before are trademarks or registered trademarks of Teradata Corporation or its affiliates.

Adaptec and SCSISelect are trademarks or registered trademarks of Adaptec, Inc.

AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc.

BakBone and NetVault are trademarks or registered trademarks of BakBone Software, Inc.

EMC, PowerPath, SRDF, and Symmetrix are registered trademarks of EMC Corporation.

GoldenGate is a trademark of GoldenGate Software, Inc.

Hewlett-Packard and HP are registered trademarks of Hewlett-Packard Company.

Intel, Pentium, and XEON are registered trademarks of Intel Corporation.

IBM, CICS, RACF, Tivoli, z/OS, and z/VM are registered trademarks of International Business Machines Corporation.

Linux is a registered trademark of Linus Torvalds.

LSI and Engenio are registered trademarks of LSI Corporation.

Microsoft, Active Directory, Windows, Windows NT, and Windows Server are registered trademarks of Microsoft Corporation in the United States and other countries.

Novell and SUSE are registered trademarks of Novell, Inc., in the United States and other countries.

QLogic and SANbox trademarks or registered trademarks of QLogic Corporation.

SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc.

SPARC is a registered trademark of SPARC International, Inc.

Sun Microsystems, Solaris, Sun, and Sun Java are trademarks or registered trademarks of Sun Microsystems, Inc., in the United States and other countries.

Symantec, NetBackup, and VERITAS are trademarks or registered trademarks of Symantec Corporation or its affiliates in the United States and other countries.

Unicode is a collective membership mark and a service mark of Unicode, Inc.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other product and company names mentioned herein may be the trademarks of their respective owners.

THE INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED ON AN “AS-IS” BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. IN NO EVENT WILL TERADATA CORPORATION BE LIABLE FOR ANY INDIRECT, DIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS OR LOST SAVINGS, EVEN IF EXPRESSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The information contained in this document may contain references or cross-references to features, functions, products, or services that are not announced or available in your country. Such references do not imply that Teradata Corporation intends to announce such features, functions, products, or services in your country. Please consult your local Teradata Corporation representative for those features, functions, products, or services available in your country.

Information contained in this document may contain technical inaccuracies or typographical errors. Information may be changed or updated without notice. Teradata Corporation may also make improvements or changes in the products or services described in this information at any time without notice.

To maintain the quality of our products and services, we would like your comments on the accuracy, clarity, organization, and value of this document. Please e-mail: [email protected]

Any comments or materials (collectively referred to as “Feedback”) sent to Teradata Corporation will be deemed non-confidential. Teradata Corporation will have no obligation of any kind with respect to Feedback and will be free to use, reproduce, disclose, exhibit, display, transform, create derivative works of, and distribute the Feedback and derivative works thereof without limitation on a royalty-free basis. Further, Teradata Corporation will be free to use any ideas, concepts, know-how, or techniques contained in such Feedback for any purpose whatsoever, including developing, manufacturing, or marketing products or services incorporating Feedback.

Copyright © 2003-2008 by Teradata Corporation. All Rights Reserved.

mailto:[email protected]

Preface

Purpose

This book provides information about Tivoli Storage Manager Teradata Extension, which is a Teradata® Tools and Utilities product. Teradata Tools and Utilities is a group of products designed to work with the Teradata Database. “Chapter 2 Teradata TARA Installation and Uninstallation” provides information about installing Tivoli Storage Manager Teradata Extension.

Tivoli Storage Manager Teradata Extension is supported by ARCMAIN as an interface for backing up and restoring objects in a Teradata Database. Tivoli Storage Manager Teradata Extension manages the input/output (I/O) interfaces between the Teradata ARCMAIN client utility and IBM Tivoli Storage Manager (TSM).

In the framework of Tivoli Storage Manager Teradata Extension is Teradata Tiered Archive Restore Architecture (TARA). TARA is composed of three components: TARA server, TARA GUI, and the backup application extension, TIVBAR.

Audience

This book is intended for use by:

• System administrators

• System operators

• Users who are responsible for backing up data and restoring tasks

Supported Releases

This book supports the following releases:

• IBM Tivoli Storage Manager 5.5

• Teradata Tools and Utilities 13.00.00 or later

• Tivoli Storage Manager Teradata Extension 13.00.00

Note: Open Tivoli Storage Manager Teradata Extension’s GUI. Click Teradata Tiered Archive/Restore Architecture>Help>About to display the Tivoli Storage Manager Teradata Extension version number.

Tivoli Storage Manager Teradata Extension Installation and User Guide 3

PrefacePrerequisites

To locate detailed supported-release information:

1 Go to http://www.info.teradata.com/.

2 Under Online Publications, click General Search.

3 Type 3119 in the Publication Product ID box.

4 Under Sort By, select Date.

5 Click Search.

6 Open the version of the Teradata Tools and Utilities ##.##.## Supported Platforms and Product Versions spreadsheet associated with this release.

The spreadsheet includes supported Teradata Database versions, platforms, and product release numbers.

Prerequisites

The following prerequisite knowledge is required for this product:

• Computer technology and terminology

• Teradata system hardware

• Relational database management (RDBMS) systems

• IBM Tivoli Storage Manager (TSM)

• IBM Backup/Archive Client

• Basic concepts and facilities of the Teradata Database and the Teradata server

• Teradata Backup and Storage procedures

• Microsoft® Windows® 2003 and XP operating systems

• SUSE® Linux 9 and 10 operating systems

Changes to This Book

The following changes were made to this book in support of the current release. Changes are marked with change bars. For a complete list of changes to the product, see the release definition associated with this release.

4 Tivoli Storage Manager Teradata Extension Installation and User Guide

http://www.info.teradata.com/

PrefaceAdditional Information

Additional Information

Additional information that supports this product and Teradata Tools and Utilities is available at the web sites listed in the table that follows. In the table, mmyx represents the publication date of a manual, where mm is the month, y is the last digit of the year, and x is an internal publication code. Match the mmy of a related publication to the date on the cover of this book. This ensures that the publication selected supports the same release.

Date and Release Description

August 200813.00.00

• Added support for Tivoli Storage Manager 5.5.

• Added GUI support for Tivoli Storage Manager Teradata Extension. Reorganized book into different sections: for the new GUI and the legacy command line product.

• Added online help to the new GUI.

• Added export to html functionality in the TARA GUI.

• Added SUSE Linux 9 and 10 support for the TARA server.

• Dropped Windows 2000 support.

• Added the taratddsmc command-line utility.

• Added the ability to specify the size of the log file.

• Added the ability to selectively back up and restore individual objects, described in “Selecting Individual Objects to Archive or Restore” on page 60.

Type of Information Description Access to Information

Release overview

Late information

Use the Release Definition for the following information:

• Overview of all of the products in the release

• Information received too late to be included in the manuals

• Operating systems and Teradata Database versions that are certified to work with each product

• Version numbers of each product and the documentation for each product

• Information about available training and the support center


2 Under Online Publications, click General Search.

3 Type 2029 in the Publication Product ID box.

4 Click Search.

5 Select the appropriate Release Definition from the search results.



PrefaceAdditional Information

Additional product information

Use the Teradata Information Products web site to view or download specific manuals that supply related or additional information to this manual.


2 Select Data Warehousing under Browse by Category.

3 Do one of the following:

• For a list of Teradata Tools and Utilities documents, click Teradata Tools and Utilities and then select a release or a specific title. Select Open Teradata Backup for a specific title relating to a Backup Application Software product.

• Select a link to any of the data warehousing publications categories listed.

Specific books related to Tivoli Storage Manager Teradata Extension are as follows:

• Teradata Archive/Recovery Utility ReferenceB035-2412-mmyx

• Teradata Tools and Utilities Installation Guide for Microsoft WindowsB035-2407-mmyx

CD-ROM images Access a link to a downloadable CD-ROM image of all customer documentation for this release. Customers are authorized to create CD-ROMs for their use from this image.


2 Under the Online Publications subcategory, Browse by Category, click Data Warehousing.

3 Click CD-ROM List and Images.

4 Follow the ordering instructions.

Ordering information for manuals

Use the Teradata Information Products web site to order printed versions of manuals.


2 Under Print & CD Publications, click How to Order.

3 Follow the ordering instructions.

General information about Teradata

The Teradata home page provides links to numerous sources of information about Teradata. Links include:

• Executive reports, case studies of customer experiences with Teradata, and thought leadership

• Technical information, solutions, and expert advice

• Press releases, mentions, and media resources

1 Go to Teradata.com.

2 Select a link.

Type of Information Description Access to Information





http://www.teradata.com

Table of Contents

Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Supported Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Changes to This Book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Chapter 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Component Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Migration from Legacy Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 2: Teradata TARA Installation and Uninstallation . . . . . . . . . . . . . . . . 19

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Teradata TARA Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Overview of Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Installation Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Installation Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Installation of Teradata TARA Components on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Installation of Teradata TARA Components on Windows . . . . . . . . . . . . . . . . . . . . . . . . 23

The xinetd Process on Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Installed Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

TARA Server Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Teradata TARA GUI Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Tivoli Access Module Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Uninstallation on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35


Table of Contents

Chapter 3: TSM and Teradata TARA Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Configure TSM for Teradata Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

TSM Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

TSM Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Configure the TARA Server GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Configure the TARA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Step 1 - Configure the Teradata Database System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

Step 2 - Configure the Client Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Step 3 - Configure the Client Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

Step 4 - Configure Tivoli Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Step 5 - Configure ARC Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Step 6 - Configure Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

Configure the Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

Chapter 4: Backup and Restore Using the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Starting the Teradata TARA GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Archiving a Database Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

Selecting Individual Objects to Archive or Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

Restoring a Database Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Viewing Job History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

Chapter 5: Taratddsmc Command-Line Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Overview of taratddsmc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Format Specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

Taratddsmc Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Query TSM Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Prompt Off Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

Query Backup and Query Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

Delete Backup and Delete Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80


Table of Contents

Inactivate Backup and Inactivate Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Chapter 6: Troubleshooting for the TARA GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Overview of Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Tivoli Storage Manager Teradata Extension Debug Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

ARCMAIN Outlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

TSM Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

TSM Server Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

TSM Client Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Error Conditions and Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Data Connector Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Vendor-Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

TSM Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

TARA Server Stop and Restart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Use of the Command Line to Obtain Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Teradata TARA GUI on Java Runtime Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

States for Archive Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Job Stream Connection Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Symptom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Step 1: Verify that ARC Output Files are Being Created . . . . . . . . . . . . . . . . . . . . . . . . . 101

Step 2: Examine the Script that Launches Teradata ARC. . . . . . . . . . . . . . . . . . . . . . . . . 101

TARA Job Output Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Symptom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Remedy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Unresponsive TARA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Symptom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Step 1: Add ulimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Step 2: Change Verbosity of TARA Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Appendix A: Installation and Configuration: Command Line Utility . . . . . . 105

Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Local Area Network (LAN) Connections and Platforms . . . . . . . . . . . . . . . . . . . . . . . . . 106


Table of Contents

Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106

Installed Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Additional Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Removal of the Teradata Access Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

Configuration of TSM for Teradata Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

TSM Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

TSM Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112

LAN Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Multiple Network Cards and TDPID Addressing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Teradata Database Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Network Settings for a Single Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Preparation for Production . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

Appendix B: Storage of Backup Data: Command Line Utility . . . . . . . . . . . . . . . .117

Overview of Backup Data Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

Object Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

DataSetName in ARCMAIN Backups and Restores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118

Backup Generations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

Functional Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

No RESTART During Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

ARCHIVE Statement Recommendation Per Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

No Dual Backup Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

Interoperability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

Collocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

IOPARM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127

Security for Files that Contain Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127

Control of Access to Backup Images Stored in TSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128

Default Files for ARCMAIN and the Access Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128

Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129

Appendix C: The TDDSMC Administrative Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131

Overview of the TDDSMC Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131


Table of Contents

Command Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Format Specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

TDDSMC Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Query TSM Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Prompt Off Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Query Backup and Query Object Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Delete Backup and Delete Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Inactivate Backup and Inactivate Object Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Appendix D: Troubleshooting: Command Line Utility . . . . . . . . . . . . . . . . . . . . . . . . 139

Overview of Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Teradata Access Module for Tivoli Debug Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

ARCMAIN Outlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

TSM Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

TSM Server Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

TSM Client Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Error Conditions and Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Data Connector Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Vendor-Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

TSM Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163


Table of Contents


List of Figures

Figure 1: Overview of a Tivoli Storage Manager Teradata Extension Backup . . . . . . . . . . . . 18


List of Figures


List of Tables

Table 1: Location of Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Table 2: Actions Taken when TARA Server Package Installed . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 3: Subdirectories of taraserver_postinstall.sh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 4: Files in bin Subdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 5: Folders and Registry Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Table 6: Fields to Consider for the Backup Copy Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Table 7: TSM Server Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Table 8: TSM Client Options File Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Table 9: Object Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Table 10: Metadata Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Table 11: Types of Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Table 12: Log File Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Table 13: Error Conditions and Recovery Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Table 14: Data Connector Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Table 15: Vendor Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Table 16: TSM Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Table 17: States for Archive Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Table 18: Files Created at Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Table 19: Additional Directories Created at Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Table 20: Tasks to Uninstall Complementary Components . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Table 21: Fields to Consider for the Backup Copy Group . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Table 22: TSM Server Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Table 23: TSM Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Table 24: Specifying Backup Image Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Table 25: Configuration for Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Table 26: Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Table 27: Security Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Table 28: Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Table 29: Metadata Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Table 30: Types of Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Table 31: Log File Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Table 32: Error Conditions and Recovery Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143


List of Tables

Table 33: Data Connector Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144

Table 34: Vendor Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147

Table 35: TSM Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153


CHAPTER 1

Introduction

Tivoli® Storage Manager Teradata® Extension is an access module that is supported by ARCMAIN as an interface for backing up and restoring objects in a Teradata Database. Tivoli Storage Manager Teradata Extension manages the input/output (I/O) interfaces between the Teradata ARCMAIN client utility and IBM Tivoli Storage Manager (TSM). The same ARCMAIN executable code can communicate with a variety of access modules.

This guide provides information about the installation and configuration of Tivoli Storage Manager Teradata Extension, and how to perform backup and restore jobs. A troubleshooting section provides guidance for resolving error conditions and error messages.

Note: This book changes the product name to Tivoli Storage Manager Teradata Extension. The prior product name, Teradata Access Module for Tivoli, is used in the appendixes to describe the legacy Teradata Access Module for Tivoli product. The legacy product was accessed with a command line utility. The chapters use the term Tivoli Storage Manager Teradata Extension for the new product, which is accessed through a Graphical User Interface (GUI).

Component Overview

ARCMAIN retrieves data from a Teradata Database server for tape storage, or retrieves data from tape storage to insert into a Teradata Database.

Figure 1 illustrates how Tivoli Storage Manager Teradata Extension interfaces with ARCMAIN through use of the Data Connector to store backups onto TSM.


Chapter 1: IntroductionMigration from Legacy Product

Figure 1: Overview of a Tivoli Storage Manager Teradata Extension Backup

ARCMAIN does not call Tivoli Storage Manager Teradata Extension directly. Instead, access is through a Data Connector component that dynamically loads the module and standardizes the interfaces.

The Data Connector and ARCMAIN software must be installed before using Tivoli Storage Manager Teradata Extension. For more about hardware and software requirements, see “System Requirements” on page 19.

Migration from Legacy Product

Use the legacy Teradata Access Module for Tivoli to restore backups that were created by Teradata Access Module for Tivoli. It is not possible to use Tivoli Storage Manager Teradata Extension’s GUI to restore those backups.

TeradataServer ARCMAIN

Data Connector

Tivoli AccessModule

Tivoli ClientAPI Library

Single Process withShared Library Calls

LAN-mode

High-Speed LAN Connection

Recommened WhenARCMAIN Process

Runs On a Remotely-Connected Node

ManagedStorage

TSM Server

TSMDatabase

Tivoli ClientAPI Library

TARA

2444C001

LAN-FreeMode


CHAPTER 2

Teradata TARA Installation andUninstallation

This chapter describes installing Teradata TARA for SUSE Linux and Windows hosts:

• System Requirements

• Teradata TARA Installation

• Installed Components

• Uninstallation on Windows

System Requirements

The next sections list the required software for Teradata TARA 13.00.00 on Linux or Windows operating systems.

Linux

Operating System

Use one of the following for the TARA GUI, TARA server, and the Tivoli access module:

• SUSE Enterprise Server 9 Linux

• SUSE Enterprise Server 10 Linux

Non-Teradata Software

Use Java Runtime Environment 1.5.0_06, or later.


Chapter 2: Teradata TARA Installation and UninstallationTeradata TARA Installation

Teradata Tools and Utilities Software

Use the 13.00.00 version, or later, of the following software:

• Shared ICU Libraries for Teradata

• Teradata Archive and Recovery Utility (ARC)

• Teradata Call-Level Interface (CLI) V2

• Teradata Data Connector (PIOM)

• Teradata GSS

Windows

Operating System

For the TARA GUI, use one of the following:

• Microsoft Windows 2003

• Microsoft Windows XP

For the TARA server and the Tivoli access module, use Microsoft Windows 2003 SP1 or later.

Non-Teradata Software

• Install Microsoft Windows Script Host, version 5.6.

• If you are installing the Teradata TARA GUI package, also install Java Runtime Environment 1.5.0_06 or later.

Teradata Tools and Utilities Software

Use the 13.00.00 version, or later, of the following software:

• Shared ICU Libraries for Teradata

• Teradata Archive and Recovery Utility (ARC)

• Teradata Call-Level Interface (CLI) V2

• Teradata Data Connector (PIOM)

• Teradata GSS Client nt-i386

Teradata TARA Installation

Overview of Installation Packages

There are three TARA-related installation packages for Linux and Windows:

• TARA server install package

• Teradata TARA GUI install package

• Tivoli Access Module package

Table 1 lists the installation package locations on the Tivoli Storage Manager Teradata Extension (TARA 13.00.00) CD.



The TARA server runs on a node called the TARA server host, which contains the Job Information Repository, the Script Repository, the TARA server logs, and the default configuration file. The TARA server is the executable that manages the data stored in the different repositories and controls the flow of data between the TARA server, the Teradata TARA GUI, and the Tivoli Access Module. On this host, the TARA server executable runs as a service.

The Teradata TARA GUI can run on any node connected to the TARA server; such a node is called the TARA GUI host. The Teradata TARA GUI acts as the user interface to the TARA system.

The Tivoli Access Module runs on a node called the TIVBAR host. The TIVBAR host must also be a BAR server node. The Tivoli Access Module is a Teradata-provided library file that interfaces with the ARCMAIN module, which is installed on the BAR server node during a Tivoli backup or restore job.

Installation Location

Install all three packages on a single server, each package on a different server, or any combination in between. Base the decision about where the TARA components are installed on the availability of servers and the anticipated usage and load on those servers.

Table 1: Location of Installation Packages

Operating System TARA Server Teradata TARA GUI Tivoli Access Module

Linux Linux/taraserver-<version>-<release>.i386.rpm

Linux/taragui-<version>-<release>.i386.rpm

Linux/tivbar-<version>-<release>.i386.rpm

Windows Windows\TARA Server\setup.exe Windows\TARA GUI\setup.exe Windows\TIVBAR\setup.exe



For installation in a multiple BAR server environment, these recommendations apply:

• Install the TARA server on only one of the BAR servers.

• Install the Tivoli Access Module on every BAR server that is part of the Tivoli and TARA configuration.

• Install the Teradata TARA GUI on either or both of the sets of components that will be used as the administrative interface to TARA:

• BAR servers

• Workstations

Installation Order

There are restrictions on the order of installation:

• Install the TARA server before the Tivoli Access Module.

• Install any product dependencies before installing the required TARA package (dependencies are noted in the next sections).

Installation of Teradata TARA Components on Linux

To install the TARA server

On the Linux server where you want the TARA server to run:

1 Install the TARA server package with the rpm utility. For example:

rpm -ih taraserver-13.00.00.00-1.i386.rpm

2 Manually execute the post-installation script. The post-installation script, taraserver_postinstall.sh, is usually located in /opt/teradata/tara/server/bin.

Execute the post-installation script by typing one of the following:

• /opt/teradata/tara/server/bin/taraserver_postinstall.sh

• cd /opt/teradata/tara/server/bin

./teraserver_postinstall.sh

3 At the command-line prompt for the name of the Backup Application, type t for Tivoli.

4 Enter the user name for the owner of the TARA server service. The default is taraserver, which can be selected by clicking Enter.

5 Enter the user home directory. The default is /home/taraserver, which can be selected by clicking Enter.

To install the Teradata TARA GUI

On the Linux server where you want the Teradata TARA GUI to run:

1 Install the rpm version of the Java runtime routines with the rpm utility.

2 Install the Teradata TARA GUI package with the rpm utility. For example:



rpm -ih taragui-13.00.00.00-1.i386.rpm

The Teradata TARA GUI package has no post-installation script.

Note: A dependency clause is included in the Teradata TARA GUI's rpm file to check for the existence of the Java runtime routines. The rpm utility only verifies that the Java runtime routines are installed if they were installed with the rpm utility. If the Java runtime routines have been installed without the rpm utility, the utility does not detect them. If this occurs, the installation of the Teradata TARA GUI will fail due to a dependency error. To correct this error, uninstall the Java runtime routines and then reinstall the rpm version of the Java runtime routines with the rpm utility.

To install the Tivoli Access Module

On the Linux server where you want the Tivoli Access Module to run:

1 Install the TTU packages for Teradata ICU, Teradata GSS, PIOM, CLIV2, and ARC with the rpm utility.

2 Install the Tivoli Access Module package with the rpm utility. For example:

rpm -ih tivbar-13.00.00.00-1.i386.rpm

3 Execute the post-installation script by entering one of the following:

• /opt/teradata/tara/tivbar/bin/tivbar_postinstall.sh

• cd /opt/teradata/tara/tivbar/bin

./tivbar_postinstall.sh

The post-installation script, tivbar_postinstall.sh, is usually located in /opt/teradata/tara/tivbar/bin.

As the message indicates, the post-install script designates the local server as a BAR server and sets up the required TARA client elements.

Verify the taraserver process is active in its designated BAR server, then:

1 Click Enter.

2 At the prompt, enter the machine name where the taraserver process is running. The default is localhost, which can be selected by clicking Enter.

Installation of Teradata TARA Components on Windows

The installation order of Teradata TARA components on Windows is:

1 TARA server

2 TARA Tivoli Access Module and Teradata TARA GUI, in any order (installation instructions are given for the TARA Tivoli Access Module first)



To install the TARA server


• Download the TARA server (taraserver.13.00.00) from the Teradata Software Server at:

http://tssprod.teradata.com:8080/TSFS/home.do

Save the file to your system.

• Go to Windows\TARA Server\setup.exe on the Tivoli Storage Manager Teradata Extension CD.

2 Double-click setup.exe. (If the Backup Application is not installed, an error message displays. Click Yes to continue with the installation.)


• If this is a new installation of the TARA server, proceed to step 6.

• If this is a reinstallation of taraserver.13.00.00, or taraserver.13.00.00 was previously removed with the Windows Add or Remove Programs, select Remove when a screen displays the choice of modifying, repairing, or removing the program. Click Next.

4 Click OK when asked to verify if the prior application should be removed. An Uninstall Complete dialog box verifies the removal of the TARA server.


http://tssprod.teradata.com:8080/TSFS/home.do


5 Click Finish.

6 The TARA Server - InstallShield Wizard dialog box appears.

7 Click Next. The license agreement appears.

8 To accept the agreement and install the TARA server, click Yes. The Choose Destination Location dialog box appears.



For an installation location different than what is shown in Destination Folder, click Browse and select an alternate location.

9 Click Next. The Start Copying Files dialog box appears.

10 Click Next if the destination folder is correct. The Setup Status dialog box displays installation status, then displays that installation is complete.

11 Click Finish.

12 At the command-line prompt, type t to install Tivoli, then click Enter.

There is no confirmation message of installation completion.

To install the TARA Tivoli Access Module

1 Double-click setup.exe.

If the TSM Backup-Archive Client 5.5 is not installed, a warning message appears.



Note: If the warning message appears, cancel installation and install TSM Client 5.5 before reinstalling the TARA Tivoli Access Module.


• If this is a new installation of the TARA Tivoli Access Module, proceed to step 3.

• If this is a reinstallation of tarativbar.13.00.00, or tarativbar.13.00.00 was previously removed with the Windows Add or Remove Programs, select Remove when the screen displays the choice of modifying, repairing, or removing the program.

InstallShield Wizard Completed verifies the removal of TARA TIVBAR. Go to step 14.

3 Click OK. The TARA TIVBAR welcome screen appears.



4 Click Next. A license agreement appears.

5 If you agree with the terms of the license, select the radio button indicating consent, then click Next. Destination Folder appears.



6 Accept the default destination, or click Change to browse for another folder. Click Next. Ready to Install the Program appears.

7 Click Install. Status of the installation is displayed. When installation is complete, a dialog appears indicating completed installation.

8 Click Finish. A command-line interface opens.

9 Choose the path for the baruser home directory, following these rules:

• Choose a folder that already exists.

• Include a drive letter, followed by a colon (:) at the beginning of the path.

• Include a backslash (\) at the end of the path.



The script automatically appends the name baruser to the path.

If no path is entered, the default path, C:\Documents and Settings\, is created.

10 Click Enter. The baruser directory is created.

11 At the prompt for the name of the TARA server host, enter the name of the BAR server where the TARA server is running. Click Enter.The default is localhost.

12 Click Enter to complete the postinstall script. A connection is made to the TARA server host.

13 Click any key to continue. InstallShield Wizard Completed appears.

14 Click Finish. The TARA Tivoli Access Module has been successfully installed.

To install the Teradata TARA GUI

1 From the Tivoli Storage Manager Teradata Extension CD, double-click Windows\TARA GUI\setup.exe.

Note: If this is a reinstallation of the TARA GUI, the prior copy will be removed. Click Finish to complete uninstallation, then double-click Windows\TARA GUI\setup.exe again.

2 The TARA GUI InstallShield Wizard welcome screen appears.



3 Click Next. The license agreement appears.

4 To accept the agreement and install the Teradata TARA GUI, click Yes. The Choose Destination Location dialog box appears.



5 For an installation location different than what is shown in Destination Folder, click Browse and select an alternate location. Otherwise, click Next. Start Copying Files is displayed with the specified destination.

6 Click Next if the destination folder is correct. The setup status is shown, then a message appears when installation is complete.

7 To create a shortcut icon on the desktop, select that option. Then click Finish.

The xinetd Process on Linux

The xinetd process is similar in functionality to the inetd process, which starts programs that provide Internet services. The xinetd process is automatically disabled. To enable xinetd in SUSE:


Chapter 2: Teradata TARA Installation and UninstallationInstalled Components

1 Click Control Center>YAST>Network Services (inetd).

2 Click Enable.

3 Click Finish, then OK.

The xinetd process is not necessary for Teradata TARA, however, it is vital for Tivoli software.

Installed Components

This section includes information on which items were installed and their location.

The install path for the TARA directories and files is:

• /opt/teradata/tara for Linux

• \Program Files\Teradata\Teradata TARA for Windows

The install path is referenced by install_path.

There are three TARA-related install packages:

• TARA server install package

• Teradata TARA GUI install package

• Tivoli Access Module install package

TARA Server Package

The Windows install package and Linux taraserver_postinstall.sh script take the actions described in Table 2 upon installation of the TARA server package.

Table 2: Actions Taken when TARA Server Package Installed

Action Details

Creates a new login account. The user specifies the account name and home directory; the defaults are taraserver and /home/taraserver.

Note: To install the TARA server on the same node as the Tivoli Access Module, do not change the TARA server's login information to baruser and /home/baruser. The packages cannot share the baruser account. Do not change the baruser account for the Tivoli Access Module. Instead, change the default taraserver account for the TARA server.

Sets up the TARA server to run as a service on the TARA server host.

None

Creates the TARA server install_path directory, /opt/teradata/tara/server.

Under this directory, the taraserver_postinstall.sh script creates the bin, jir, sr, logs, and config subdirectories, which are described in Table 3.


Chapter 2: Teradata TARA Installation and UninstallationInstalled Components

Teradata TARA GUI Package

When the Teradata TARA GUI package is installed, the Teradata TARA GUI install_path directory, /opt/teradata/tara/gui, is created.

Under this directory, the bin subdirectory is created. This subdirectory contains the files described in Table 4.

Table 3: Subdirectories of taraserver_postinstall.sh

Subdirectory Name Description of Subdirectory

/bin Contains the TARA server executable file, plus the executable files for those programs that are needed to support the TARA server. The executable files provide these command-line utilities:

• taralaunch

This utility launches a backup or restore job from the Script Repository on a specified TARA server.

• tarasetcfg

This utility causes the TARA server to reset its configuration parameters by reading the defaults configuration file again.

/jir This is the Job Information Repository. These are binary files that contain the most current results of each backup or restore job that the TARA server controls. These files are a combination of binary and ascii, and should not be viewed and edited through a manual editor.

/sr This is the backup/restore script repository for the TARA server. Edit these scripts with the Edit feature of the Teradata TARA GUI.

/logs Contains the trace entries that the TARA server generates. Normally, the trace level is set to minimum, but can be increased in the event that troubleshooting becomes necessary.

/config Contains the file named defaults. This file contains the default configuration parameters that the TARA server uses during initialization. Although this file is text-readable, it is advisable to modify it only through the Teradata TARA GUI, and not manually through a text editor.

Note: Specifying the size of the log file must be done manually in defaults.

Table 4: Files in bin Subdirectory

File Details

Teradata TARA GUI executable file

This file is called taragui.jar.

Script file The script file is called taragui and is located in /opt/teradata/tara/gui/bin. The user can launch the Java-based Teradata TARA GUI with the script file.

Execute taragui by entering one of the following:

• export DISPLAY=<your_IP_address or host_alias>

/opt/teradata/tara/gui/bin/taragui &

• cd /opt/teradata/tara/gui/bin

./taragui &


Chapter 2: Teradata TARA Installation and UninstallationUninstallation on Windows

The command-line utilities are useful for field personnel who might not have access to the Teradata TARA GUI.

Execute the command-line utilities by entering one of the following:

• /opt/teradata/tara/gui/bin/<utility name> <parameters>

• cd /opt/teradata/tara/gui/bin

./<utility name> <parameters>

Tivoli Access Module Package

The Windows install package and the Linux tivbar_postinstall.sh script take these actions upon installation of the Tivoli Access Module package:

• Creates a new login account. The user cannot modify the account name and home directory. The login account is baruser and the home directory is /home/baruser.

Note: To install the TARA server on the same node as the Tivoli Access Module, do not change the TARA server's login information to baruser and /home/baruser. The packages cannot share the baruser account. It is not possible to change the baruser account for the Tivoli Access Module, therefore change the default taraserver account for the TARA server.

• Copies runarctiv.bat to the baruser's home directory: /home/baruser.

• Sets up a path and symbolic link to allow access to the Tivoli Access Module's library file, libtivbar.so, which resides in /opt/teradata/tara/tivbar/lib.

• Creates the Tivoli Access Module install_path directory, /opt/teradata/tara/tivbar. Under this directory, the tivbar_postinstall.sh script creates the bin and lib subdirectories:

Uninstallation on Windows

During installation, Teradata TARA creates folders and registry entries under Program Files\Teradata\Teradata TARA, then copies required files under the folders.

When uninstalling Teradata TARA components, remove all of the folders and registry entries. This means, in some cases, that manual deletion is necessary in addition to using Windows Add or Remove Programs. Table 5 lists the folders that are created during installation, the

Subdirectory Name Description of Subdirectory

/bin Contains the executable files for those programs that are needed to support the Tivoli Access Module.

/lib Contains the Tivoli Access Module library file, libtivbar.so, which is used in conjunction with ARCMAIN during a Tivoli backup or restore job.

/logs Contains tivbar and taratddsmc log files.


Chapter 2: Teradata TARA Installation and UninstallationUninstallation on Windows

associated registry entries, and information on manually removing files, folders, and registry entries. Typically, manual deletion is necessary if files were manually modified.

Other folders and files that require manual deletion are:

• \home\baruser

• the defaults file in \config

Table 5: Folders and Registry Entries

Folder Created During Installation Registry Entry Created During Installation Manual Deletion During Uninstallation

gui HKEY_LOCAL_MACHINE\TERADATA\TARA Gui This folder and its registry entry are automatically removed during uninstallation.

However, if any of the files under this folder were manually modified, the file is retained with the folder and the registry entry is not deleted. Manually delete the folder and the registry entry.

server HKEY_LOCAL_MACHINE\TERADATA\TARA Server The uninstallation process does not automatically clear all folders and registry details. Manual deletion of files is necessary in some of the subfolders:

• bin

This folder is automatically removed during uninstallation.

However, if any of the files under this folder were manually modified, the file is retained with the folder. Manually delete the file and folder.

• config, jir, logs, sr

These folders are not automatically deleted. Manually delete these folders and registry entries.

tivbar HKEY_LOCAL_MACHINE\ TERADATA\tivbar This folder and its registry entry are automatically removed during uninstallation.

However, if any of the files under this folder were manually modified, the file is retained with the folder and the registry entry is not deleted. Manually delete the folder and the registry entry.


CHAPTER 3

TSM and Teradata TARA Configuration

Configure TSM before configuring Teradata TARA:

• Configure TSM for Teradata Backups

• Configure the TARA Server

• Configure the TARA Server GUI

To configure the size of the log file, add an entry in the defaults file. See Configure the Log File.

Configure TSM for Teradata Backups

A Teradata backup can be a backup of an entire Teradata Database, a selected database, or a selected table. To perform a Teradata backup, configure the TSM server first, the TSM client second, then set options for TSM.

TSM Server Configuration

Before performing any Teradata backups, ensure that the TSM policy objects and TSM client nodes are properly configured in the TSM server.

TSM Policy Objects

TSM policy objects manage how data is stored, where client data is stored, the number of maintained versions, and the length of time those versions are stored.

TSM allows a variety of configurations using TSM policy objects, but regardless of the configuration, Tivoli Storage Manager Teradata Extension requires a backup copy group policy object. The backup copy group policy object can be preexisting or newly-created, but only TSM backup object types are supported.

Table 6 lists TSM policy object fields that control the removal of inactive objects from storage. Objects become inactive when a backup is performed with the same name as an object that is already stored on the server. See “Overview of Backup Data Storage” on page 117.

Table 6: Fields to Consider for the Backup Copy Group

Field Description Default

Versions Data Deleted (VERDELETED)

Number of inactive versions, if active versions do not exist. 1


Chapter 3: TSM and Teradata TARA ConfigurationConfigure TSM for Teradata Backups

TSM Client Node

In the TSM software, by default, a client node can access only the backup storage objects that it creates. For instance, when a backup is performed on client node1, all ARCMAIN backups are registered in the TSM server catalog as belonging to node1 and all other nodes are prevented from accessing the storage objects created by node1. However, it is possible to grant authorization for nodes to access other backups by creating a pseudo node that is used by all clients performing backups.

To create a pseudo node, use the TSM register node command that provides the node name and password. Then set the BACKDELETE option to YES. If this option is not set to YES, backup objects cannot be deleted with the TDDSMC utility. For more information, see Appendix C: “The TDDSMC Administrative Utility”. For information about the TSM register node command, refer to the Tivoli Storage Manager Administrators Guide on the IBM Web site at http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

TSM Server Options

Depending on site requirements, the TSM server option values for the TSM server (dsmserv.opt) and the TSM Storage Agent (dsmsta.opt) might need adjustment. Table 7 describes these options.

Versions Data Exist (VEREXISTS)

Number of inactive versions, if active versions exist. 1

Retain Extra Versions (RETEXTRA)

Number of days to keep the last inactive versions, if active versions do not exist.

30

Retain Only Version (RETONLY)


60

Table 6: Fields to Consider for the Backup Copy Group (continued)


Table 7: TSM Server Options

TSM Server Option Description

COMMTIMEOUT Specifies how long the server waits for an expected client message during an operation that causes a TSM database update. If a message does not arrive before the specified wait period, the server ends the session with the client.

To prevent clients from timing out while backing up large files or during a heavy network load, increase the time-out value.

IDLETIMEOUT Specifies the amount of time, in minutes, that a client session can be idle before the server cancels the session.

To prevent clients from timing out due to a heavy network load in the environment, increase the time-out value.

Note: If the time-out value is increased, a large number of idle sessions could prevent other users from connecting to the server.


http://publib.boulder.ibm.com/tividd/td/tdprodlist.html

Chapter 3: TSM and Teradata TARA ConfigurationConfigure TSM for Teradata Backups

The TXNGROUPMAX option controls the number of files allowed in a transaction. Set this option to 4080. Although the maximum value allowed is 65000, TSM limits the number of objects restored at the same time to 4080 objects.

Tivoli Storage Manager Teradata Extension maps ARCMAIN backup files to a series of smaller storage objects or files segments with an object size of 2 GB. Therefore, the maximum size of a single backup cannot exceed 4080 * 2 GB, or approximately 8.1 TB.

TSM Client Options

Every time an archive or restore job is run, Teradata TARA creates an options file and sets DSMI_CONFIG to point to this file. Options provided through the Tivoli tab of the TARA Server Configuration dialog box (see “Step 4 - Configure Tivoli Information” on page 46) creates <job_id>.opt.

However, when a job requires overriding the node name and password, or requires more parameters, click ManagementClass in the Script Options dialog box when archiving (see step 9 on page 56). The Management Class Selection dialog box appears, in which the node name, password, and user parameters can be changed.

Table 8 describes client user and client system options files.

RESOURCETIMEOUT Specifies the maximum number of minutes that a storage agent waits for a resource on the server. The default value is 60 minutes. The minimum value is 1 minute.

TXNGROUPMAX Indicates the maximum number of logical files (client files) that a client can send to the server in a single transaction. The server might create multiple aggregates for a single transaction, depending on the size of the transaction.

Table 7: TSM Server Options (continued)



Chapter 3: TSM and Teradata TARA ConfigurationConfigure the TARA Server GUI

The Linux Client System File

Note: The TSM administrator gives the Teradata DBA write permission for dsm.sys, the client system file.

Configuration choices made through the Tivoli tab of the TARA Server Configuration dialog box are appended to dsm.sys. If only the existing information in dsm.sys is needed (that is, no configuration information should be appended to that file) enter the Server Name only in the Tivoli tab of the TARA Server Configuration dialog box. Leave all other boxes in the dialog box blank.

A <job_id>.opt file is also created, which contains the servername that points to the correct server stanza in dsm.sys. Teradata TARA sets DSMI_CONFIG to point to <job_id>.opt when a job runs.

Configure the TARA Server GUI

Use the Teradata TARA GUI for this procedure.

After opening the Teradata Tiered Archive/Restore Architecture dialog box, use this procedure to configure the TARA server on which the Teradata TARA GUI is installed.

Table 8: TSM Client Options File Characteristics

Operating System

TSM Client Options Files Description Directory or Folder

Linux dsm.sys Specifies client system options:

• Servers to contact for services

• Communications options for each server

• Authorization options

• Archive processing options

• Scheduling options

/opt/tivoli/tsm/client/api/bin/dsm.sys

<job_id>.opt Specifies client user options. /home/baruser

Windows <job_id>.opt


Chapter 3: TSM and Teradata TARA ConfigurationConfigure the TARA Server

To configure TARA server GUI

1 Click Settings>Graphical User Interface Configuration. The Graphic User Interface Configuration dialog box appears.

2 The localhost name is the default and appears in the TARA Server box when the GUI is first run. Enter another TARA server name if the server on which the Teradata TARA GUI is installed changes.

3 The TCP port on which the TARA server listens for GUI and ARC connections appears in the TARA Server Port Number box. The default is 54323 and appears when the GUI is first run. Enter another valid port number if necessary.

4 Click Apply to apply changes.

Configure the TARA Server

Use the Teradata TARA GUI for this procedure.

There is a required order of configuration after a new installation of Teradata TARA. The first time after installation, define at least one of each of the following components before proceeding to the next definition. Follow the order given below:

1 Teradata Database system (refer to “To configure the Teradata Database system” on page 42)

2 Clients system (refer to “To configure the client systems” on page 43)

3 Client Groups (refer to “To configure the client groups” on page 45)

4 Tivoli information (refer to “To configure Tivoli information” on page 46)



Click Refresh to populate the Client-Management Class Association and Available Management Classes columns.

Note: Do not click Apply until you have completed these four steps. Applying these changes before defining the Tivoli information results in an external query failure.

Step 1 - Configure the Teradata Database System

After a new installation of Teradata TARA, the first step to configuring the TARA server is defining the Teradata Database system. Refer to Configure the TARA Server for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration.

To configure the Teradata Database system

Click Teradata Tiered Archive/Restore Architecture>Settings>Server Configuration. The TARA Server Configuration dialog box appears with the Teradata tab selected by default.




• From the Teradata System list, select the Teradata Database system to configure for the TARA server. The list contains display names, not TDPID names.

• Click New to add a Teradata Database system name. To remove a name from the list, select the name, then click Remove.

2 In Display Name, type the name that should appear for this TDPID within the Teradata TARA GUI environment. Usually, the display name and the Teradata TDPID name are the same.

3 In Teradata TDPID, type the Teradata Database machine name. Usually, the display name and the Teradata TDPID name are the same.

4 Enter a Browse user name in Browse User and an associated password in Password; both must be valid within the target Teradata Database. The Browse user and password form the Teradata Database logon information that the TARA server uses to query the Teradata Database.

5 Enter an ARC user name in ARC User and an associated password in Password; you must have backup and restore privileges for the ARC User name that you specify.

6 Click Single stream or Multi stream. For Multi stream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams.

7 In Default Session Count, the default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions are a waste of resources as some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail.

8 Select the Clients tab of the TARA Server Configuration dialog box, then go to To configure the client systems.

Step 2 - Configure the Client Systems

After a new installation of Teradata TARA, the second step to configuring the TARA server is defining the client systems. Refer to “Configure the TARA Server” on page 41 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration.

To configure the client systems

Select the Clients tab of the TARA Server Configuration dialog box.




• Select a client system from the Client System list.

• Click New to indicate information for a new client system.

To remove a client system from the configuration, select the client system from the Client System list, then click Remove.


• In Display Name, enter the client name that should appear for this client within the Teradata TARA GUI environment. (It is not necessary for the display name to match the system name.)

• Click New to change the client system information. The Display Name box now displays New Client Machine. Enter a new display name in the box.

3 Enter the system name of the client node in Client Machine Name.

4 Enter the maximum streams per job in Max Streams Per Job.



Each stream is a portion of the entire backup job and consists of an ARCMAIN process sending to or receiving from Tivoli.

5 Select the Client Groups tab of the TARA Server Configuration dialog box, then go to To configure the client groups.

Step 3 - Configure the Client Groups

After a new installation of Teradata TARA, the third step to configuring the TARA server is defining the client groups. Refer to “Configure the TARA Server” on page 41 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration.

To configure the client groups

Select the Client Groups tab of the TARA Server Configuration dialog box.




• From the Client Group list, select a client group.

• Click New to add a new client group to the configuration.

To remove a client group from the configuration, select the group in the Client Group list, then click Remove.

2 In the Display Name box, type the client group name that should appear for this client group within the Teradata TARA GUI environment. It is not necessary for the display name to match the system name.

3 The Selected Clients column contains the clients that have been added to a client group. To remove a client from the group, highlight the client, then click Remove. The client name is then transferred to the Available Clients column.

4 The Available Clients column contains the clients that can be added to a client group. Highlight the client, then click Add. The client name appears in the Selected Clients column.

5 To move a client up in the order in which it is used for backup, highlight the client in the Selected Clients column, then click Move Up. If there are more clients than streams, the client that appears first will be used for backup.

The first client defined becomes the ARC master in a multi-stream job. The remaining clients rely on the ARC master to provide direction on what and how to run the backup or restore operation.

To move a client down in the order in which it is used for backup, highlight the client in the Selected Clients column, then click Move Down.

6 Select the Tivoli tab of the TARA Server Configuration dialog box, then go to To configure

Tivoli information.

Step 4 - Configure Tivoli Information

After a new installation of Teradata TARA, the fourth step to configuring the TARA server is configuring Tivoli information. This configuration information will be included in <job_id>.opt, the TSM client options file that is dynamically created when a TARA job is launched.

Refer to “Configure the TARA Server” on page 41 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration.

To configure Tivoli information

Select the Tivoli tab of the TARA Server Configuration dialog box.




• Click ConfigureLANFree for LAN-free mode, which is recommended for TSM. The LAN Free dialog box appears. Proceed to step 2.

• Clear the Enable LAN Free button for LAN mode. Proceed to step 4.

2 Select the communication method between the storage agent and the client from CommMethod.



Note: For Linux systems operating in LAN-Free mode, select TCPIP. The Shared Memory communication method is not supported. For more details, refer to IBM Tivoli Storage Manager 5.5 Administrator's Guide.

3 Depending on the communication method selected, in:

• TCPPort, enter the TCP port to be used for communication between a client and the storage agent

• SHMPort, enter the Shared Memory port to be used for processing between a client and the SAN-attached storage device

• NamedPipeName, enter the name of the named pipe to be used for communication between the client and the storage agent

Click OK.

4 In Server Name, enter the name of the TSM server instance. If the TSM client is on Linux, the server name identifies the TSM server stanza, as listed in dsm.sys.

5 In TCPServer Address, the address of the TSM server is displayed. Or, enter another address.

6 Communication methods listed in the Communication drop-down list enable communication between the TSM server and the client:

• If LAN-free mode is enabled on Windows, TCPIP is the only allowed communication protocol. Port is the server’s TCP/IP port address. The default value is 1500.

• If Sharedmem is selected (for Linux operating systems), Port is the port address where the TSM server establishes a Shared Memory connection.

• If Namedpipes is selected, Name becomes enabled. Enter the name of the named pipe.

7 Enter the TSM client node name in Node Name. The node name is in the TSM options file. The node name identifies the workstation to the TSM server.

8 Enter the password assigned to the TSM client node in Password.

9 (Optional) In User Parameters, enter any other TSM client options, for example tcpwindowsize 63 or diskbuffsize 64.

Refer to “TSM Client Options” on page 39 and Tivoli documentation for other client options.

10 In the Client Group drop-down list, the client group that was configured using the Client Groups tab appears. Or, select another group from the drop-down list and click Refresh to refresh the list of available clients under Client-Management Class Association.

Click Default to set the client group displayed in the Client Group drop-down list the default.

11 The Enter Management Class Name drop-down list contains management classes listed in Available Management Classes.

To add or delete existing management classes, do one of the following:

• To add a management class, enter the name. Click to add the management class to the Available Management Classes list.

• To delete a management class, select it from Enter Management Class Name and click to delete it from the Available Management Classes list.



12 Client-Management Class Association lists the management classes that have been added to a client node. Expand the tree next to the client name to view the management class.

13 Do one of the following to add or delete a management class:

• To add a management class to the client node, highlight the:

• Client in Client-Management Class Association• Management class in Available Management Classes

Click Add. The management class is added to the client.

• To delete a management class from the client, highlight the management class listed under the client in Client-Management Class Association. Click Remove.

14 (Optional) Do one of the following to change the order in which a management class is used for a backup or restore job:

• To move a management class up, highlight it in the Client-Management Class Association list. Click Move Up. If there are more management classes than streams, the management class that appears first will be used for the backup or restore job.

• To move a management class down, highlight it in the Client-Management Class Association list. Click Move Down.

15 Click Apply to apply changes.

Select the ARC Options tab of the TARA Server Configuration dialog box, then go to To configure ARC options.

Step 5 - Configure ARC Options

If this is a new installation of Teradata TARA, configure ARC options only after you have completed the first four steps described in “Configure the TARA Server” on page 41. If this is not a new installation of Teradata TARA, there is no required order of configuration.

To configure ARC options

Select the ARC Options tab in the TARA Server Configuration dialog box.



1 [Optional] Select Use Catalog to specify positioning data, so that when an object is restored, Tivoli can locate it without searching the entire tape.

2 [Optional] Select Use Checksum Verification to verify that what it is archiving or restoring is valid data.

3 [Optional] Select a character set other than ASCII in the Default Character Set list.

ASCII is the default.

Refer to Teradata Archive/Recovery Utility Reference for details on valid ARCMAIN command-line options.

4 [Optional] In Extra ARC Options, enter any ARCMAIN command-line options that are

not part of the GUI ARC build flow.

Step 6 - Configure Logging

If this is a new installation of Teradata TARA, configure logging only after you have completed the first four steps described in “Configure the TARA Server” on page 41. If this is not a new installation of Teradata TARA, there is no required order of configuration.


Chapter 3: TSM and Teradata TARA ConfigurationConfigure the Log File

The logging levels of the individual components of the TARA server are pre-set and cannot be changed from the GUI unless the Override Global Log Level check box is selected. When the box is selected, Global Log Setting is unavailable and logging for each TARA server component can be customized. Do not customize the logging settings unless Teradata Global Support recommends it.

The Global Log level is pre-set to 0. This is the minimum, or normal, log level. The maximum level is 5. Increasing the Global Log level adds verbosity to the log for each of the TARA server components.

Configure the Log File

The default size of the Linux TARA server's logs file is 2GB. When this limit is reached, the TARA server resets the file to a length of 0 before writing more log entries.

Adjust the logs file maximum length to a value less than 2GB by adding an entry within the [Defaults] stanza of the /opt/teradata/tara/server/config/defaults file:

filesize=numofbytes


Chapter 3: TSM and Teradata TARA ConfigurationConfigure the Log File

For example, to set the log file size to exactly 500MB (500 * 1024):

filesize=524288000

Do not set the value greater than 2GB. Doing so can cause the TARA server to become unresponsive.


CHAPTER 4

Backup and Restore Using the GUI

After completing installation and configuration, start Teradata backup and restore operations through the Teradata TARA GUI:

• Starting the Teradata TARA GUI

• Archiving a Database Object

• Restoring a Database Object

• Viewing Job History

Starting the Teradata TARA GUI

To start the Teradata TARA GUI

1 To check the status of the TARA server service, type:

/etc/init.d/tdtaraserver status

2 To start the TARA server service, type:

/etc/init.d/tdtaraserver start

3 To start the Teradata TARA GUI:

• For Linux, type one of the following:

• /opt/teradata/tara/gui/bin/taragui &

• cd /opt/teradata/tara/gui/bin./taragui &

• For Windows, do one of the following:

• Double-click on if you installed the TARA GUI icon on your desktop.

• Click Start>All Programs>Teradata Client>TARA GUI.The Teradata Tiered Archive/Restore Architecture dialog box appears.


Chapter 4: Backup and Restore Using the GUIArchiving a Database Object

Archiving a Database Object

To archive a database object

Use the next procedure to run an archive operation.

1 Click Teradata Tiered Archive/Restore Architecture>Task>Archive. The Log on to Teradata DBS dialog box appears.

2 To log on to a Teradata Database, select it from the TDPID list.

3 Type a user account name for the Teradata Database in the UserID box.

4 Type the password for the user account in the Password box, then click Connect. The ARCHIVE object selection dialog box appears.

5 In the left and right panes are database objects that are available for archival. To archive a database, highlight or select the box next to the database in the left pane. The tables of the database to be archived appear in the right pane, as shown in the next screen capture. The screen capture shows a database example without a hierarchical view. If the database:

• Has a hierarchical view, go to step 6.



• Does not have a hierarchical view, skip to step 7.

6 This screen capture shows a database with a hierarchical view. Click on a level in the left pane. The database and tables appear in the right pane.

7 Right-click on a table in the right pane, then click Options. A dialog box for Partitioned Primary Index (PPI) options appears for that table.



8 Under Partition selection, click on one of the radio buttons:

• Full table, which is the default, archives the entire table

• All Partitions option is not valid for archive operations

• Selected Partitions archives the specified partitions

Other PPI Options is not valid for archive operations.

9 From the ARCHIVE object selection File menu, click Build ARC script or click . The Script Options dialog box appears.



10 Select options:

Option Description

Job Name Entries in Job Name are case-sensitive. A job name must not contain any spaces, or these characters:

<

>

~

"

*

,

?

.

\

/

Description

TDPID The entry in this box reflects the TDPID with which you logged on. It is not possible to change the TDPID.

User Name The user name with which you logged on appears. To create another job for the specified database, type a new user name.



Password The password with which you logged on appears. To create another job for the specified database using another user name and password, type the new password.

Single stream or Multi stream

Click Single stream or Multi stream. For Multi stream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams.

Default Group The list defaults to all clients, that is, no client group. If there are many clients, select a name from the list of available client groups. Using a client group reduces the amount of selections needed when building a new archive/restore job.

Assign Clients Each stream is defaulted to All clients. Click Assign Clients to assign a specific client (or a specific client group) to each stream.

Configure

Protegrity Encryption

(Optional) Select ProtegrityEncryption to encrypt the job. AES128 is the default encryption algorithm. Or, select AES256 or PANAMA from the drop-down list.

QueryBanding (Optional) Select QueryBanding. In the QueryBanding box, specify one or more pairs of names with associated values to identify the source of a query. This allows setting different priorities for different requests, and the ability to make better use of system resources.

For example, enter a name and value pair, ending with a semi-colon:

aaa=bbb;ccc=ddd;

Note: Teradata Tools and Utilities12.00.00 and later is required for the query banding feature. Additionally, the backup must be between two TTU 12.00.00 systems for the query banding feature to work correctly.

See Teradata Archive/Recovery Utility Reference for more information on query banding.

Online Backup (Optional) Select Online Backup to archive rows from a table at the same time update, insert, or delete operations on the table are taking place. When an online archive is initiated on a table or a database, a log is created for the specified table or separate logs are created for each table in the specified database. The log, which contains all changes to the table, is saved as a part of the archive process. When the table is restored or copied, the changes recorded in the log are used to roll back those changes in the table. The table is rolled back to the point that was established when online archive logging was started on that table.

Note: Teradata Tools and Utilities12.00.00 is required for the online backup feature. Additionally, backups must be between two TTU 12.00.00 systems.

See Teradata Archive/Recovery Utility Reference for more information on online archive.

Option Description



11 Click Save, then Execute.

The Teradata Tiered Archive/Restore Architecture dialog box displays the launched job. Under the jobname, each of the job's streams appears. To view the ARC progress for the streams, double-click on one of the streams. In the next example, the State column indicates that Stream 1 has table data. The state conditions are:

• (B): Build phase (only for restore operations)

• (D): Dictionary (for archive and restore operations)

• (T): Table Data (for archive and restore operations)

Sessions (per stream)

The default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions waste resources because some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail.

Extra Options (Optional) Enter any ARCMAIN command line options that are not part of the GUI ARC build flow. IOTRACE=5, a debug parameter that ARCMAIN uses to enable a level of tracing, is the default.

Backup Application

The default is Tivoli.

Use Catalog (Optional) Select Use Catalog to specify positioning data, so that when an object is restored, Tivoli can locate it without searching the entire tape.

Note: Teradata Tools and Utilities12.00.00 and later is required for the catalog feature.

Verify Checksum (Optional) Verify Checksum verifies that what it is archiving or restoring is valid data. The checkbox is selected by default.

Character set The default is ASCII. Select another character set if appropriate.

ManagementClass

Click to display the Management Class Selection dialog box. Select one of the following:

• A group from Use Configuration from Group

• A management class for a stream after selecting Manual Selection

Other Buttons

Save Click Save to accept the current script.

Execute Click Execute to launch the job.

Preview (Optional) Click Preview to open the Script Editor dialog box and display the job script. The job script can be edited, then saved. Click Launch to launch the job.

Close Click Close to close the Script Options dialog box.

Option Description


Chapter 4: Backup and Restore Using the GUISelecting Individual Objects to Archive or Restore

Selecting Individual Objects to Archive or Restore

Beginning with Teradata Database 13.0, selecting an individual view, macro, procedure, or other Teradata object to archive or restore is valid. Prior to Teradata TARA 13.0, archiving and restoring was limited to databases and tables.

The prerequisites for this feature are:

• TARA 13.0

• Teradata ARC 13.0

• Teradata Database 13.0

In the next screen example, the FindExRex function in the guest database is the only object selected for archive.


Chapter 4: Backup and Restore Using the GUISelecting Individual Objects to Archive or Restore

Table 9 lists the icons that represent the objects.

Table 9: Object Icons

Icon Object

Database

Function

Index

Join Index

Journal

Macro


Chapter 4: Backup and Restore Using the GUIRestoring a Database Object

Restoring a Database Object

To restore a database

Use the next procedure to run a restore operation.

1 Click Teradata Tiered Archive/Restore Architecture>Task>Restore. The RESTORE object selection dialog box appears.

Procedure

Table

Trigger

View

Table 9: Object Icons (continued)

Icon Object



In the left pane are datasets (jobs). The names underneath the Datasets icon are backup

images and are listed in chronological order (earliest image to latest image). Click to the left of the dataset name to expand the tree further.

2 To restore a job, select the box next to it. The name of the specified object appears in the upper right pane, and the Backup Application name in the lower right pane under Details. The screen capture shows a database example without a hierarchical view. If the database:

• Has a hierarchical view, go to step 3.

• Does not have a hierarchical view, skip to step 4.

Double-click on the icon to the left of the object name to expand the tree and show the specific tables to be restored.

3 This screen capture shows a database with a hierarchical view. Double-click to navigate to a level in the left pane. The job and its tables appear in the right pane.



4 Right-click on the database icon or table in the right pane. A dialog box for copy and Partitioned Primary Index (PPI) options appears.

5 The options for the COPY options tab are:



Checking any of the boxes on this tab automatically selects the COPY script option of the Script Options dialog box for restore operations.

6 On the PPI options tab, under Partition selection, click on the radio button for one of these three options:

• Full table, which is the default, restores the entire table

• All Partitions restores all partitions

• Selected Partitions restores the specified partitions

Under the Other PPI Options portion of the dialog box, select the LOG WHERE box to specify rows to be logged to an error table for manual insertion and deletion. Select the Error table name box to enter a table name other than the default name that is shown.

Note: All PPI options are valid when restoring a table. Only the All Partitions option is valid when restoring a database.

7 Click RESTORE object selection>File>Build ARC script. The Script Options dialog box appears.

Option Description

Rename Object Gives the object in the archive a different name from the target object.

Disable fallback on table (NO FALLBACK)

Copies fallback tables into non-fallback tables. If the archived table is already non-fallback, this option has no effect.

Disable journaling on table (NO JOURNAL)

Copies all tables with journaling disabled, whether journaled in the archive or not.

Replace table creator value (REPLACE CREATOR)

Replaces the LastAlterUID, creator name, and Creator ID of the tables in the target database with the user ID and the current user name, that is, the user name specified in the LOGON command.

Specify different journal table

Specifies that a copied database has journaling for the specified database and journal table.

APPLY TO list Identifies the tables in the target system where the change images apply.



Select options:

Option Description

Job Name Entries in the Job Name box are case-sensitive. A job name must not contain any spaces, or these characters:

<

>

~

"

*

,

?

.

\

/

Note: Scripts that are created or modified manually are not checked to see if the name contains spaces or the characters listed above.

Description

TDPID This list reflects the TDPID with which you logged on. To restore a database or table from one Teradata Database to another Teradata Database, select another TDPID from the list of TDPIDs.



User Name The user name with which you logged on appears. To create another job for the specified database using another user name and password, type the new user name.

Password The password with which you logged on appears. To create another job for the specified database using another user name and password, type the new password.

SingleStream or MultiStream

Click SingleStream or MultiStream. For MultiStream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams.

It is possible to specify fewer streams when restoring a job than were specified when the job was archived.

Default Group The list defaults to all clients, that is, no client group. If there are many clients, select a name from the list of available client groups. Using a client group reduces the amount of selections needed when building a new archive/restore job.

Assign Clients Each stream defaults to All clients. Click Assign Clients to assign a specific client to each stream.

Configure

RestoreScript The RestoreScript radio button is automatically selected.

CopyScript To copy, instead of restore an object, click CopyScript.

QueryBanding (Optional) Select QueryBanding. In the QueryBanding box, specify one or more pairs of names with associated values to identify the source of a query. This allows setting different priorities for different requests, and the ability to make better use of system resources.

For example, enter name and value pairs, ending with a semi-colon:

aaa=bbb;ccc=ddd;

Note: Teradata Tools and Utilities 12.00.00 and later is required for the query banding feature. Additionally, the backup must be between two TTU 12.00.00 systems for the query banding feature to work correctly.

Sessions (per stream)

The default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions waste resources because some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail.

Extra Options (Optional) Enter any ARCMAIN command line options that are not part of the GUI ARC build flow. IOTRACE=5 is the default.

Option Description



8 In the Script Options dialog box, click Save, then Execute.

9 The restore job status appears in the Teradata Tiered Archive/Restore Architecture dialog box.

Use Catalog (Optional) Select Use Catalog to specify positioning data so that when an object is restored, Tivoli can locate it without searching the entire tape.

Note: Teradata Tools and Utilities12.00.00 and later is required for the catalog feature.

Verify CheckSum (Optional) Select this check box to verify that what it is archiving or restoring is valid data.

Skip Build Steps (Optional) Select this check box to skip the build steps, which Tivoli considers idle time. If you skip the build steps now, manually run the build step outside of Tivoli after all data is restored.

CharacterSet The default is ASCII. Select another character set if appropriate.

Extra Buttons

Save Click Save to accept the script options that have been selected.

Execute Click Execute to launch the job. The job appears in the Teradata Tiered Archive/Restore Architecture dialog box.

Preview (Optional) Click Preview to open the Script Editor dialog box and display the job script. Make any corrections, then click Save in the Script Editor dialog box, then Launch to launch the job.

Close Click Close, but do not click Save, to close the dialog box without saving any changes.

Option Description



To restore a multistream archive with fewer streams

To restore a database or table from a multistream backup when one or more of the disk or tape storage devices is unavailable, divide the restore into two or more jobs. In the next example, the database BAR_AC backup was created using four streams. Only two storage devices are available, therefore streams 1 and 2 are restored in the first job, and streams 3 and 4 in the second job.

1 Click Teradata Tiered Archive/Restore Architecture>Task>Restore. The RESTORE object selection dialog box appears.

2 Select the object to restore, then File>Build ARC Script. The Script Options dialog box appears.

3 Type a job name.

4 In Multi stream, change the number of streams to the number of streams that are available. In this example, two streams are specified.

5 Select the Skip Build Steps check box. The build step must be done only by the last restore job for this database, or separately, after all restore jobs have completed.

6 Click Save, then Execute.



To display information on the job progress, double-click the job or stream. A dialog box appears. Select a stream to display its information in the bottom pane of the dialog box.

7 Create a new job for the remaining streams by editing the script for the job that just completed. Click Teradata Tiered Archive/Restore Architecture>Options>Edit or Preview in the Script Options dialog box. The Script Editor dialog box appears.

8 Add the keyword STREAMNAME for each stream included in this job. The value of each STREAMNAME keyword is the name of each of the remaining streams.

In the following example, the job restores the remaining two streams of the database BAR_AC backup.


Chapter 4: Backup and Restore Using the GUIViewing Job History

Note: In the example, the NO BUILD statement is not removed from the script, therefore a separate ARCMAIN build will be required after job completion. If the NO BUILD statement were removed from this script, ARCMAIN would automatically perform the build step.

9 Save the job with a name different from the original job name, then click Launch.

View the job in the Teradata Tiered Archive/Restore Architecture dialog box and the Job History dialog box.

Viewing Job History

To view job history, click Teradata Tiered Archive/Restore Architecture>Task>Job Viewer. There can be large amounts of job data, which is time-consuming to search. Export functionality, described in the next procedure, makes the task easier by placing the information into html table format. Then, a search can be quickly done for any value in the table.


Chapter 4: Backup and Restore Using the GUIViewing Job History

To export job data in html format

1 Click Teradata Tiered Archive/Restore Architecture>Task>Job Viewer. The Job History dialog box opens.

2 Click Job History>File>Export list to html. The Save dialog box opens. Save the html file in any location.


CHAPTER 5

Taratddsmc Command-Line Utility

The taratddsmc command-line utility allows database administrators and TSM administrators to delete backup objects from TSM and:

• View Teradata backups in the TSM server catalog (the client node and file spaces associated with those backups are displayed, not the actual files in storage)

• Perform maintenance activities on backups

• Generate reports about specific backup images created by Tivoli Storage Manager Teradata Extension

For more information, see:

• Overview of taratddsmc

• Installation

• Command Line Parameters

• Syntax Conventions

• Format Specifiers

• Taratddsmc Help Command

• Query TSM Command

• Prompt Off Command

• Query Backup and Query Object Commands

• Delete Backup and Delete Object Commands

• Inactivate Backup and Inactivate Object Commands

Overview of taratddsmc

The TARA Tivoli Access Module stores the generation number for each backup internally. That number can be displayed:

• In the Details pane of the RESTORE object selection dialog box

• With the TSM backup name and other details when a taratddsmc query command is issued on a backup (see “Syntax Conventions” on page 75 for details)

When a backup job fails, Teradata TARA does not make an entry in the jir file and the job is not displayed in the Details pane of the RESTORE object selection dialog box. However, the job’s backup name is listed in the TSM database with segment F0000. The job contains zero bytes.


Chapter 5: Taratddsmc Command-Line UtilityInstallation

Use taratddsmc to delete the failed backup (segment F0000) and clear the TSM database of incomplete backups.

Note: If taratddsmc or another TSM tool is used to delete a valid backup job (that is, a job that did not fail) in the TSM database, that job continues to be displayed in the RESTORE object selection dialog box. There is no mechanism to notify Teradata TARA of the deletion.

Installation

Taratddsmc and tarativadm.bat are installed at <destination_path>\Teradata\TARA\Tivbar\bin. To run taratddsmc:

1 Run tarativadm.bat to correctly set the environment variables.

2 In tarativadm.bat, set the DSMI_CONFIG path to point to the correct options file (.opt). Set the DSMI_DIR path to point to the correct .sys file.

3 Modify other values in tarativadm.bat if necessary.

4 Start taratddsmc through batch mode or interactive mode by typing the following at the command line:

taratddsmc [options] [command]

In batch mode, a single command for execution is included on the command line. Interactive mode occurs when no command is included on the command line. In interactive mode, taratddsmc prompts for input until a quit command is entered.

Each time taratddsmc is started, a TSM server session is opened. In interactive mode, a single session is used for all commands. In batch mode, a different session is opened and closed each time taratddsmc is started.

The next example shows variations of command line options for batch and interactive mode.

Taraddsmc query backup *Taraddsmc ?Taraddsmc> query tsmTaraddsmc> query backup fin*Taraddsmc> quitTaraddsmc -noheader query backup dbl_???? | sort /+30 /R >backup.txt

The prompt in interactive mode is shown as taratddsmc> . The last line of the example shows how to override the default sort order of the QUERY BACKUP command by piping output to the Windows sort utility.

Command Line Parameters

All the IOPARM parameters that are described in the “Parameter Definitions” on page 125, can also be entered as command line parameters in taratddsmc. Adding a prefix to each field


Chapter 5: Taratddsmc Command-Line UtilitySyntax Conventions

name with a leading hyphen (-) makes command line options easy to distinguish from taratddsmc commands.

Use the IOPARM string specification from an ARCMAIN job as a command line option to taratddsmc. An example of an acceptable string specification is:

taratddsmc -ioparm’config=mydsm.opt,mgmtclass=mymgmtclass q ba *’

Syntax Conventions

The taratddsmc utility uses these commands:

• DELete Backup <pathname> [generation]

• DELete OBJect <pathname> <generation> <segname>

• FORMAT <formatstring>

• HELP <command-type>

• INActivate BAckup <pathname>

• INActivate OBJect <pathname> <segname>

• PROMPT [ ON | OFF ]

• QueRY BAckup <pathname> [generation] [formatstring]

• QueRY OBJect <pathname> [generation] [segname] [formatstring]

• QueRY TSM

• QUIT

The commands follow the rules described in “Syntax Rules” on page 124, plus the following syntax and semantics:

• Uppercase letters denote the shortest acceptable abbreviation of a command.

For example, express QueRY as QUERY, QRY, or Q. Commands that are entirely uppercase cannot be abbreviated.

• Formatstring means that a quoted string value is expected.

• Name means that a name value is expected using general syntax rules.

• Commands are not case-sensitive.

In the next example, the user-supplied namepattern is required, but the gen and formatstring tokens are optional. The number of blanks or white space characters between keywords and tokens does not matter as long as the entire command is on a single line:

QueRY BAckup namepattern [ gen ] [ formatstring ]

Add comment lines in scripts by putting an asterisk (*) as the first non-blank character on a line. All-blank lines are echoed to the output stream.


Chapter 5: Taratddsmc Command-Line UtilityFormat Specifiers

Format Specifiers

Format string and format specifiers control the display output of the QUERY BACKUP and QUERY OBJECT commands. Any characters not contained within a format specifier are passed and displayed as is. For example, to produce Cr Time JJ BackupName, type:

%crdate% JJ %name%

Note: One exception to this rule is that the literal “\t” character sequences are translated to tab characters. To generate tab-delimited output files, type: ‘%crdate%\t%name%\t%size%’.

Override the default field width of any of these metadata files by including a colon (:) and an integer width value inside the end delimiter. Positive width values are right-justified and negative width values are left-justified.

Table 10 lists metadata fields, plus default widths, headings, and format specifiers.

Table 10: Metadata Fields

FieldDefault Width Heading Format Specifier

Active/Inactive State -1 A/I %status%

Backup name (high-level) -30 Backup Name %name%

Compressed/Uncompressed -1 C/U %compress%

Creation Date (YYYY-MM-DD format) -10 Cr Date %crdate%

Creation Time (HH:MM:SS format) -8 Cr Time %crtime%

Expiration Date (YYYY-MM-DD format) -10 Expire %exp%

Filespace Id 9 FS ID %fsi%

Filespace Name -30 FS Name %fs%

Generation Number 4 Gen %gen%

Management Class -30 Mclass %mc%

Media Class (such as, library, fixed-disk, off-site) -12 Media Class %media%

Number of file segments 4 # Seg %segcnt%

Segment Name (low-level) -30 Seg Name %segname%

Total size in MB 9 Size (MB) %size%


Chapter 5: Taratddsmc Command-Line UtilityTaratddsmc Help Command

Examples

The %name:15% specifier:

• Restricts the name field to 15 characters and right-justifies the string in the field.

• Has the same field width, but strings are left-justified in the field. Values longer than 15 characters are not truncated, but do skew the alignment on the line. The maximum field width is 255 characters.

Next is an example of a command and the report it generates. The report shows that values longer than the specified width are not truncated, but the alignment is skewed.

taratddsmc> q ba * * ‘%crdate% %crtime% %name:-15% %gen% %status%

Retrieved 17 records filtered to 8 backups

Taratddsmc Help Command

The Help command causes taratddsmc to display syntax information for the defined command type. If no command is entered or an invalid command is entered, it is equivalent to HELP HELP.

To access taratddsmc help, do one of the following:

• Start taratddsmc with a question mark character (?). On the command line, type:taratddsmc ?

When taratddsmc help is started with a question mark (?), the utility does not attempt to open a session with the TSM server.

• In interactive mode, type:

TARATDDSMC> Help

These Help commands are available:

• Help CMD displays syntax information for taratddsmc commands.

• Help FORMAT displays syntax information related to format strings.

• Help Help defines the various HELP commands that can be issued.

• Help TARATDDSMC displays information about the taratddsmc command line.

Cr Date Cr Time Backup Name Gen A/I

2008-08-15 15:01:14 new-multi_DSTREAM0001 2 A

2008-08-15 13:34:50 new-multi_DSTREAM0001 1 I

2008-08-15 15:01:56 new-multi_DSTREAM0002 2 A

2008-08-15 13:35:27 new-multi_DSTREAM0002 1 I


Chapter 5: Taratddsmc Command-Line UtilityQuery TSM Command

Query TSM Command

QUERY TSM displays information about the current session configuration settings. This is the same information that is written to the log file when diagnostic tracing is enabled. Sample output from the command is shown in the following report.

The QUERY TSM command output is divided into three sections.

The first section displays client-side options that connect the TSM server. For example, the first two lines indicate the environment variables currently in effect.

The nodeName field indicates the client node name that opens the TSM server connection. When using multiple node names to store Teradata backups, any QUERY BACKUP and QUERY OBJECT commands restrict access to only the backup created by this node.

DSMI_DIR - C:\Program Files\Tivoli\TSM\api

DSMI_CONFIG - C:\Program Files\Tivoli\TSM\baclient\dsm.opt

Note: This path can vary according to the value set in tarativadm.

serverName - SERVER1

commMethod - TCP/IP

serverAdrress - 188.88.88.888

nodeName - NODE1

compress - 0

compressalways - 1

passwordAccess - PROMPT

Server name - SERVER1

Server Host - 188.88.88.888

Server port - 1500

Server type - Windows

Servr Date/Time - 2004-01-29 17:22:08

Servr Release - 05.02.02.01

Client node type - Teradata

Client filespace delimiter - :

Client h1 and 11 delimiter - \

Client delete backup obj? - No

Maximum objects in txn - 4080

Client Node Name - PINOT

Session Owner -

API Config file -

Policy Domain - STANDARD

Management Class - STANDARD

Backup retention grace period - 30 days


Chapter 5: Taratddsmc Command-Line UtilityPrompt Off Command

The other two sections of the QUERY TSM output describe the context of the TSM server session. Use this information to determine whether you are connecting to the correct TSM server, default management class, and so on.

For more information about field display, refer to these IBM manuals:

• Tivoli Storage Manager for Windows: Administrator’s Guide: Version 5, Release 5

• Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 5

Prompt Off Command

The PROMPT OFF command disables the taratddsmc> prompt. Using this prompt might make the taratddsmc output a bit more readable if I/O re-direction is used to pass an entire script of taratddsmc commands to the utility and save the results in a file.

Reenable the prompt with the PROMPT ON command.

Query Backup and Query Object Commands

The QUERY BACKUP and QUERY OBJECT commands print a formatted report about Teradata objects in storage that match an identified search pattern. The syntax is shown below.

Note: QUERY OBJECT shows one record per storage object whereas the QUERY BACKUP command aggregates totals to have one record per Teradata backup generation.

QueRY BAckup namepattern [ gen ][ formatstring ]QueRY OBJect namepattern [ gen ][ segnamepattern ][ formatstring ]

The node name context is established at session logon. Tivoli API limitations cause case-sensitive matching on the name patterns.

The optional gen field filters output to specific backup file generations. The default value of zero for the gen field restricts output to only the most recent generation of a backup. An asterisk (*) character in the gen field qualifies for all versions of the qualified backups. Relative generation numbers, such as -1 for the second-to-last most recent backup, can also be indicated.

The segname pattern refers to a segment number (F0000 through F9999). An asterisk (*) character in the segname pattern field returns all segments for a given object.

For example, QRY OBJ span* 2 *1 returns segment F0001 for generation 2 of all objects matching the span pattern.

If a format string is not specified in the command, the current default determined from the FORMAT command line option is used. For further explanation on format strings, see “Format Specifiers” on page 76.


Chapter 5: Taratddsmc Command-Line UtilityDelete Backup and Delete Object Commands

Delete Backup and Delete Object Commands

The DELETE BACKUP and DELETE OBJECT commands expire, then remove the qualified objects from storage.

DELete BAckup namepattern [ gen ]DELete OBJect namepattern [ gen ] segnamepattern

Inactivate Backup and Inactivate Object Commands

The INACTIVATE BACKUP and INACTIVATE OBJECT commands change the qualified storage objects from an ACTIVE to an INACTIVE state. The syntax is shown below.

INActivate BAckup namepatternINActivate OBJect namepattern segnamepattern

These commands operate only on active storage objects; otherwise, the commands operate in a similar way to DELETE. Objects are not deleted, but the file retention rules for the backup copy group expire the object when it becomes inactive.

Note: If the TSM server policy limits the number of inactive versions of a storage object, the oldest version might expire.

For more details about the TSM storage management policies, refer to the Tivoli Storage Manager for Windows: Administrator’s Guide: Version 5, Release 5.


CHAPTER 6

Troubleshooting for the TARA GUI

These topics discuss errors associated with Tivoli Storage Manager Teradata Extension:

• Overview of Error Messages

• Tivoli Storage Manager Teradata Extension Debug Log

• ARCMAIN Outlog

• TSM Log Messages

• Error Conditions and Recovery

• Data Connector Error Messages

• Vendor-Independent Error Messages

• TSM Error Messages

For troubleshooting information on Teradata TARA components, see:

• TARA Server Stop and Restart

• Use of the Command Line to Obtain Information

• Teradata TARA GUI on Java Runtime Extension

• States for Archive Jobs

• Job Stream Connection Failure

• Unresponsive TARA Server

Overview of Error Messages

If errors occur with Tivoli Storage Manager Teradata Extension during a Teradata backup, the extension and TSM generate debug logs that can be used for troubleshooting.

Error messages reported by Tivoli Storage Manager Teradata Extension can originate from several software components. Determining the root cause of an error depends on the application that reports the problem. Table 11 lists different types of messages that can occur.

Table 11: Types of Messages

Type of Message Description Reference Information

ARCnnnn messages These messages are generated by ARCMAIN client code.

None

BAMnnnn messages These messages are generated by Tivoli Storage Manager Teradata Extension.

“Data Connector Error Messages” on page 86


Chapter 6: Troubleshooting for the TARA GUITivoli Storage Manager Teradata Extension Debug Log

Note: Some error codes have multiple error messages, which are listed in the bullet lists in the Error Message Text column.

Tivoli Storage Manager Teradata Extension Debug Log

Tivoli Storage Manager Teradata Extension automatically writes diagnostic tracing information to a debug log file. Control the name and location of this log file and the level of tracing using the environment variables BARAMLOG and BARAMLOGLEVEL. For more information on these variables, see “Environment Variables” on page 129.

By default, the debug log file is called baram_log.txt and is located in the current working directory where ARCMAIN runs. Diagnostic tracing in the debug log is available at the levels shown in Table 12.

ANSnnnn messages These are TSM client messages. Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.

See http://publib.boulder.ibm.com/tividd/td/tdprodlist.html

ANRnnnn messages These are TSM server messages. Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.


Messages with error numbers that range from -50 to +50

These error messages are associated with Tivoli Storage Manager Teradata Extension or TSM.

Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.


Messages with error numbers that range from 1 to 50

These ARCMAIN errors are associated with the Data Connector component.


Error messages in the form of "*** Failure nnnn: ..."

These are ARCMAIN errors that most likely originate with the Teradata Database.

Messages

Table 11: Types of Messages (continued)









Chapter 6: Troubleshooting for the TARA GUIARCMAIN Outlog

ARCMAIN Outlog

Always evaluate ARCMAIN output to ensure that each job runs successfully; all error messages (including the error code and message text) are displayed in the ARCMAIN outlog.

Tivoli Storage Manager Teradata Extension returns an error code and message text for ARCMAIN to output to its various log files. The message text and any additional debug information is also written to the debug log of Tivoli Storage Manager Teradata Extension.

TSM Log Messages

The error codes in the 1200 to 1299 range originate in TSM, which logs diagnostic information in these log files:

• TSM Server Activity Log

• TSM Client Log

TSM Server Activity Log

Tivoli Storage Manager Teradata Extension generates Teradata-specific messages in the TSM server activity log every time it opens and closes a backup file. These messages are strings that include TDB0nnn, where nnn is the message ID.

The next example includes a command, plus the report it generates, of Tivoli Storage Manager Teradata Extension messages that are associated with opening a Teradata backup file in WRITE mode:

Query actlog search=TDB0002

Table 12: Log File Levels

Level Description

1 Defaults to 1 if a log level is not specified.

Tracing at this level logs major events, such as opening/closing a file or shutdown. At shutdown, a summary report of I/O counts and number of bytes reads/writes from/to each file displayed.

2 Displays call trace information at the BAR_Session level for most functions, except the calls to read/write individual data blocks.

3 Logs TSM API function calls and includes more descriptive information about each read/write operation.

4 Includes information at trace level 3, in addition to memory buffer information.

5 Includes information at trace level 4, and Data Connector function codes and returns.


Chapter 6: Troubleshooting for the TARA GUIError Conditions and Recovery

Query for all messages associated with a particular session or time period to see the server context of the operation, such as, device errors from mounting tapes.

The default retention period for a TSM server activity log is only one day, so regular checks are recommended. Viewing older logs requires special procedures.

For more information about the syntax of the QUERY ACTLOG command, refer to IBM’s Tivoli Storage Manager for Windows: Administrator’s Reference: Version 5, Release 5.

TSM Client Log

Errors and abnormal conditions on the TSM client node are written to a client log file, typically named DSIERROR.LOG. The location of this file is controlled at runtime by the DSMI_LOG environment variable or is written to the local directory.

The TSM client log file always opens in APPEND mode, therefore verify activity by checking the date/time stamp on all messages. View these log files in any text editor, such as Notepad.

Error Conditions and Recovery

The error messages that are displayed during ARCMAIN operations can originate from various software components.

The error conditions shown in Table 13 can occur while starting Tivoli Storage Manager Teradata Extension or while backing up data. Use this information to ensure that the installation process is successfully completed and that all recovery options are considered.

Date/Time Message

06/23/2003 11:41:54

ANE4991I (Session: 4901, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata,DSN-DATA0001 Generation=3 in write mode

06/23/2003 11:56:17

ANE4991I (Session: 4903, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN-DATA0002 Generation=4 in write mode

06/23/2003 11:56:44

ANE 4991I (Session: 4905, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN=DATA0001\Long_Path$#.DATA Generation=1 in write mode

06/23/2003 11:57:12

ANE4991I (Session: 4906, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN=DATA0001.DSN Generation=1 in write mode


Chapter 6: Troubleshooting for the TARA GUIError Conditions and Recovery

Table 13: Error Conditions and Recovery Options

Error Condition Possible Recovery Option

An invalid option was found during option parsing

This is a dsmSetup error. The installation process attempted to read Windows registry settings to determine the paths to TSM. However, there was an invalid option found during option parsing, probably due to an invalid option specification in the TSM Client Options file.

Refer to the DSIERROR.LOG file and determine which line of the options file is invalid. The path to this file is set with the DSMI_LOG environment variable or the path defaults to the local directory.

For more information about TSM Client Options, refer to IBM’s Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 2 documentation.

ANSnnnn or ANRnnnnTSM errors

Tivoli Storage Manager Teradata Extension attempts to gather as much information as it can about the root cause of errors. Query the TSM server activity log for device errors or other messages that did not get conveyed to the client process. For information on the TSM server activity log, refer to “TSM Server Activity Log” on page 83.

Alternately, check for DSIERROR.LOG file error messages on the client.

dsmInitEx -- Session rejected This is an open session error from Tivoli Storage Manager Teradata Extension, related to opening a TSM server connection.

This is an authentication error, the most common source of open session errors. An invalid NODENAME or PASSWORD is defined in the TSM Client Options file. For more information about how settings need to match what is defined for the TSM server, see “Configure TSM for Teradata Backups” on page 37.

Errors that include a traceback Tivoli Storage Manager Teradata Extension maintains an internal trace buffer that is dumped to stderr output when exceptional conditions occur, such as memory access or illegal instruction. This type of diagnostic output is a problem that can only be corrected by the Teradata Development organization, therefore:

1 Capture a complete output listing. For information about generating diagnostic traces, see “Environment Variables” on page 129 for details about the BARAMLOG and BARAMLOGLEVEL environment variables. These variables control the diagnostic tracing for Tivoli Storage Manager Teradata Extension.

2 After collecting the trace information, contact the Teradata Global Support Center.

File locking contention can occur when two jobs attempt to write to the same log file at the same time.

Hung up on a tape mount Device messages often show up in the TSM server activity log. For more information on the TSM server activity log, refer to “TSM Server Activity Log” on page 83.

Hung up on a Teradata Database lock

Consult the Teradata QUERYSESSION and SHOWLOCKS console utilities for help.


Chapter 6: Troubleshooting for the TARA GUIData Connector Error Messages

Data Connector Error Messages

The error messages shown in Table 14 correspond to Data Connector error codes that range from 0 to 999.

Options file ‘*’ not found This is a dsmSetup error. The installation process attempted to read Windows registry settings to determine paths to TSM. However, the TSM Client Options file was not found.

One or more of the DSMI environment variables are not properly set. Edit runarctiv.bat and:

• tarativadm.bat in Windows

• tarativadm.sh in Linux

The file cannot be found or is improperly formatted

Locate the file and correct the format.

The installation process should have created a TDBAR configuration file directory (which is usually C:\Program Files\Teradata\Teradata Client\TDBAR). The TIVARC.BAT file starts ARCMAIN with the sample ARCDFLT.TXT file as the ARCMAIN default command line option file.

tivarc (tivadm) is not recognized as an internal or external command, operable program or batch file

The %PATH% is wrong.

The environment variable for %PATH% does not include the location of the TIVARC.BAT, ARCMAIN.EXE, and TIVBAR.DLL files. Usually this location is C:\Program Files\Teradata\Teradata Client\BIN.

Unable to see backups in storage using TDDSMC

If the ARCMAIN process seems to be error-free, but verifying that the storage object was created on the TSM server is not possible, check the following:

• Is the TCPSERVERADDRESS field of the TSM Client Options file indicating the correct IP address? In other words, is Tivoli Storage Manager Teradata Extension connected to the proper TSM server?

• Are you querying the TSM server for the correct node name? To see what node name was used to create the backup, execute the following command from the TSM Server Administrative Console:

query activitylog search=TDB0002

• Is the DATASETNAME pattern correctly entered? (TSM is case-sensitive.)

The QUERY TSM command from the taratddsmc utility might provide additional information.

Table 13: Error Conditions and Recovery Options (continued)




Table 14: Data Connector Error Codes

Error Code Error Message Text Description and Remedy

BAM0011 Access module called by < > when expecting < > Tivoli Storage Manager Teradata Extension is being called by a program other than ARCMAIN, but the extension can only be used for Teradata backup and restore.

Remedy: Correct the software configuration and rerun the job. To determine the correct software version for the environment, refer to the release letter documentation or contact the Teradata Global Support Center.

BAM0013 Invalid open mode < > requested Tivoli Storage Manager Teradata Extension is being asked to open a file in an invalid mode.

This error might indicate a software version incompatibility between Tivoli Storage Manager Teradata Extension and the Data Connector. More likely, the error is related to some type of software corruption.

Remedy: Contact the Teradata Global Support Center.

BAM0018 Expected Data Connector Version (< > < >) but actually got (< > < >)

The Data Connector version is incompatible with Tivoli Storage Manager Teradata Extension.

The Data Connector corresponds to the libpm.dll component on Windows and the libpm.so component on UNIX. Verify that the correct component is being loaded and the correct installation path is being used.




BAM0020 • Invalid token entered for Directory Delimiter

• Directory Delimiter must be single non-alphabetic

• No closing quote character < > value < > found after < > characters

• File path cannot exceed characters

• Name cannot exceed < > characters: < >

• Colon character < > in wrong place for a directory path

• Invalid substitution variable < > (need closing < > character)

• Unrecognized substitution variable < >

• Unrecognized character < > (value < >) at position < >

• < > is not a valid name value for < > field

• < > value cannot exceed < > characters

• < > field assignment must be a quoted string value

• < > is not a valid number for < > field

• < > field value cannot be a decimal


• Unrecognized field name starting at: < >

The IOPARM string or the command contains a syntax error.

This error message can result from a number of causes, all related to the user-entered command syntax.

Remedy: Correct the error and resubmit the job.

BAM0024 Unsupported function code < > Tivoli Storage Manager Teradata Extension is incompatible with the calling program.

The extension can only be used for Teradata backup and restore. Your version of ARCMAIN software might be incompatible with the Tivoli Storage Manager Teradata Extension software.


BAM0033 < > Access module currently does not support the < > file attribute

< > Access Module currently does not support the < > function for < > file attribute

Tivoli Storage Manager Teradata Extension is incompatible with the calling program.

Tivoli Storage Manager Teradata Extension can only be used for Teradata backup and restore. This error suggests that a version of ARCMAIN software is being used that is not compatible with the extension’s software level.


Table 14: Data Connector Error Codes (continued)



Chapter 6: Troubleshooting for the TARA GUIVendor-Independent Error Messages

Vendor-Independent Error Messages

The error messages shown in Table 15 originate in the vendor-independent portions of Tivoli Storage Manager Teradata Extension. These error codes range from 1000 to 1200.

Table 15: Vendor Independent Error Messages


BAM1000 NULL file pointer passed to < > function of Access Module

Unrecognized file pointer 0x< > passed to < > function of Access Module

Write called with buffer length < > when max size is < >

Access Module passed OBJNAME attribute < >. It is < > characters long when only < > characters supported

Invalid object type < > passed on OBJNAME attribute

Invalid CopyNum < > passed to BARFile Constructor

Invalid File Open Mode < > when closing

Write called when file not opened for writing

NULL position pointer passed to SetPos

Invalid position (< > < >) passed to SetPos

SetPos position (< > < >) caused us to read past end of segment

SetPos position (< > < >) reads past end of segment

Reposition offset= < > when only < > bytes returned by read

Unable to interpret Object Info. Format= < >, InfoLen= < >

CloseWrite should have updated < > segments but only did < >

CloseWrite File segment FS= < >, HL= < >, LL= < > does not match list

An internal software error is detected. These messages correspond to BAR internal error codes. They indicate a severe, unexpected, or exceptional condition that can only be corrected by the Teradata Development organization, therefore:

1 Capture a complete output listing and all supporting text.

2 Contact the Teradata Global Support Center.

Remedy: Contact a field engineer or the Teradata Global Support Center.



• < > called when no active transactions

• EndCreateObj called when no open object

• FSeg Constructor passed invalid arguments: NS= < >, PATH= < >, GEN= < >, SEQ= < >

• Invalid pointer < > passed to rewind_input function

• Invalid File Name length < > passed to Open function

• Read function called when already flagged end-of-data

• Invalid length < > passed for allocating temporary buffer

• Invalid length was returned from a call to dsmGetNextQObject

BAM1001 • NULL target buffer passed to esprintf routine

• Invalid message id < > passed to esprintf routine

• No message text stored for message id < >

• Call to esprintf routine exceeded < > number of inserts

• Invalid message id < > passed to escode routine

The core error reporting routines cannot do their work. An internal software error/corruption is detected. Other error conditions might be hidden behind this error.


BAM1002 The access module expects the Tivoli password access mode to be PASSWORD PROMPT

Tivoli Storage Manager Teradata Extension only functions in PASSWORD PROMPT mode.

Remedy: Specify the PASSWORD mode as PROMPT in dsm.opt.

BAM1003 Access Module currently does not support restarts in the WRITE mode

Tivoli Storage Manager Teradata Extension does not support restart processing when a backup file is opened in WRITE mode, which means that the extension rolls back and deletes all data written to TSM up to this point.

Remedy: Do one of the following:

• Resubmit the job from the beginning of the current ARCMAIN step,

• Instead of resubmitting the job, issue a RELEASE LOCK statement on the Teradata server to remove any database locks set.

BAM1005 Access module cannot open more than < > files at same time

More FILE= clauses are specified on the ARCMAIN backup statement than are supported by Tivoli Storage Manager Teradata Extension.

Remedy: Correct the ARCMAIN statement and resubmit the job.

Table 15: Vendor Independent Error Messages (continued)




BAM1006 Access Module detected multiple backups for NameSpace= < >, Path= < >, Segment= < >

TSM qualified multiple backups for the indicated Namespace, Pathname, and Segmentname pattern. This is an error because a backup and restore needs to work with only one high-level name per ARCMAIN statement.

The most likely reason for this error is that the Namespace or Pathname fields contain a wildcard character that qualifies multiple backup files from the TSM catalog. Test this by using the native API query tool to see what backup file names come back, making sure that you are logged on as the same user ID to the TSM server.

Wildcard characters are acceptable for a low-level segment name becauseTivoli Storage Manager Teradata Extension reserves those names for its own purposes.

Remedy: Correct the indicated name by removing the wildcard characters, and resubmit the job.

BAM1007 No backup file(s) found with NameSpace= < >, Path= < >, Segment= < >, Generation= < >

No backup file matched the indicated Namespace, Pathname, Segmentname pattern, and Backup File Generation number.

The Namespace field defaults to Teradata.

The Pathname is set by one of the following:

• The DATASETNAME field on the IOPARM string

• The external name of the FILEDEF parameter

• The value assigned on the FILE= clause of the ARCMAIN restore statement

Segmentname is controlled only by Tivoli Storage Manager Teradata Extension, but is shown in case you want to include it in an administrative query.

The generation number is entered as an IOPARM field or defaults to zero. Relative numbers, such as -1 and -2, count backwards from the current active backup (gen=0).

Remedy: Correct the indicated name and resubmit the restore job.





BAM1008 Duplicate storage objects found with NameSpace= < >, Path= < >, Segment= < >, Generation= < >

Tivoli Storage Manager Teradata Extension creates storage object names with a particular format. Also, a non-negative generation number is stored in the Object Info portion of the storage catalog metadata. If duplicate storage objects were found with the same name/generation one of the following has happened:

• An existing ARCMAIN backup was copied or the Object Info field was corrupted.

• The storage catalog is corrupted or Tivoli Storage Manager Teradata Extension has a bug.

The extension relies on the generation number to distinguish between separate runs of the same backup job, so all file segments that correspond to a single backup job execution need to have the same generation number.

Remedy: Verify the heritage of the pertinent storage objects and, if necessary, delete the corrupt objects or update the Object Info metadata with distinct generation numbers. Ensure that the backups are not creating new objects when the metadata is updated.

If the remedy does not work, contact a field engineer or the Teradata Global Support Center.

BAM1009 Access Module currently does not support repositioning when writing to backup files

Tivoli Storage Manager Teradata Extension does not support restart processing when a backup file is opened in WRITE mode because it is not possible to reposition to the exact point of failure inside TSM. This means that Tivoli Storage Manager Teradata Extension rolls back and deletes all data written to TSM up to this point.








BAM1010 SetPos generation < > does not match current file generation of < >

When Tivoli Storage Manager Teradata Extension creates a new backup file, it stores a unique generation number in the Object Info field of the storage object. This error occurs when a reposition operation detects that the position being requested is for a backup file with a different generation number from the one that is currently open.

Normally, this condition indicates a corrupted position field managed by ARCMAIN. However, when using the CATALOG feature of ARCMAIN to get fast repositioning on a restore, ARCMAIN can pick up a position that is inconsistent with the backup files in storage.

This condition can happen under the following circumstances:

1 Regularly running the same backup job, saving position information to the CATALOG database.

2 Creating additional backups without using the CATALOG option, so there is no position information saved.

3 Running a restore using the most recent backup image from storage. In this case, the most recent image in storage might correspond to generation 103, when the most recent backup image in the CATALOG database corresponds to generation 102.

Remedy: Examine ARCMAIN listings and the storage catalog, and do one of the following:

• If a user error occurred, make corrections and resubmit the job.

• If no user error occurred, consult a field engineer or the Teradata Global Support Center.

BAM1011 SetPos file segment number < > not found in retrieved list of backup segments

Tivoli Storage Manager Teradata Extension cannot find the requested file segment number when a request was made to reposition the file within the backup set. Either the position information is corrupted, or a mismatch occurred between the backup set being requested and the position information.






BAM1012 < > < > error < > < > Tivoli Storage Manager Teradata Extension detects an unexpected error when starting a function of TSM. The nature of the error is indicated in the message by naming the TSM product, the API function being called, the error code, and the error message text.

This type of error can be difficult to fix. Tivoli Storage Manager Teradata Extension is customized to work with site-specific APIs, but configuration to work with TSM and ARCMAIN can be complex.

Remedy: Correct the job or configuration settings.

To run Tivoli Storage Manager Teradata Extension with an option that is not recognized on the IOPARM of an ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.

To avoid resubmitting a job, issue a RELEASE LOCK statement on the Teradata Database to remove any database locks set and clean up the server.

BAM1013 Storage object created on platform < > The backup file being restored was generated on a different operating system.

The platform number identifies the operating system that created the backup.

Remedy: Resubmit the job on the same platform that created backup.

BAM1014 Invalid Segment name for NameSpace= < >, Pathname= < >, Segment= < >, CopyId= < >. Skipping.

When querying the TSM storage catalog metadata, Tivoli Storage Manager Teradata Extension found a storage object that qualified on the name pattern, but does not follow the proper naming convention. This is not a fatal error message, but the relevant object is omitted from processing because Tivoli Storage Manager Teradata Extension cannot properly parse the segment name.

Tivoli Storage Manager Teradata Extension stores segment sequence numbers as part of the file segment name. For example, F0014 corresponds to the 15th file segment of a single ARCMAIN backup file. (File segment numbering starts at zero.)

Remedy: Rename the segment name if NameSpace and PathName are too close to the name chosen for another storage process.

If the skipped object was created by a Teradata backup operation, report the issue to a field engineer or to the Teradata Global Support Center.




Chapter 6: Troubleshooting for the TARA GUITSM Error Messages

TSM Error Messages

Error messages that range from 1200 to 1299 (shown in Table 16) originate in the TSM portion of Tivoli Storage Manager Teradata Extension. Note that some of the error codes have multiple error messages.

BAM1015 Unable to open diagnostic file < > because < >. Logging disabled.

Diagnostic logging is requested, but Tivoli Storage Manager Teradata Extension is unable to open the file. This is a non-fatal error, but no diagnostic logging is captured. The cause of the file open error is indicated.

Tivoli Storage Manager Teradata Extension opens the log file in write-append mode. Periodic purging of this file is necessary.

Remedy: Correct the problem, and resubmit the job.

BAM1017 Unable to open DEFAULT file < > because < >

Tivoli Storage Manager Teradata Extension is unable to open the command line DEFAULT file. The cause of the file open error is indicated.

The DEFAULT file is specified with the BARAM_DEFAULT environment variable.

Remedy: Specify a valid path to a DEFAULT file that is accessible to your user ID, then resubmit the job.

BAM1018 Access module is aborting the backup transaction Tivoli Storage Manager Teradata Extension was called to close the backup file in an error condition. The write transaction is aborted and all storage objects created by this job are rolled back.

This is an informational message rather than a report of the root cause of an error condition. ARCMAIN indicates the cause of the error or reports that the backup process is interrupted.

Remedy: Correct the root cause of the error and resubmit the job. For further information, refer the output listing to the Teradata Global Support Center.

BAM1019 Access module is aborting due to Insufficient Memory This error occurs when Tivoli Storage Manager Teradata Extension runs out of memory while attempting to allocate resources.

A number of conditions can cause insufficient memory, including a lack of memory or swap space.

Remedy: Correct the root cause of the error, then resubmit the job.





Table 16: TSM Error Messages


BAM1200 Access Module needs Tivoli Version < > Release < > but client library is Version < > Release < >

Tivoli Storage Manager Teradata Extension detects an invalid software library release level.

The path to the loaded extension is set with the IOMODULE command line parameter to ARCMAIN.

Remedy: Correct the configuration issue and resubmit the job.

BAM1201 Tivoli dsmEndTxn error < >, (reason < >): < >

Tivoli Storage Manager Teradata Extension detects an unexpected error when starting a TSM End Transaction function. The error code, reason code, and error message text indicate the nature of the error. Reason codes usually correspond to numbers 1 through 50 of the API return codes. For more information on the API return codes, see IBM’s TSM Messages manual.

If this error occurs when writing backup files to the TSM, Tivoli Storage Manager Teradata Extension rolls back and deletes all file segments written to TSM up to this point, except file segment 0 (F000).

Remedy: For recommendations about correcting the cause of this error, refer to the TSM documentation.

Do one of the following:

• To run Tivoli Storage Manager Teradata Extension with an option that is not recognized on the IOPARM of the ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.

• If you do not resubmit the job, issue a RELEASE LOCK statement on the Teradata Database to remove any database locks set, then clean up the Teradata server.

BAM1202 Tivoli Backup Copy Group does not exist for object FileSpace= < >, HighLevel= < >, LowLevel= < >

TSM is unable to assign a copy group for the backup object being created.

This situation is the result of an API dsmBindMC call. The object name is listed as FileSpace, HighLevel name, and LowLevel name.

Remedy: Consult the TSM administrator to determine the source of the problem.



BAM1203 Tivoli Storage object FileSpace= < >, HighLevel= < >, LowLevel= < >, ID= < > is not recognized by Access Module. Skipping.

Tivoli Storage Manager Teradata Extension is unable to interpret the formatted metadata, which is usually stored with the storage object. The object is skipped and processing for the object stops, although processing continues for the balance of the job.

This error is usually generated because a storage object exists in TSM that has a similar name to a Teradata backup created by Tivoli Storage Manager Teradata Extension. The specified object name in the query is picking up more than it should.

This warning message does not terminate processing because Tivoli Storage Manager Teradata Extension cannot communicate a non-fatal warning condition to ARCMAIN. As a result, the return code indicator from ARCMAIN can be zero, even though this message is displayed.

Remedy: Use the indicated diagnostic information to verify the status of the storage object. If the storage object is considered for Teradata backup and restore, contact the Teradata Global Support Center.

If the object is being incorrectly qualified because the wildcard specification is too general, restate the query so it is correctly limited to the storage objects created by Tivoli Storage Manager Teradata Extension.

BAM1204 TDDSMC syntax error: < > The TDDSMC utility in Tivoli Storage Manager Teradata Extension detects a syntax error in the command.

The message indicates the source of the error.

Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP command or refer to Taratddsmc Help Command.

BAM1205 TDDSMC syntax error: < > field width cannot exceed < >

The TDDSMC utility in Tivoli Storage Manager Teradata Extension detects a syntax error on a FORMAT string. The field width override value for the indicated substitution variable is too long.

Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP FORMAT command or refer to Taratddsmc Help Command.

Table 16: TSM Error Messages (continued)




BAM1206 Tivoli server aborted transaction during < > call. Error < >, (reason < >): < >

TSMserver aborted the client transaction for the noted reason code. For more information on the API return codes, see the TSM Messages manual. Reason codes usually correspond to numbers 1 through 50 of the API return codes.

If this error occurs when writing backup files to the TSM, Tivoli Storage Manager Teradata Extension rolls back and deletes file segments written to TSM up to this point, except file segment 0 (F000).

If the text of the message indicates a zero value for the reason code, issue a QUERY ACTIVITYLOG command on the TSM server to determine the root cause of the abort.



• To run Tivoli Storage Manager Teradata Extension with an option that is not recognized on the IOPARM of the ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.


BAM1207 TDDSMC syntax error: Expected quote string at >> ( ) << on command line

The TDDSMC utility in Tivoli Storage Manager Teradata Extension detects a syntax error on the command line arguments used to start the utility. This error is the result of a quote string not being found at the specified position.

Remedy: Correct the syntax and resubmit the job. For more details about command line syntax, issue the HELP command or refer to Taratddsmc Help Command.

BAM1208 TDDSMC syntax error: No matching and quote character on command line

The TDDSMC utility in Tivoli Storage Manager Teradata Extension detects a syntax error on the command line arguments used to start the utility. A quote string was detected, but no matching end-quote was found.

The TDDSMC utility recognizes single- and double-quote characters, but sometimes the operating system strips quotes before passing the command line to the utility. After a quote character is detected, the utility will keep scanning the command line for a matching end-quote.





Chapter 6: Troubleshooting for the TARA GUITARA Server Stop and Restart

TARA Server Stop and Restart

The command line can be used to stop and restart the TARA server.

To stop and restart the TARA server

1 Type:

/etc/init.d/tdtaraserver stop

Wait 60 seconds. If you attempt to start the tdtaraserver script immediately after stopping the service, the operation might fail.

2 Type:

/etc/init.d/tdtaraserver start

Use of the Command Line to Obtain Information

Use the command line to:

• Query current and prior jobs launched through Teradata TARA

• Obtain launch times

• Obtain script names

BAM1209 TDDSMC syntax error: Extraneous information follows < > command starting at: < >

The TDDSMC utility in Tivoli Storage Manager Teradata Extension detects a syntax error on the command line arguments used to start the utility. A valid command was parsed, but non-blank trailing characters were detected.

This error can occur when an unquoted name pattern contains embedded blanks. There are optional fields after the name pattern,. Therefore, the actual source of the syntax error might be prior to the position indicated.


BAM1210 Access Module cannot backup more than 4080 objects.

TSM limits the number of objects that can be retrieved at one time to DSM_MAX_GET_OBJ (4080). Therefore Tivoli Storage Manager Teradata Extension does not back up more than 4080 object segments. The maximum size of one backup job cannot exceed approximately 8 TB.

Remedy: Modify backup jobs to contain less data.




Chapter 6: Troubleshooting for the TARA GUITeradata TARA GUI on Java Runtime Extension

Type:

/opt/teradata/tara/gui/bin/tarajobquery -L

The output is similar to the following:

File Name/Job ID Job Name Date Stream Cnt

469d370300000001 frank 2007-07-17 14:47:47 1469d42ff00000001 frank 2007-07-17 15:33:36 1469d42ff00000002 frank 2007-07-17 15:49:06 1

Teradata TARA GUI on Java Runtime Extension

On Windows, the TARA GUI setup.exe installs a .jar file that allows the GUI to run under the Java Runtime Extension (JRE). The taragui.jar file is located at \Program Files\Teradata\TARA\gui\bin.

On Linux, the TARA GUI .rpm package installs the .jar file. The taragui.jar file is located at /opt/teradata/tara/gui/bin.

To run the GUI, download the file to a Windows or Linux machine with JRE and double-click the file.

States for Archive Jobs

When a Teradata archive job is started through Teradata TARA, the state of each cluster stream changes during the job launch process. The State column of the Teradata Tiered Archive/Restore Architecture dialog box displays the archive job states, which are shown in Table 17:

Table 17: States for Archive Jobs

State Step in Job Launch Description

Connecting 1 Each backup stream must connect to the MultiARC server.

Logon 2 After the streams receive instructions from the ARC server, they log in their sessions to the Teradata Database.

Tape Mount 3 After the ARC sessions are logged into the Teradata Database, the request for media is sent through Tivoli.

Archive 4 After the media is made available by Tivoli, the archive process begins moving data to the media. In the Bytes Processed column of the Teradata Tiered Archive/Restore Architecture dialog box, the number of bytes should start increasing.

Waiting 5 In a waiting state, one of the following happens:

• a child stream is waiting for instructions from the master stream (Stream 1)

• the master stream is waiting for a child stream to complete the current instruction


Chapter 6: Troubleshooting for the TARA GUIJob Stream Connection Failure

Job Stream Connection Failure

Symptom

The job stream fails: in the TARA GUI, the job stream is shown trying to connect for some time before it fails. This occurs because of a MultiARC server time-out, and suggests that a problem has occurred before the ARC streams have connected to the MultiARC server. This symptom normally occurs after a recent installation or reconfiguration of Teradata TARA or Teradata ARC.

The first step in investigating the problem is “Step 1: Verify that ARC Output Files are Being Created”.

Step 1: Verify that ARC Output Files are Being Created

On each media server, ARC output (.out) files are located in the /home/baruser account. These files are required when Teradata TARA launches Teradata ARC.

• If an ARC .out file with a matching timestamp of the attempted launch exists, open the ARC log and examine possible errors provided by the client utility.

• If no ARC .out file exists, or an .out file of 0 bytes exists, Teradata ARC is not being launched properly. This indicates that Teradata TARA cannot find the ARCMAIN binary or the permission on the script that launches Teradata ARC is not correct. Go to “Step 2: Examine the Script that Launches Teradata ARC”.

Step 2: Examine the Script that Launches Teradata ARC

The script that launches Teradata ARC is called runarctiv.bat and is located in /home/baruser. The baruser account must be the owner of this file or Teradata ARC will not launch.

To examine the script

1 Verify that runarctiv.bat has the proper permissions and owners assigned to it:

-rwxr-xr-x 1 baruser root 2274 Jul 17 15:26 runarctiv.bat

2 Determine if runarctiv.bat can properly locate the ARCMAIN binary.

The runarctiv.bat script that launches ARC (in /home/baruser) uses a variable called $INSTALLPATH. The variable is defined by executing an rpm -q command to determine where the ARC package is installed:

rpm -q --queryformat '%{INSTALLPREFIX}\n' arc

If the result of this command produces two outputs:

Logoff 6 The stream is in the process of closing its ARC sessions; the job ends.

Table 17: States for Archive Jobs (continued)

State Step in Job Launch Description


Chapter 6: Troubleshooting for the TARA GUITARA Job Output Errors

(none)

(none)

ARC might not launch. As a result, jobs in the Teradata TARA GUI could remain in the Connecting phase, and the ARC .out file could remain a zero-length file.

Workaround: Edit the /home/baruser/runarctiv.bat script and verify the path to the

ARCMAIN executable is hardcoded.

TARA Job Output Errors

Symptom

In a LAN-free environment, a system error can occur when COMMTIMEOUT is set to the default value of 60 seconds or less in dsmsta.opt (Storage Agent). The two error messages that are displayed when this occurs are:

ANR0481W (Session: 207, Origin: BSRV1-AGENT) Session 288for node AJ-BAR (Teradata) terminated - client did notrespond within 60 seconds. (SESSION: 207)

*** Failure ARC0805:Access Module returned error code 34:Error BAM1012: Tivoli dsmGetData error -72: ANS1235E(RC-72) An unknown system error has occurred from whichTSM cannot recover.

Remedy

Increase COMMTIMEOUT to a larger value. For more information, refer to Table 7 on page 38.

Unresponsive TARA Server

Symptom

The TARA server is not responding to job requests, although jobs have previously run successfully in the current configuration.

To test if the TARA server is unresponsive, at the command line, type:

/opt/teradata/tara/gui/bin/tarajobquery -L

If the TARA server is not responding, there is no response to the command. A successful result returns a list of the current and previous jobs that have been launched through Teradata TARA.

Verify that there is no filesize statement that exceeds 2GB in value. See “Configure the Log File” on page 51.

Another area to investigate is to look at the core files. See “Step 1: Add ulimit”.


Chapter 6: Troubleshooting for the TARA GUIUnresponsive TARA Server

Step 1: Add ulimit

If the TARA server is unresponsive, add ulimit -c 131072 to the /etc/init.d/tdtaraserver script to produce core files. Doing so kills the process ID to obtain the core file:

case "$1" in start) echo -n 'Starting taraserver ' ulimit -c 131072 if [ $KTYPE -eq 0 ]; then

Core files are located in /opt/teradata/tara/server/config:

For example:

lussdgsc-bar00:/opt/teradata/tara/server/config # ls -ltotal 1690drwx------ 2 taraserver root 176 Aug 28 11:24 .drwxr-xr-x 7 root root 168 Aug 9 15:13 ..-rw------- 1 taraserver users 13176832 Aug 28 11:01 core.8849-rwxr-xr-x 1 taraserver root 901 Aug 13 14:57 defaults-rwxr-xr-x 1 root root 430 Aug 10 15:16 defaults_original

Note: For the core ulimit setting to take effect, restart the TARA server.

If core files do not provide an answer, look at the TARA server log. See “Step 2: Change Verbosity of TARA Server Log”.

Step 2: Change Verbosity of TARA Server Log

Change the verbosity of the TARA server log, logfile, located at /opt/teradata/tara/server/logs with the next procedure.

To change the verbosity of the TARA server log

Note: The TARA server does not have to be restarted before performing this procedure.

1 Start the Teradata TARA GUI.

2 Click Settings>Server Configuration>Logging.

3 Check the Override Global Log Level box.

4 Adjust the level of logging for the specific processes.

5 Click Apply, then close the dialog box.

For example, when troubleshooting jobs that are launching, change the:

• Arc Log Setting to 48

• Gui Log Setting to 48

• Launch Log Setting to 63

Temporary workaround: Stop, then restart the TARA server to get the backup jobs operational in the meantime.


Chapter 6: Troubleshooting for the TARA GUIUnresponsive TARA Server


APPENDIX A

Installation and Configuration:Command Line Utility

This chapter discusses:

• Configuration Requirements

• Installation

• Removal of the Teradata Access Module

• Configuration of TSM for Teradata Backups

• LAN Configuration

Configuration Requirements

The following hardware, software, and LAN configurations are required before installing Teradata Access Module for Tivoli.

Hardware

The Teradata Access Module for Tivoli is certified for installation only for 32-bit Windows 2000 and 2003 platforms (Server or Professional).

Software

Before installing the Teradata Access Module for Tivoli, verify that the following products are already installed at the proper release levels:

Note: NCR software is not certified to run with Unicode support enabled.

• IBM Tivoli Storage Manager Server 05.02.02.01 or 05.03.00.02 is a prerequisite, but does not need to be installed on the same hardware node as the Teradata Access Module for Tivoli software.

• IBM Tivoli Storage Manager Backup-Archive Client 05.02.02 or 05.03.00 must be installed on every node where ARCMAIN is run with Teradata Access Module for Tivoli.

• IBM Tivoli Storage Manager Storage Agent 05.02.02.01 or 05.03.00.02 (for LAN-free data movement only) must be installed on every node where ARCMAIN is run with Teradata Access Module for Tivoli. However, the Storage Agent cannot reside on the same node where the TSM server is installed.

• Windows versions of these Teradata Tools and Utilities components, version 08.00.00 or later:


Appendix A: Installation and Configuration: Command Line UtilityInstallation

• ARCMAIN

• Data Connector

• Call-Level Interface version 2 (CLIv2)

• Shared ICU Libraries for Teradata (tdicu)

• Teradata GSS Client

Local Area Network (LAN) Connections and Platforms

The Teradata Access Module for Tivoli operates in LAN-attached or LAN-free modes.

For optimal performance, install the Teradata Access Module for Tivoli on the same LAN where the Teradata Database is installed. Use private high-speed subnets with gigabit or better technology for all LAN connections that perform large-volume data transfers. To ensure optimal throughput, configure the gigabit adapter to support jumbo frames. An example of an optimized LAN connection is a link between MP-RAS and a Windows 2000 node that is running ARCMAIN and the Teradata Access Module for Tivoli.

Follow these recommendations for running TSM in LAN or LAN-free mode:

• If TSM is running in LAN mode, the Teradata Access Module for Tivoli node sends all backup data to the TSM server node, which then writes the data to storage. A private high-speed LAN connection is recommended between the TSM client and the TSM server.

• If TSM is running in LAN-free mode, a high-speed LAN connection between the Windows 2000 node that runs the Teradata Access Module for Tivoli and the TSM server is not necessary because the link only has to accommodate metadata and control information.

Installation

The Teradata Access Module for Tivoli is released on the Teradata Tools and Utilities 8.0 Edition 2 CD, labeled Tape Storage Management Enablers.

To install the Teradata Access Module for Tivoli

1 On the CD, locate the tivoliam\windows directory and click SETUP.EXE. The Install Configuration Files dialog box appears.

2 Specify the installation location for the BAR configuration files and customize the files as shown.



The options for this dialog box are:

3 Click OK to install the tddsmc.exe, tivbar.dll, tivadm.bat, and tivarc.bat files to the directory in which the ARCMAIN executable resides.

This action creates a BAR configuration directory and BAR working files directory, and customizes the tivadm.bat and tivarc.bat files to contain the location and name of the TSM Client Options file and locations of the BAR configuration and BAR working files directories.

Option Description

BAR Configuration Directory This option specifies where the arcdflt.txt, tivdflt.txt, Tivoli.Readme.txt, and optional dsm.opt files are to be installed.

For an explanation of these files, see “Installed Files” on page 108.

BAR Working Files Directory This is an empty directory, which is recommended as the starting directory for all ARCMAIN and TDDSMC processes.

TSM Client Options File This option specifies the location of the TSM Options file. If the TSM Backup/Archive Client is installed, the value shown is the actual location of the dsm.opt file.

If the Backup/Archive Client is not installed, the value represents the default location of the file.

Copy TSM Client Options File to BAR Config Directory

This checkbox is selected if the Backup/Archive Client is installed; otherwise, it is blank.

Note: If the dsm.opt file is copied over an existing file, any changes made to the existing file are lost.

Replace existing configuration files Select this checkbox to replace existing configuration files; otherwise, leave it blank.

Note: If existing configuration files are replaced, any existing changes are lost.



4 Click Cancel only if you do not want to customize these files. Clicking Cancel automatically installs tddsmc.exe, tivbar.dll, and Tivoli.readme.txt in the directory where the Teradata Client executables are installed. This action does not create the BAR working files directory or copy .bat files.

Installed Files

The installation process creates the files shown in Table 18, and places them in the same directory in which the Teradata client executables are installed.

Additional Directories

The directories shown in Table 19 are created during installation to standardize running the Teradata BAR processes on the node. The installation program allows setting the location of these directories.

Table 18: Files Created at Installation

Installed Component Description

ARCDFLT.TXT ARCMAIN command line default file, which is optionally installed.

Shortcut to TDDSMC utility A shortcut created in the Programs menu for the TDDSMC utility, which is accessible from the Teradata Access Module for Tivoli submenu.

TDDSMC.EXE A command line administrative utility for database administrators and system administrators to view Teradata backups in the TSM server catalog.

TIVARC.BAT

TIVADM.BAT

Sample batch files for starting ARCMAIN and the TDDSMC utility with the Teradata Access Module for Tivoli.

Note: These files are optionally installed, based on the response to Install Configuration Files in the installation process.

TIVBAR.DLL The application library that mediates between the ARCMAIN software and the TSM API software. This is the library specified with ARCMAIN IOMODULE parameters.

TIVDFLT.TXT Options passed to the access module; this file is optionally installed.

Tivoli.Readme.TXT Information about customizing the configuration files and the latest information, which did not make it into the formal documentation.


Appendix A: Installation and Configuration: Command Line UtilityRemoval of the Teradata Access Module

Removal of the Teradata Access Module

The standard uninstall process removes only the following components from the directories where they were installed (the process does not remove the directories):

• dsm.opt

• tddsmc.exe

• tivbar.dll

• tivoli.readme.txt

• the shortcut to the TDDSMC utility

Table 20 lists limited information about removing complementary components that are used by the Teradata Access Module for Tivoli. For complete uninstall information, see the appropriate user guide or manual for each component.

Table 19: Additional Directories Created at Installation

Directory Description

C:\Program File\NCR\TeradataClient\TDBAR The configuration directory contains the sample default files that are used by ARCMAIN, the Teradata Access Module for Tivoli, and the TSM software.

Customize the location of these files in TIVARC.BAT and TIVADM.BAT. For more information, see “Default Files for ARCMAIN and the Access Module” on page 128.

C:\TDBAR The working files directory contains any temporary or diagnostic log files that might be created by the ARCMAIN and TDDSMC processes. This directory is the recommended starting directory; create subdirectories to group similar BAR processes.


Appendix A: Installation and Configuration: Command Line UtilityConfiguration of TSM for Teradata Backups

Configuration of TSM for Teradata Backups

A Teradata backup can be a backup of an entire Teradata Database, a selected database, or a selected table. To perform a Teradata backup, configure the TSM server first, then the TSM client, then set options for the Teradata Access Module for Tivoli.

TSM Server Configuration

Before performing any Teradata backups, ensure that the TSM policy objects and TSM client nodes are properly configured in the TSM server.

TSM Policy Objects

TSM policy objects manage how data is stored, where client data is stored, the number of maintained versions, and the length of time those versions are stored.

TSM allows a variety of configurations using TSM policy objects, but regardless of the configuration, the Teradata Access Module for Tivoli requires a backup copy group policy object. The backup copy group policy object can be preexisting or newly-created, but only TSM backup object types are supported.

Table 21 lists TSM policy object fields that control the removal of inactive objects from storage. (Objects become inactive when a backup is performed with the same name as an object that is already stored on the server. See “Overview of Backup Data Storage” on page 117.)

Table 20: Tasks to Uninstall Complementary Components

Task Description

Remove Teradata backups in the TSM storage. Issue a DELETE FILESPACE command from the TSM Server Administrative console for every node and Teradata file space created for Teradata BAR.

Remove Client nodes created exclusively for managing Teradata BAR activities.

Issue a DELETE NODE command from the TSM Server Administrative Console.

Delete any historical, diagnostic, or temporary files created on the TSM Client node while executing ARCMAIN with the Teradata Access Module for Tivoli or the TDDSMC utility.

Delete these files from the working files directory hierarchy that was established during installation. For detailed information on the recommended procedures, refer to the appropriate manual.

Remove BAR Configuration Directory and all its contents.

Delete arcdflt.txt, tivdflt, txt, Tivoli.Readme.txt, and the optional dsm.opt file, if created.

Delete or modify customized copies of sample batch files.

Locate the customized files, then delete or modify them so they no longer point to the Teradata Access Module for Tivoli components if the files are stored under a name or category other than the installation defaults.



TSM Client Node

In the TSM software, by default, a client node can access only the backup storage objects that it creates. For instance, when a backup is performed on client node1, all ARCMAIN backups are registered in the TSM server catalog as belonging to node1 and all other nodes are prevented from accessing the storage objects created by node1. However, it is possible to grant authorization for nodes to access other backups by creating a pseudo node that is used by all clients performing backups.

To create a pseudo node, use the TSM register node command that provides the node name and password. Then set the BACKDELETE option to YES. If this option is not set to YES, it is not possible to delete backup objects with the TDDSMC utility. For more information, see Appendix C: “The TDDSMC Administrative Utility”. For information about the TSM register node command, refer to the Tivoli Storage Manager Administrators Guide on the IBM Web site at http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

TSM Server Options

Depending on site requirements, the TSM server option values for the TSM server (dsmserv.opt) and the TSM Storage Agent (dsmsta.opt) might need adjustment. Table 22 describes these options.

Table 21: Fields to Consider for the Backup Copy Group


Versions Data Deleted (VERDELETED)

Number of inactive versions, if active versions do not exist. 1

Versions Data Exist (VEREXISTS)

Number of inactive versions, if active versions exist. 1

Retain Extra Versions (RETEXTRA)


30

Retain Only Version (RETONLY)


60




The TXNGROUPMAX option controls the number of files allowed in a transaction. Set this option to 4080. Although the maximum value allowed is 65000, TSM limits the number of objects restored at the same time to 4080 objects.

Teradata Access Module for Tivoli maps ARCMAIN backup files to a series of smaller storage objects or files segments with an object size of 2 GB. Therefore, the maximum size of a single backup cannot exceed 4080 * 2 GB, or approximately 8.1 TB. For more information, see “Overview of Backup Data Storage” on page 117.

TSM Client Options

Before performing Teradata backups, configure the TSM Client Options file(s). If the TSM Client Options file is copied during installation, a dsm.opt text file is stored in the Teradata BAR configuration file directory. The default location for the dsm.opt file is the directory where the ARCMAIN process is running; the default file name is dsm.opt. When giving the file a different name or directory, follow these rules:

• The file must be read-accessible when ARCMAIN or TDDSMC are started at execution.

• The path to the file is identified by:

• The DSMI_CONFIG environment variable (of which the TIVARC.BAT and TIVADM.BAT files set a value)

• The ARCMAIN or TDDSMC command line field, CONFIG

For more information about where directories are stored, see “Additional Directories” on page 108.

Table 22: TSM Server Options


COMMTIMEOUT Specifies how long the server waits for an expected client message during an operation that causes a TSM database update. If a message does not arrive before the specified wait period, the server ends the session with the client.

To prevent clients from timing out while backing up large files or during a heavy network load, increase the time-out value.

IDLETIMEOUT Specifies the amount of time, in minutes, that a client session can be idle before the server cancels the session.

To prevent clients from timing out due to a heavy network load in the environment, increase the time-out value.

Note: If the time-out value is increased, a large number of idle sessions could prevent other users from connecting to the server.

RESOURCETIMEOUT Specifies the maximum number of minutes that a storage agent waits for a resource on the server. The default value is 60 minutes. The minimum value is 1 minute.

TXNGROUPMAX Indicates the maximum number of logical files (client files) that a client can send to the server in a single transaction. The server might create multiple aggregates for a single transaction, depending on the size of the transaction.



Installation wizards in the TSM products create a Client Options file. To edit the file, use any text editor, such as Notepad. For important information about configuration parameters, see the TSM documents listed at http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

At a minimum, specify the TSM options shown in Table 23 in the TSM Client Options file.

For more details about the TSM options, see the Tivoli Backup-Archive Client Installation and User’s Guide.

Table 23: TSM Client Options

Required TSM Option Description

COMMMETHOD Specifies the communication method to provide connectivity for client-server communication as NamedPipes or TCPIP. Depending on the configuration:

• Use NamedPipes if the TSM client and server software run on the same node.

• Use TCPIP if backups are performed from a different node and both nodes need to see each other’s backups.

ENABLELANFREE Enables an available LAN-free path to a storage device that is attached to a storage area network (SAN).

LANFREECOMMMETHOD Specifies the communication protocol between the TSM client and the TSM Storage Agent, which enables processing between the client and the SAN-attached storage device. Choose NamedPipes or TCPIP.

NAMEDPIPENAME Specifies the name of a named pipe to use for communication between a client and a server on the same Windows server domain.

Note: Use this option only if the COMMETHOD is set to NamedPipes.

NODENAME Identifies your workstation to the server. If you registered a pseudo node, use the pseudo name.

PASSWORD Specifies a TSM password. This password is used when registering the node.

PASSWORDACCESS Specifies whether to automatically generate the password or to set a user prompt. Teradata Access Module for Tivoli requires that this option be set to PROMPT.

Note: Also specify the NODENAME and PASSWORD options.

TCPSERVERADDRESS Specifies the TCP/IP address for the TSM server.



Appendix A: Installation and Configuration: Command Line UtilityLAN Configuration

Example 1

This is an example of a TSM Client Options file in LAN-attached mode:

TCPSERVERADDRESS 128.00.00.00PASSWORDACCESS PROMPTCOMMMETHOD NAMEDPIPESNAMEDPIPENAME \\.\pipe\server1NODENAME NODE1PASSWORD <NODE1 Password>

This scenario is appropriate if the TSM server software and the Teradata Access Module software are installed on the same node.

Example 2

This is an example of a TSM Client Options file in LAN-free mode:

TCPSERVERADDRESS 155.00.00.00COMMMETHOD TCPIPPASSWORDACCESS PROMPTENABLELANFREE YESLANFREECommmethod NAMEDPIPESNAMEDPIPENAME \\.\pipe\adsmpipeNODENAME LANFREENODE1PASSWORD <LANFREENODE1 Password>

In this scenario, the pipe name is the SAN pipe name. To support other TSM SAN configurations, consider these options:

• LANFREETCPSERVERADDRESS

Specify the TCP/IP address for the machine where the storage agent is installed.

• LANFREETCPPORT

Specify the same TCP/IP port address as specified by the TCPPORT option in the storage agent options file, dsmsta.opt.

LAN Configuration

TSM client software is not supported for the MP-RAS platform. Therefore, the Teradata Access Module for Tivoli needs to access the Teradata Database across a LAN. The following LAN configurations maximize data transfer speeds.

Multiple Network Cards and TDPID Addressing

A common mistake in LAN-based BAR configurations is opening a Teradata Database connection over the wrong Ethernet card. If the wrong Ethernet card is configured, backups might be successful, but throughput is dramatically slower than with the correct configuration.


Appendix A: Installation and Configuration: Command Line UtilityLAN Configuration

Teradata Database Connections

The process by which Teradata Database sessions are connected is:

• The ARCMAIN client software passes a logon string that includes the TDPID name for the connection to the CLIv2 software component. The ARCMAIN job output listing displays the TDPID option of the logon string that is used. If a null value is passed through the CLIv2 software, the value defaults to dbc.

• The CLIv2 software attempts to open a TCP/IP connection to a network host of the form TDPIDcopN where TDPID is the specified value and N is an integer number, starting at the number 1.

For example, an ARCMAIN script that includes no TDPID in the logon string attempts to open a TCP/IP connection to network host dbccop1.

Ensure that the IP address of your TDPID provides maximum output by issuing the ifconfig -a command on UNIX platforms to view the IP addresses associated with a given node. Or, ping the IP addresses from the BAR node.

Network Settings for a Single Card

After ensuring that ARCMAIN jobs are opening sessions through the proper network cards, verify that the TCP settings are optimal for the interface.

Maximum MTU Size

The MTU setting for a particular network card determines the maximum size in bytes of a single Ethernet frame on that interface. If a program, such as ARCMAIN, attempts to send a packet that is larger than the MTU size, the packet will be fragmented into frames that are smaller than the MTU setting.

Set all machines in an Ethernet configuration to the same MTU value. If one or more machines are set to a different MTU value, extra fragmentation (or possibly network errors) could result.

The maximum MTU size depends on the hardware being used. If the Ethernet adapters or switches being used do not support jumbo frames (such as, frames larger than the default), the MTU size cannot be changed.

ARCMAIN generally sends and receives 64 KB packets (the maximum size for one database parcel). Therefore, using the highest allowed MTU size reduces the packet fragmentation.

Receive Descriptors and Buffers

The Receive Descriptors setting specifies the number of Receive Descriptors or Buffers (or Receive Descriptors and Buffers) allocated for a given interface. This setting is particularly important when a system receives data under a heavy load (CPU or network utilization). Packets might be dropped if not enough Receive Descriptors are available.


Appendix A: Installation and Configuration: Command Line UtilityPreparation for Production

The minimum number of receive descriptors needed for a system under a heavy load depends on the:

• Maximum packet size of the running applications

• Total number of sessions/connections being used

• MTU setting for the Ethernet interface

Preparation for Production

When installation and configuration are complete, run a trial backup to demonstrate that the configuration works before customizing it further for the production environment. To perform a trial backup:

1 Create the following ARCMAIN script as a simple text file in C:\TDBAR\ARCSAMP.TXT.

LOGON dbc/dbc,dbc;

ARCHIVE DATA TABLES (TESTDB), RELEASE LOCK, FILE=SAMPARC;LOGOFF;

2 Make the C:\TDBAR directory your local directory, then type:

Tivarc <arcsamp.txt

ARCMAIN connects to the Teradata Database and the Teradata Access Module, then successfully creates a SAMPARC\F0000-F000x storage objects in the Teradata file space for the NODENAME defined in the TSM Client Options file. The number of storage objects that are created depends on the size of the database object being backed up (in this example, TESTDB). For more information, see “Overview of Backup Data Storage” on page 117.

3 Use the TDDSMC utility described in Appendix C: “The TDDSMC Administrative Utility” to see metadata information about the backup.

If a zero return code is not returned from the ARCMAIN job, refer to Chapter 5: “Taratddsmc Command-Line Utility”.


APPENDIX B

Storage of Backup Data: Command LineUtility


• Overview of Backup Data Storage

• Functional Restrictions

• IOPARM Parameters

• Security

Overview of Backup Data Storage

ARCMAIN stores Teradata backup data as a series of binary records in a single large file that spans one or more mainframe tapes. Most storage management products, however, store files and directories from a conventional file system.

The Teradata Access Module for Tivoli maps the ARCMAIN backup file to a series of smaller storage objects no bigger than 2 GB. Although no direct correlation exists between Teradata Database/table objects that are stored on the backup and the file segments, the position information passed back to ARCMAIN for seek operations on the backup image indicates the file segment and physical byte offset within the segment. Though ARCMAIN is unaware of the particular storage medium that is used, ARCMAIN is able to reposition to different database objects on the backup image.

Object Names

Naming conventions used by the TSM storage catalog are the same as those used in a typical network:

• The Client Node Name is normally identified to the Storage Manager when the TSM server connection is first opened.

• The File Space or Object Name Space is Teradata.

• The full directory path to any storage object consists of two distinct components: a hierarchical string of directory names and the actual storage object file name.

The left portion of the directory path is a hierarchical string, called the high level name in Tivoli terms. This portion of the path is user-defined, and can be up to 255 characters, including characters normally used to define conventional directory paths. For more


Appendix B: Storage of Backup Data: Command Line UtilityOverview of Backup Data Storage

information, see the description of the DATASETNAME field in “Parameter Definitions” on page 125.

The right portion of the directory path is the storage object file name, or the low level name in Tivoli terms. This portion is a system-generated name for individual file segments in the form of Fnnnn, where nnnn is a four-digit integer with leading zeros. For example, a backup of 9 GB of data with the default segment size of 2 GB creates six storage objects with low-level names of F0000 through F0005.

Note: Storage object name F0000 is reserved as a generation number placeholder by the Teradata Access Module for Tivoli. It contains no data.

In general, there is no need to know specific naming conventions because the TDDSMC utility that is described in Appendix C: “The TDDSMC Administrative Utility” manages storage objects at the backup image level, and because most conventional TSM tools do not display the contents of the storage file spaces created to manage Teradata backups. However, some TSM commands, such as QUERY CONTENT, display individual storage object names. Therefore, some knowledge of these naming conventions is helpful.

DataSetName in ARCMAIN Backups and Restores

ARCMAIN scripts usually only use DATASETNAME when referring to particular backup images, but failure to specify this value in an IOPARM string does not cause a Teradata Access Module for Tivoli error.

The Teradata Access Module for Tivoli uses these rules to determine a DATASETNAME. If the DATASETNAME field is:

• Specified in the IOPARM string, that name is used.

• Not specified, the Teradata Access Module for Tivoli uses the external name that is passed by ARCMAIN when the file opens. This external name is specified as follows:

• If the ARCMAIN FILEDEF command line option is used, the name indicated in FILEDEF is used.

• If no FILEDEF option is identified, the Teradata Access Module for Tivoli uses the name identified on the FILE= clause. This name is limited to eight alphanumeric characters.

Names stored in the TSM server catalog are case-specific. Therefore, if a restore job or TDDSMC QUERY BACKUP command does not correctly capitalize the non-wildcard portions of a DATASETNAME, an error message results, stating that the backup image cannot be found. For example, FILE=DATA01 and FILE=Data01 can mean the same thing to ARCMAIN, but if FILE=DATA01 is an ARCMAIN backup job and FILE=Data01 is an ARCMAIN restore job, an error results.

Table 24 lists sample backup image names that can be used in the Teradata Access Module. Also listed are the corresponding storage object name that each backup image generates.


Appendix B: Storage of Backup Data: Command Line UtilityFunctional Restrictions

Backup Generations

Typically, backup options are defined once, then multiple backup jobs are run using the same options. To make identical backup jobs unique, the Teradata Access Module for Tivoli tags each storage object with a unique generation number that is assigned when ARCMAIN starts the File Open function. View these numbers by using the %gen% format field in TDDSMC QUERY BACKUP and QUERY OBJECT commands. For more information about these commands, see Appendix C: “The TDDSMC Administrative Utility”.

By default, a request for a backup produces only the most recently created file generation (latest), or the active version in Tivoli terms. All other copies of a relevant object in storage are referred to by Tivoli as inactive versions. The generation parameter is not needed when requesting a restore of the latest (active) backup generation. However, when restoring an inactive backup, use the GENERATION field of the IOPARM string.

Generation numbers are not part of the file name or the TSM naming convention. Instead, the Teradata Access Module for Tivoli stores the generation number inside the TSM object information. To ensure the creation of unique generation numbers for concurrent backups that use the same name, object segment zero (F0000) acts as a placeholder for the job-specific generation number. Object segment zero contains no data and is constructed and committed in its own TSM transaction.

For more information on the GENERATION field, see the detailed description in “Parameter Definitions” on page 125.

Functional Restrictions

The following restrictions apply to ARCMAIN jobs that use the Teradata Access Module for Tivoli.

Table 24: Specifying Backup Image Names

Backup Image Name Storage Objects Created

tivarc <arc.txt ioparm=’datasetname=Marketing\Research.data’ Marketing\Research.data\F0000

Marketing\Research.data\F0001

Marketing\Research.data\F0002

tivarc <arc.txt filedef=(CLUST001, Marketing_Cluster_001)

(arc.txt file contains an ARCHIVE DATA TABLES statement with the clause: “FILE=CLUST001”)

Marketing_Cluster_001\F0000



tivarc <arc.txt

(arc.txt file contains an ARCHIVE DATA TABLES statement with the clause: “FILE=ARCHDATA”)

ARCHDATA\F0000

ARCHDATA\F0001

ARCHDATA\F0002



No RESTART During Write

Teradata Access Module for Tivoli uses a transactional model when creating new storage objects. This means that all changes are lost (with the exception of file segment zero, F0000) if an ARCMAIN job abnormally terminates before committing the transaction. The result is a rollback, meaning that the backup job cannot be restarted from the point of failure. Rollbacks also occur if the Teradata Database resets during a backup operation because the Teradata Access Module for Tivoli and ARCMAIN are unable to coordinate checkpoint and repositioning activities. For example, a tpareset on the Teradata Database causes in-progress backup jobs to fail.

This limitation does not apply to READ operations, such as restore jobs (ARCMAIN RESTORE or COPY statements). If an ARCMAIN restore job ends abnormally, the RESTART and RESTARTLOG options restart the job at the point of failure, provided no other complications occurred.

ARCHIVE Statement Recommendation Per Script

Create only one ARCHIVE statement per ARCMAIN script. ARCMAIN scripts that contain multiple ARCHIVE statements might create a valid backup even though the first statement fails. In other words, if a first statement fails when the second statement is valid, the second statement creates a backup. To consider both backups as a single logical set, manually edit the ARCMAIN job to only process the first ARCHIVE statement, then resubmit the job.

To avoid having to manually edit and resubmit jobs due to multiple statements and generated errors, code only a single ARCHIVE statement in an ARCMAIN script.

No Dual Backup Support

Dual backups are not supported, therefore do not create ARCMAIN backup scripts with more than one FILE= clause on the ARCHIVE statement. Including more than one File= clause causes an “ARC0210: Too many archives have been specified” error message.

Interoperability

Backups cannot be restored across platforms. For example, an ARCMAIN backup job that is run on Windows 2000 must also be restored on Windows 2000.

Collocation

By default, TSM reduces the number of distinct media volumes used to store backups. This means that it is possible to have data from two ARCMAIN backup jobs stored on the same physical volume. Any attempt to restore data from both backups in parallel causes the second job to hang while it waits for the tape volume to be read by the first job.



To minimize or prevent the storage of two ARCMAIN backups jobs on a single physical volume, do any of the following:

• Use the ARCMAIN options ALL and EXCLUDE on the ARCHIVE statement to collect many smaller database and table objects into a single Teradata backup job.

• Use the CATALOG option to selectively restore such objects with a minimal amount of tape scanning.

• Create different TSM management classes and storage pools.

Examples of Restrictions

The following examples illustrate some of the restrictions discussed in this section. Each example assumes the configuration shown in Table 25.

To tailor these examples, refer to the Teradata Archive/Recovery Utility Reference.

Example 1: Archive Script for Single-Node Backup

This example creates ARCMAIN backups that originate from a single TSM node, NODE1, with a minimum command line.

The minimum command line for ARCMAIN is to simply specify the ARCMAIN input file. The ARCDFLT.TXT sample file indicates the path to the TIVBAR.DLL executable with the IOMODULE parameter. In this case, DATASETNAME corresponds to the name indicated on the FILE= clause of the ARCMAIN ARCHIVE statement.

Table 25: Configuration for Examples

Parameter Assumption or Name Used

Environment Windows 2000/2003

Environment Variables TIVARC.BAT file that comes with the samples sets variables, such as ARCDFLT, to contain standard command line options for ARCMAIN.

Location of Teradata Database

Teradata server called EDW001

Password pwd

Path Environment Variable Includes the path to ARCMAIN.EXE, TIVBAR.DLL, and the sample files that come with the installation program.

For more information, see “Environment Variables” on page 129.

TDPID td1

Teradata User ID dba1



To create this type of backup:

1 Ensure that file pointed to by the ARCDFLT environment variable is Iomodule=’tivbar.dll’.

2 On the command line, type:

tivarc <arcin.txt

Output

arcin ARC script

Logon td1/dba1 , pwd;Archive data tables (db1) , release lock , file= db1_data; Logoff ;

Backup Information in TSM Catalog

• Node = NODE1

• Filespace = Teradata

• High Level = db1_data

• Low Level = F0000, F0001, F0002, and so on

Example 2: Restore Script for Single Node Backup

This example restores a backup that originates from a single TSM node, NODE1. To restore the latest generation of the first backup, change the ARCMAIN script to use a RESTORE or COPY statement. The command line stays the same.


1 Ensure that the file pointed to by ARCDFLT environment variable is Iomodule=’tivbar.dll’.


tivarc <arcin.txt

Output

arcin ARC Script

Logon td1/dba1 , pwd; Restore data tables (db1) , release lock , file= db1_data; Logoff ;

Backup Information in the TSM Catalog

• Node = NODE1



• Low Level = F0000, 0001, F0002, and so on



Other Considerations

To restore the backup generation just before the latest backup, use this IOPARM value:

tivarc <arcin.txt ioparm=’generation=-1’

For information about specifying relative and absolute generation numbers, see “Parameter Definitions” on page 125.

Example 3: Archive Script for Multiple-Node Backup

The next example performs a ARCMAIN backup that originates from multiple client nodes or multiple security domains with the default TSM administrator for the Tivoli EDW001 pseudo node.


1 Ensure that the file pointed to by ARCDFLT environment variable is dsm.opt.


tivarc <arcin.txt

Output

arcin ARC Script

Logon td1/dba1 , pwd; Archive data tables (db1), release lock , file= db1_data; Logoff ;

dsm.opt File

TCPSERVERADDRESS 128.00.00.00PASSWORDACCESS PROMPTCOMMMETHOD TCPIPNODENAME EDW001PASSWORD EDW_PASSWORD

Backup Information in the TSM Catalog

• Node = EDW001



• Low Level = F0000, F0001, F0002, and so on

Other Considerations

The considerations described above for archive also apply to restore. The TSM Administrator password is stored indsm.opt. Therefore, you might want to restrict who can read this special Options file, as explained in “Security for Files that Contain Passwords” on page 127.

If password expiration is in effect for this TSM Administrator, regularly update dsm.opt on every node where an ARCMAIN job references it to reflect the new password or sets the password.


Appendix B: Storage of Backup Data: Command Line UtilityIOPARM Parameters

Define TSM nodes for multiple Teradata servers (such as, when there is a production and a development server in the data center). In this case, the ARCMAIN command line is similar to the one shown above, but a different dsm.opt file that indicates the appropriate node name and password for that server can be pointed to. Therefore, use the correct Teradata logon in the ARCMAIN script.

IOPARM Parameters

Teradata Access Module for Tivoli specifies processing options in one of two places:

• Teradata Access Module for Tivoli checks the BARAM_DEFAULT environment variable for the path to a file that contain one or more of the parameters indicated in “Parameter Definitions” on page 125.

BARAM_DEFAULT is described in “Environment Variables” on page 129.

• ARCMAIN passes a string to Teradata Access Module for Tivoli that contains a list of parameters that are user-defined with the IOPARM command line option. Specify the IOPARM string explicitly on the ARCMAIN command line, or include the string in the ARCMAIN default file, described in “Default Files for ARCMAIN and the Access Module” on page 128.

Parameters are described in “Parameter Definitions” on page 125.

The following sections define parameters that can be specified in either place.

Syntax Rules

The following syntax rules explain the criteria for acceptable parameters and how to properly assign values to parameters:

• Separate multiple parameter assignments by blanks or commas. Repeated blanks, tab characters, and other white space characters are ignored. Unless otherwise stated, each parameter assignment has this form:

PARAMETERNAME = value

• Parameter names are case-insensitive. For example, config, CONFIG, and cONFIG are all acceptable. The equal sign (=) between the parameter name and the value can be replaced by one or more blanks. Blanks and a single comma can separate multiple parameter assignments on the IOPARM string.



• The assigned value can be one of the following, depending upon the parameter semantics:

• Parameters can be defined multiple times in a IOPARM string, but only the last assignment for the relevant parameter in the IOPARM string takes effect. Use this convention to override an entire set of parameter assignments.

• The following command line uses a second default file to override or merge with the normal settings established by the BARAM_DEFAULT environment variable:

Tivarc <arcsamp.txt ioparm=’default=c:\tdbar\mydefaults.txt’

Parameter Definitions

The Teradata Access Module for Tivoli uses the IOPARM parameters shown in Table 26. In some cases, if a parameter is not specified, the default value in the description column is assigned as the parameter name.

Value Description

Directory Path Value

Similar to a name token with the possible inclusion of forward slashes, backslashes, or periods within the overall name. In addition, directory paths can have a colon character (:) as the second character to separate the drive letter from the rest of the directory path. For example, C:\TIVBAR is a valid directory path.

Directory paths can be up to 255 characters. Express embedded special characters not mentioned above (such as, blanks) as a quote string value.

Integer Value Consists of numeric digits (0 through 9) from one to six digits long with an optional sign (+ or -).

Note: Avoid numbers expressed with a decimal point or in scientific notation.

Name Value Must be 30 or fewer alphanumeric characters that begin with a non-numeric character. To maintain consistency with Teradata SQL names, a dollar sign ($), underscore (_), or sharp symbol (#) are considered alphabetic characters. As with parameter names, name values are case-insensitive.

Quote String Value

Can be up to 255 characters and must be enclosed with either single-quote (‘) or double-quote (“) characters.

Note: Any valid ASCII character can be between the outermost quote characters, but a second occurrence of an opening quote will terminate the string.

For example, ‘a “ b’ and “a ‘ b” are valid quote strings, but ‘a” b’ would be interpreted as two different quote strings, because the two single-quote characters in the middle would be interpreted as ending the first and starting a second string.



Table 26: Parameter Definitions

Parameter Value Type Description

CONFIG Directory Path Path to TSM client configuration file, dsm.opt. The DSMI_CONFIG environment variable typically establishes a basic environment context.

Note: CONFIG, if indicated, is used for the actual TSM server connection.

DATASETNAME Directory Path User-defined high-level name of backup file in storage.

No default value exists, but if this parameter is not defined, the high-level name becomes the external name defined on the ARCMAIN FILEDEF parameter or the name on the FILE= clause. The FILE= clause is limited to eight alphanumeric values.

DATASETNAME can also contain substitute variables that generate unique names for the backup. However, if either of these variables are used, specify DATASETNAME in a file of command line defaults:

• %time% is a substitution token replaced by the local date/time in the form: YYYYMMDD_HHMMSS where YYYY=Year, MM=Month, DD=Day, HH=Hour, MM=Minutes, and SS=seconds.

• %date% is a substitute token replaced by the local date in the form: YYYYMMDD where YYYY=Year, MM=Month, and DD=Day.

DEFAULT Directory Path Path to the file of Teradata Access Module for Tivoli command line defaults. The parameter settings in this file are merged with parameter settings in the file indicated by the BARAM_DEFAULT environment variable and with any explicit command line parameters.

Parameter assignments are expanded at the point where DEFAULT is indicated with the last specification in left-to-right order-taking precedence. For example, the following command line causes the TDDSMC utility to use the TSM Client Options file (indicated in myopts.txt) last:

Tddsmc -config=mydsm.opt -default=myopts.txt

DIRDELIM Single non-blank character

Override TSM default directory path delimiters in storage object names. By default, this value is a backslash (\) on Windows platforms and a forward slash (/) on UNIX platforms.

Note: Specify this parameter only in the DEFAULT file.

FORMAT Quote string Default format string for Query Backup and Query Object command output of the TDDSMC utility. For more information, see Appendix C: “The TDDSMC Administrative Utility”.

This parameter has no bearing on ARCMAIN processing.

GENERATION Integer The backup file generation name to use for restore. The default value, 0 (zero), corresponds to the latest generation. A value that is:

• Positive indicates the specific generation number in storage (active or inactive).

• Negative indicates the relative generation number since the latest generation. For example, if the latest generation is 15, then Generation -2 is Generation 13.

However, in this example, GENERATION=15 corresponds to the fifteenth backup that was ever performed, using the indicated DATASETNAME name.

Not specifying GENERATION restores the latest backup.


Appendix B: Storage of Backup Data: Command Line UtilitySecurity

Security

When configuring a system, consider the security features listed in Table 27. For additional information about managing security for Teradata Archive and Recovery, TSM, and Windows, see “Additional Information” on page 5.

Security for Files that Contain Passwords

To store passwords in configuration files, secure them by right-clicking the file or directory icon in Windows Explorer and selecting the Security tab of the Properties menu. Grant read authority only to the user IDs or groups that execute ARCMAIN backups or start the TDDSMC utility.

MGMTCLASS Name The TSM management class for all storage objects created by a backup operation. This parameter overrides any INCLUDE list specified in the TSM Client Options file, dsm.opt. Before using the parameter, define a management class with this name and a valid backup copy group with the TSM server. For more information, see the Tivoli Storage Manager for Windows: Administrator’s Guide.

NOHEADER Not applicable A single keyword to suppress the display of column headers for Query Backup and Query Object commands of the TDDSMC utility. Use this parameter to pipe the output to the sort utility.

This parameter has no bearing on ARCMAIN processing.

Table 26: Parameter Definitions (continued)

Parameter Value Type Description

Table 27: Security Features

Component Security

Teradata Database Teradata server user ID and password authenticate the authority of an ARCMAIN job to back up or restore specific data on the Teradata Database.

Note: It is possible to grant a Teradata user DUMP, RESTORE, and CHECKPOINT privileges, but not the authority to select or modify particular database objects.

Windows Operating System Windows operating system user ID and password launch ARCMAIN.

Tivoli Storage Manager The TSM administrative user ID and password associate default storage management policies to a job and authenticate that a given job can restore particular data.

Refer to the relevant Teradata and Tivoli documentation for administrative setup procedures that avoid storing passwords in the configuration files or scripts. For a list of those documents, see “Additional Information” on page 5.



To secure access to the job execution directory (such as C:\TDBAR):

1 Use the LOGON Option in the ARCMAIN default file. Avoid specifying passwords in the ARCMAIN script or on the explicit ARCMAIN command line.

2 Use the PASSWORD Option in the TSM Client Options file and secure the file, using the method described above.

Note: Do not specify secure passwords on the explicit command line to any tools because operating system diagnostic traces or screen printouts often disclose those items. For more information about default, refer to “Default Files for ARCMAIN and the Access Module” on page 128.

Control of Access to Backup Images Stored in TSM

It is critical to control access to backup images that are stored in TSM when running multiple Teradata backup jobs. Stored data often contains sensitive information (such as financial material) that requires restricted access. Limit access to particular subsets of Teradata backups by creating additional TSM client nodes that correspond to each security domain to be established.

In the same way that defining pseudo nodes in the TSM catalog is recommended for all Teradata backups, pseudo nodes for each major security domain can also be created. Use these TSM server administration console commands, for example, to segregate financial data backups from other data warehouse backups:

Register node EDW001 EDW_PASSWORDRegister node EDW_FINANCE FINANCE_PASSWORD

Choosing this option requires creating special copies of the Default and Client Options files to store the passwords in restricted files. Set these restrictions in Windows.

Default Files for ARCMAIN and the Access Module

The Teradata Access Module for Tivoli installation process creates a special directory for holding Default and Client Option files, which typically default to C:\Program Files\NCR\Teradata Client\TDBAR. TIVARC.BAT and TIVADM.BAT establish environment variables that point to the Default and Client Option files. (For a list of these variables, see “Environment Variables” on page 129.) Copy and customize the Client Options files to match site-specific requirements.

Standardize the options used by the various components in the following ways, any of which can be overridden on the ARCMAIN command line, if necessary:

• The ARCDFLT.TXT configuration file holds the most common ARCMAIN command line options. For details about these options, see the Teradata Archive/Recovery Utility Reference. The DEFAULT option described in that manual explains the format of ARCDFLT.TXT (such as, comment lines).

• The TIVDFLT.TXT configuration file holds the most common options passed to the Teradata Access Module for Tivoli. This file uses the same format as the ARCMAIN default file.



• The Teradata Access Module for Tivoli does not provide a TSM Client Options file, but during the installation process the Teradata Access Module prompts for the location of the file that was created during the TSM installation process.

For information about configuring TSM for Teradata backups, see “Configuration of TSM for Teradata Backups” on page 110. All the options are described in the Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 2.

Note: TSM provides wizards for creating the TSM Client Options file. Therefore, it is acceptable to start from the wizard-generated file before doing further customization.

Environment Variables

TIVARC.BAT and TIVADM.BAT establish environment variables that point to the location of sample Client Option files. Copy and customize the variables shown in Table 28 to match site requirements.

Table 28: Environment Variables

Variable Description

ARCDFLT Path to ARCMAIN command line DEFAULT file.

Note: Include the path name in quotes if there are embedded blanks in the string. This is necessary because of the way ARCMAIN processes this environment variable, but is not necessary for other environment variables.

BARAM_DEFAULT Path to command line defaults file for the Teradata Access Module for Tivoli. Override the fields defined in this file on the command line or specify an alternative default file on the command line.

The format of this file is similar to the format of the ARCMAIN default file. For example, white space and blank lines outside of a quote strings is ignored, and two semi-colon characters in a row mark the rest of the line as a comment that is ignored.

BARAMLOG Path to diagnostic log file for the Teradata Access Module for Tivoli. If this path variable is not defined, it defaults to the current working directory with a log name of baram_log.txt.

Note: Logging always appends to this file. Periodically purge this file to prevent it from growing indefinitely when jobs are rerun.

BARAMLOGLEVEL Numeric indicator of diagnostic logging level used for the Teradata Access Module for Tivoli.

Log levels are 1 through 5, with 1 as the default. If a log level is not specified, logging defaults to 1.

DSMI_CONFIG Path to the TSM client configuration file, dsm.opt.

If this variable is undefined or set to the null string, the TSM API software expects to see dsm.opt in the local directory that executes the ARCMAIN or TDDSMC.

For more information, see the Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 1.

DSMI_DIR Directory path containing the TSM client API error messages file (dscameng.txt). Usually, this is in C:\ProgramFiles\Tivoli\TSM\baclient.



For more information about creating ARCMAIN scripts and implementing Teradata backup and restore processes, refer to the Teradata Archive/Recovery Utility Reference. The usage notes apply specifically to BAR jobs that start the access module.

DSMI_LOG Directory path for storing TSM client log messages (dsierror.log).

If this variable is undefined or set to the null string, and if a log message is locally generated by TSM, dsierror.log is created in the local directory that executes the ARCMAIN or TDDSMC.

For information about using this file in troubleshooting, refer to Chapter 5: “Taratddsmc Command-Line Utility”.

Table 28: Environment Variables (continued)

Variable Description


APPENDIX C

The TDDSMC Administrative Utility


• Overview of the TDDSMC Utility

• Command Line Parameters

• Format Specifiers

• Query TSM Command

• TDDSMC Help Command

Overview of the TDDSMC Utility

The TDDSMC Administrative utility is a command line utility that allows database administrators and TSM administrators to:

• View Teradata backups in the TSM server catalog (the client node and file spaces associated with those backups are displayed, not the actual files in storage)

• Perform maintenance activities on backups

• Generate reports about specific backup images created by the Teradata Access Module for Tivoli

The TDDSMC utility is installed where the ARCMAIN executable is installed. Start the utility through batch mode or interactive mode by way of the command line. During the installation process, a shortcut is created.

Start the TDDSMC utility through the Windows command line by typing:

tddsmc [options] [command]

In batch mode, a single command for execution is included on the command line. Interactive mode occurs when no command is included on the command line. In interactive mode, the TDDSMC utility prompts for input until a quit command is entered.

The installation process creates a TIVADM.BAT file that sets the same environment variables as described in “Environment Variables” on page 129. Store frequently used options in the file pointed to by the BARAM_DEFAULT environment variable.

Each time the TDDSMC utility is started, a TSM server session is opened. In interactive mode, a single session is used for all commands. In batch mode, a different session is opened and closed each time TDDSMC is started.

The next example shows variations of command line options for batch and interactive mode.


Appendix C: The TDDSMC Administrative UtilityCommand Line Parameters

Tddsmc query backup *Tddsmc ?Tddsmc> query tsmTddsmc> query backup fin*Tddsmc> quitTddsmc -noheader query backup dbl_???? | sort /+30 /R >backup.txt

The prompt in interactive mode is shown as tddsmc> . The last line of the example shows how to override the default sort order of the QUERY BACKUP command by piping output to the Windows sort utility.

Command Line Parameters

All the IOPARM parameters that are described in the “Parameter Definitions” on page 125, can also be entered as command line parameters in the TDDSMC utility. Adding a prefix to each field name with a leading hyphen (-) makes command line options easy to distinguish from TDDSMC commands.

Use the IOPARM string specification from an ARCMAIN job as a command line option to the TDDSMC utility. An example of an acceptable string specification is:

Tddsmc -ioparm’config=mydsm.opt,mgmtclass=mymgmtclass q ba *’

Syntax Conventions

The TDDSMC utility uses these commands:

• DELete Backup <pathname> [generation]

• DELete OBJect <pathname> <generation> <segname>

• FORMAT <formatstring>

• HELP <command-type>

• INActivate BAckup <pathname>

• INActivate OBJect <pathname> <segname>

• PROMPT [ ON | OFF ]

• QueRY BAckup <pathname> [generation] [formatstring]

• QueRY OBJect <pathname> [generation] [segname] [formatstring]

• QueRY TSM

• QUIT

The commands follow the rules described in “Syntax Rules” on page 124, plus the following syntax and semantics:

• Uppercase letters denote the shortest acceptable abbreviation of a command.

For example, express QueRY as QUERY, QRY, or Q. Commands that are entirely uppercase cannot be abbreviated.

• Formatstring means that a quoted string value is expected.



• Name means that a name value is expected using general syntax rules.

• Commands are not case-sensitive.

The next example illustrates how to apply these rules. The user-supplied namepattern is required, but the gen and formatstring tokens are optional. The number of blanks or white space characters between keywords and tokens does not matter as long as the entire command is on a single line:

QueRY BAckup namepattern [ gen ] [ formatstring ]

Add comment lines in scripts by putting an asterisk (*) as the first non-blank character on a line. All-blank lines are echoed to the output stream.

Format Specifiers

Format string and format specifiers control the display output of the QUERY BACKUP and QUERY OBJECT commands. Any characters not contained within a format specifier are passed and displayed as is. For example, to produce Cr Time JJ BackupName, type:

%crdate% JJ %name%

Note: One exception to this rule is that the literal “\t” character sequences are translated to tab characters. To generate tab-delimited output files, type: ‘%crdate%\t%name%\t%size%’.

Override the default field width of any of these metadata files by including a colon (:) and an integer width value inside the end delimiter. Positive width values are right-justified and negative width values are left-justified.



Table 29 lists metadata fields, plus default widths, headings, and format specifiers.

Examples

The %name:15% specifier:

• Restricts the name field to 15 characters and right-justifies the string in the field.

• Has the same field width, but strings are left-justified in the field. Values longer than 15 characters are not truncated, but do skew the alignment on the line. The maximum field width is 255 characters.

Table 29: Metadata Fields

FieldDefault Width Heading Format Specifier

Active/Inactive State -1 A/I %status%

Backup name (high-level) -30 Backup Name %name%

Compressed/Uncompressed -1 C/U %compress%

Creation Date (YYYY-MM-DD format) -10 Cr Date %crdate%

Creation Time (HH:MM:SS format) -8 Cr Time %crtime%

Expiration Date (YYYY-MM-DD format) -10 Expire %exp%

Filespace Id 9 FS ID %fsi%

Filespace Name -30 FS Name %fs%

Generation Number 4 Gen %gen%

Management Class -30 Mclass %mc%

Media Class (such as, library, fixed-disk, off-site) -12 Media Class %media%

Number of file segments 4 # Seg %segcnt%

Segment Name (low-level) -30 Seg Name %segname%

Total size in MB 9 Size (MB) %size%



Next is an example of a command and the report it generates. The report shows that values longer than the specified width are not truncated, but the alignment is skewed.

tddsmc> q ba * * ‘%crdate% %crtime% %name:-15% %gen% %status%

Retrieved 17 records filtered to 8 backups

TDDSMC Help Command

The Help command causes the TDDSMC utility to display syntax information for the defined command type. If no command is entered or an invalid command is entered, it is equivalent to HELP HELP.

To access TDDSMC Help, do one of the following:

• Start the TDDSMC utility with a question mark character (?). On the command line, type:tddsmc ?

When the TDDSMC Help utility is started with a question mark (?), the utility does not attempt to open a session with the TSM server.

• In interactive mode, type:

TDDSMC> Help

These Help commands are available:

• Help CMD displays syntax information for TDDSMC commands.

• Help FORMAT displays syntax information related to format strings.

• Help Help defines the various HELP commands that can be issued.

• Help TDDSMC displays information about the TDDSMC command line.

Query TSM Command

QUERY TSM displays information about the current session configuration settings. This is the same information that is written to the log file when diagnostic tracing is enabled. Sample output from the command is shown in the following report.

Cr Date Cr Time Backup Name Gen A/I

2004-03-24 11:17:46 DATA0001ajwallace_20040324 1 A

2004-03-04 10:59:35 SPAN02 2 I

2004-03-09 09:13:36 TBFASF 1 A

2004-03-04 11:51:00 TBFASF 1 A

2004-03-10 13:34:06 TBFASF 10 A

2004-03-10 05:18:39 TBFL01 9 I



The QUERY TSM command output is divided into three sections.

The first section displays client-side options that connect the TSM server. For example, the first two lines indicate the environment variables currently in effect.

The nodeName field indicates the client node name that opens the TSM server connection. When using multiple node names to store Teradata backups, any QUERY BACKUP and QUERY OBJECT commands restrict access to only the backup created by this node.

The other two sections of the QUERY TSM output describe the context of the TSM server session. Use this information to determine whether you are connecting to the correct TSM server, default management class, and so on.

DSMI_DIR - C:\Program Files\Tivoli\TSM\api

DSMI_CONFIG - C:\ProgramFiles\NCR\ TeradataClient\TDBAR\dsm.opt

serverName - SERVER1

commMethod - TCP/IP

serverAdrress - 188.88.88.888

nodeName - NODE1

compress - 0

compressalways - 1

passwordAccess - PROMPT

Server name - SERVER1

Server Host - 188.88.88.888

Server port - 1500

Server type - Windows

Servr Date/Time - 2004-01-29 17:22:08

Servr Release - 05.02.02.01

Client node type - Teradata

Client filespace delimiter - :

Client h1 and 11 delimiter - \

Client delete backup obj? - No

Maximum objects in txn - 4080

Client Node Name - PINOT

Session Owner -

API Config file -

Policy Domain - STANDARD

Management Class - STANDARD

Backup retention grace period - 30 days



For more information about field display, refer to these IBM manuals:

• Tivoli Storage Manager for Windows: Administrator’s Guide: Version 5, Release 2

• Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 2

Prompt Off Command

The PROMPT OFF command disables the tddsmc> prompt. Using this prompt might make the TDDSMC output a bit more readable if I/O re-direction is used to pass an entire script of TDDSMC commands to the utility and save the results in a file.

Reenable the prompt with the PROMPT ON command.

Query Backup and Query Object Commands

The QUERY BACKUP and QUERY OBJECT commands print a formatted report about Teradata objects in storage that match an identified search pattern. The syntax is shown below.

Note: QUERY OBJECT shows one record per storage object whereas the QUERY BACKUP command aggregates totals to have one record per Teradata backup generation.

QueRY BAckup namepattern [ gen ][ formatstring ]QueRY OBJect namepattern [ gen ][ segnamepattern ][ formatstring ]

The node name context is established at session logon. Tivoli API limitations cause case-sensitive matching on the name patterns.

The optional gen field filters output to specific backup file generations. The default value of zero for the gen field restricts output to only the most recent generation of a backup. An asterisk (*) character in the gen field qualifies for all versions of the qualified backups. Relative generation numbers, such as -1 for the second-to-last most recent backup, can also be indicated.

The segname pattern refers to a segment number (F0000 through F9999). An asterisk (*) character in the segname pattern field returns all segments for a given object.

For example, QRY OBJ span* 2 *1 returns segment F0001 for generation 2 of all objects matching the span pattern.

If a format string is not specified in the command, the current default determined from the FORMAT command line option is used. For further explanation on format strings, see “Format Specifiers” on page 133.

Delete Backup and Delete Object Commands

The DELETE BACKUP and DELETE OBJECT commands expire, and then remove, the qualified objects from storage.

DELete BAckup namepattern [ gen ]DELete OBJect namepattern [ gen ] segnamepattern



Inactivate Backup and Inactivate Object Commands

The INACTIVATE BACKUP and INACTIVATE OBJECT commands change the qualified storage objects from an ACTIVE to an INACTIVE state. The syntax is shown below.

INActivate BAckup namepatternINActivate OBJect namepattern segnamepattern

These commands operate only on active storage objects; otherwise, the commands operate in a similar way to DELETE. Objects are not deleted, but the file retention rules for the backup copy group expire the object when it becomes inactive.

Note: If the TSM server policy limits the number of inactive versions of a storage object, the oldest version might expire.

For more details about the TSM storage management policies, refer to the Tivoli Storage Manager for Windows: Administrator’s Guide: Version 5, Release 2.


APPENDIX D

Troubleshooting: Command Line Utility

This chapter discusses errors for the legacy Teradata Access Module for Tivoli:

• Overview of Error Messages

• Teradata Access Module for Tivoli Debug Log

• ARCMAIN Outlog

• TSM Log Messages

• Error Conditions and Recovery

• Data Connector Error Messages

• Vendor-Independent Error Messages

• TSM Error Messages

Overview of Error Messages

If errors occur with Teradata Access Module for Tivoli during a Teradata backup, the access module and TSM generate debug logs that can be used for troubleshooting.

Error messages reported by Teradata Access Module for Tivoli can originate from several software components. Determining the root cause of an error depends on the application that reports the problem. Table 30 lists different types of messages that can occur.

Table 30: Types of Messages


ARCnnnn messages These messages are generated by ARCMAIN client code.

None

BAMnnnn messages These messages are generated by Teradata Access Module for Tivoli.


ANSnnnn messages These are TSM client messages. Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.





Appendix D: Troubleshooting: Command Line UtilityTeradata Access Module for Tivoli Debug Log

Note: Some error codes have multiple error messages, which are listed in the bullet lists in the Error Message Text column.

Teradata Access Module for Tivoli Debug Log

Teradata Access Module for Tivoli automatically writes diagnostic tracing information to a debug log file. Control the name and location of this log file and the level of tracing using the environment variables BARAMLOG and BARAMLOGLEVEL. For more information on these variables, see “Environment Variables” on page 129.

By default, the debug log file is called baram_log.txt and is located in the current working directory where ARCMAIN runs. Diagnostic tracing in the debug log is available at the levels shown in Table 31.

ANRnnnn messages These are TSM Server messages. Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.


Messages with error numbers that range from -50 to +50

These error messages are associated with Teradata Access Module for Tivoli or TSM.

Refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM being used.


Messages with error numbers that range from 1 to 50

These ARCMAIN errors are associated with the Data Connector component.


Error messages in the form of "*** Failure nnnn: ..."

These are ARCMAIN errors that most likely originate with the Teradata Database.

Messages

Table 30: Types of Messages (continued)


Table 31: Log File Levels

Level Description

1 Defaults to 1 if a log level is not specified.

Tracing at this level logs major events, such as opening/closing a file or shutdown. At shutdown, a summary report of I/O counts and number of bytes reads/writes from/to each file displayed.

2 Displays call trace information at the BAR_Session level for most functions, except the calls to read/write individual data blocks.






Appendix D: Troubleshooting: Command Line UtilityARCMAIN Outlog

ARCMAIN Outlog

Always evaluate ARCMAIN output to ensure that each job runs successfully; all error messages (including the error code and message text) are displayed in the ARCMAIN outlog.

Teradata Access Module for Tivoli returns an error code and message text for ARCMAIN to output to its various log files. The message text and any additional debug information is also written to the debug log of Teradata Access Module for Tivoli.

TSM Log Messages

The error codes in the 1200 to 1299 range originate in TSM, which logs diagnostic information in these log files:

• TSM Server Activity Log

• TSM Client Log

TSM Server Activity Log

Teradata Access Module for Tivoli generates Teradata-specific messages in the TSM server activity log every time it opens and closes a backup fie. These messages are strings that include TDB0nnn, where nnn is the message ID.

The following example includes a command, plus the report it generates, of Teradata Access Module for Tivoli messages that are associated with opening a Teradata backup file in WRITE mode:

Query actlog search=TDB0002

3 Logs TSM API function calls and includes more descriptive information about each read/write operation.

4 Includes information at trace level 3, in addition to memory buffer information.

5 Includes information at trace level 4, and Data Connector function codes and returns.

Table 31: Log File Levels (continued)

Level Description

Date/Time Message

06/23/2003 11:41:54

ANE4991I (Session: 4901, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata,DSN-DATA0001 Generation=3 in write mode

06/23/2003 11:56:17

ANE4991I (Session: 4903, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN-DATA0002 Generation=4 in write mode


Appendix D: Troubleshooting: Command Line UtilityError Conditions and Recovery

Query for all messages associated with a particular session or time period to see the server context of the operation, such as, device errors from mounting tapes.

The default retention period for a TSM server activity log is only one day, so regular checks are recommended. Viewing older logs requires special procedures.

For more information about the syntax of the QUERY ACTLOG command, refer to IBM’s Tivoli Storage Manager for Windows: Administrator’s Reference: Version 5, Release 2.

TSM Client Log

Errors and abnormal conditions on the TSM client node are written to a client log file, typically named DSIERROR.LOG. The location of this file is controlled at runtime by the DSMI_LOG environment variable or is written to the local directory.

The TSM client log file always opens in APPEND mode, therefore verify activity by checking the date/time stamp on all messages. View these log files in any text editor, such as Notepad.

Error Conditions and Recovery

The error messages that are displayed during ARCMAIN operations can originate from various software components.

The error conditions shown in Table 32 can occur while starting Teradata Access Module for Tivoli or while backing up data. Use this information to ensure that the installation process is successfully completed and that all recovery options are considered.

06/23/2003 11:56:44

ANE 4991I (Session: 4905, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN=DATA0001\Long_Path$#.DATA Generation=1 in write mode

06/23/2003 11:57:12

ANE4991I (Session: 4906, Node: MERLOT) Teradata TDB0002System merlot Opening Teradata backup NS=Teradata,DSN=DATA0001.DSN Generation=1 in write mode

Date/Time Message


Appendix D: Troubleshooting: Command Line UtilityError Conditions and Recovery

Table 32: Error Conditions and Recovery Options


An invalid option was found during option parsing

This is a dsmSetup error. The installation process attempted to read Windows registry settings to determine the paths to TSM. However, there was an invalid option found during option parsing, probably due to an invalid option specification in the TSM Client Options file.

Refer to the DSIERROR.LOG file and determine which line of the options file is invalid. The path to this file is set with the DSMI_LOG environment variable or the path defaults to the local directory.

For more information about TSM Client Options, refer to IBM’s Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User’s Guide, Version 5, Release 2 documentation.

ANSnnnn or ANRnnnnTSM errors

Teradata Access Module for Tivoli attempts to gather as much information as it can about the root cause of errors. Query the TSM server activity log for device errors or other messages that did not get conveyed to the client process. For information on the TSM server activity log, refer to “TSM Server Activity Log” on page 141.

Alternately, check for DSIERROR.LOG file error messages on the client.

dsmInitEx -- Session rejected This is an open session error from Teradata Access Module for Tivoli, related to opening a TSM server connection.

This is an authentication error, the most common source of open session errors. An invalid NODENAME or PASSWORD is defined in the TSM Client Options file. For more information about how settings need to match what is defined for the TSM server, see “Configuration of TSM for Teradata Backups” on page 110.

Errors that include a traceback Teradata Access Module for Tivoli maintains an internal trace buffer that is dumped to stderr output when exceptional conditions occur, such as memory access or illegal instruction. This type of diagnostic output is a problem that can only be corrected by the Teradata Development organization, therefore:

1 Capture a complete output listing. For information about generating diagnostic traces, see “Environment Variables” on page 129 for details about the BARAMLOG and BARAMLOGLEVEL environment variables. These variables control the diagnostic tracing for the access module.

2 After collecting the trace information, contact the Teradata Global Support Center.

File locking contention can occur when two jobs attempt to write to the same log file at the same time.

Hung up on a tape mount Device messages often show up in the TSM server activity log. For more information on the TSM server activity log, refer to “TSM Server Activity Log” on page 141.

Hung up on a Teradata Database lock

Consult the Teradata QUERYSESSION and SHOWLOCKS console utilities for help.

Options file ‘*’ not found This is a dsmSetup error. The installation process attempted to read Windows registry settings to determine paths to TSM. However, the TSM Client Options file was not found.

One or more of the DSMI environment variables described in “Environment Variables” on page 129 are not properly set. Edit the TIVARC.BAT and TIVADM.BAT files accordingly.


Appendix D: Troubleshooting: Command Line UtilityData Connector Error Messages

Data Connector Error Messages

The error messages shown in Table 33 correspond to Data Connector error codes that range from 0 to 999.

The file cannot be found or is improperly formatted

Locate the file and correct the format.

The installation process should have created a TDBAR configuration file directory (which is usually C:\Program Files\NCR\Teradata Client\TDBAR). The TIVARC.BAT file starts ARCMAIN with the sample ARCDFLT.TXT file as the ARCMAIN default command line option file.

tivarc (tivadm) is not recognized as an internal or external command, operable program or batch file

The %PATH% is wrong.

The environment variable for %PATH% does not include the location of the TIVARC.BAT, ARCMAIN.EXE, and TIVBAR.DLL files. Usually this location is C:\Program Files\NCR\Teradata Client\BIN.

Unable to see backups in storage using TDDSMC

If the ARCMAIN process seems to be error-free, but verifying that the storage object was created on the TSM server is not possible, check the following:

• Is the TCPSERVERADDRESS field of the TSM Client Options file indicating the correct IP address? In other words, is Teradata Access Module for Tivoli connected to the proper TSM server?

• Are you querying the TSM server for the correct node name? To see what node name was used to create the backup, execute the following command from the TSM Server Administrative Console:

query activitylog search=TDB0002

• Is the DATASETNAME pattern correctly entered? (TSM is case-sensitive.)

The QUERY TSM command from the TDDSMC utility might provide additional information. See Appendix C: “The TDDSMC Administrative Utility”.

Table 32: Error Conditions and Recovery Options (continued)


Table 33: Data Connector Error Codes


BAM0011 Access module called by < > when expecting < > Teradata Access Module for Tivoli is being called by a program other than ARCMAIN, but the access module can only be used for Teradata backup and restore.



Appendix D: Troubleshooting: Command Line UtilityData Connector Error Messages

BAM0013 Invalid open mode < > requested Teradata Access Module for Tivoli is being asked to open a file in an invalid mode.

This error might indicate a software version incompatibility between the access module and the Data Connector. More likely, the error is related to some type of software corruption.

Remedy: Contact the Teradata Global Support Center.

BAM0018 Expected Data Connector Version (< > < >) but actually got (< > < >)

The Data Connector version is incompatible with Teradata Access Module for Tivoli.

The Data Connector corresponds to the libpm.dll component on Windows and the libpm.so component on UNIX. Verify that the correct component is being loaded and the correct installation path is being used.


BAM0020 • Invalid token entered for Directory Delimiter

• Directory Delimiter must be single non-alphabetic

• No closing quote character < > value < > found after < > characters

• File path cannot exceed characters

• Name cannot exceed < > characters: < >

• Colon character < > in wrong place for a directory path

• Invalid substitution variable < > (need closing < > character)

• Unrecognized substitution variable < >

• Unrecognized character < > (value < >) at position < >

• < > is not a valid name value for < > field


• < > field assignment must be a quoted string value

• < > is not a valid number for < > field

• < > field value cannot be a decimal


• Unrecognized field name starting at: < >

The IOPARM string or the command contains a syntax error.

This error message can result from a number of causes, all related to the user-entered command syntax. For proper syntax diagrams, refer to the relevant access module documentation.

Remedy: Correct the error and resubmit the job.




Appendix D: Troubleshooting: Command Line UtilityVendor-Independent Error Messages

Vendor-Independent Error Messages

The error messages shown in Table 34 originate in the vendor-independent portions of Teradata Access Module for Tivoli. These error codes range from 1000 to 1200.

BAM0024 Unsupported function code < > Teradata Access Module for Tivoli is incompatible with the calling program.

The access module can only be used for Teradata backup and restore. Your version of ARCMAIN software might be incompatible with the Teradata Access Module for Tivoli software.


BAM0033 < > Access module currently does not support the < > file attribute

< > Access Module currently does not support the < > function for < > file attribute

Teradata Access Module for Tivoli is incompatible with the calling program.

The access module can only be used for Teradata backup and restore. This error suggests that a version of ARCMAIN software is being used that is not compatible with the access module software level.






Table 34: Vendor Independent Error Messages


BAM1000 • NULL file pointer passed to < > function of Access Module

• Unrecognized file pointer 0x< > passed to < > function of Access Module

• Write called with buffer length < > when max size is < >

• Access Module passed OBJNAME attribute < >. It is < > characters long when only < > characters supported

• Invalid object type < > passed on OBJNAME attribute

• Invalid CopyNum < > passed to BARFile Constructor

• Invalid File Open Mode < > when closing

• Write called when file not opened for writing

• NULL position pointer passed to SetPos

• Invalid position (< > < >) passed to SetPos

• SetPos position (< > < >) caused us to read past end of segment

• SetPos position (< > < >) reads past end of segment

• Reposition offset= < > when only < > bytes returned by read

• Unable to interpret Object Info. Format= < >, InfoLen= < >

• CloseWrite should have updated < > segments but only did < >

• CloseWrite File segment FS= < >, HL= < >, LL= < > does not match list

• < > called when no active transactions

• EndCreateObj called when no open object

• FSeg Constructor passed invalid arguments: NS= < >, PATH= < >, GEN= < >, SEQ= < >

• Invalid pointer < > passed to rewind_input function

• Invalid File Name length < > passed to Open function

• Read function called when already flagged end-of-data

• Invalid length < > passed for allocating temporary buffer

• Invalid length was returned from a call to dsmGetNextQObject

An internal software error is detected. These messages correspond to BAR internal error codes. They indicate a severe, unexpected, or exceptional condition that can only be corrected by the Teradata Development organization, therefore:

1 Capture a complete output listing and all supporting text.

2 Contact the Teradata Global Support Center.




BAM1001 • NULL target buffer passed to esprintf routine

• Invalid message id < > passed to esprintf routine

• No message text stored for message id < >

• Call to esprintf routine exceeded < > number of inserts

• Invalid message id < > passed to escode routine

The core error reporting routines cannot do their work. An internal software error/corruption is detected. Other error conditions might be hidden behind this error.


BAM1002 The access module expects the Tivoli password access mode to be PASSWORD PROMPT

Teradata Access Module for Tivoli only functions in PASSWORD PROMPT mode.

Remedy: Specify the PASSWORD mode as PROMPT in dsm.opt.

BAM1003 Access Module currently does not support restarts in the WRITE mode

Teradata Access Module for Tivoli does not support restart processing when a backup file is opened in WRITE mode, which means that the access module rolls back and deletes all data written to TSM up to this point.




BAM1005 Access module cannot open more than < > files at same time

More FILE= clauses are specified on the ARCMAIN backup statement than are supported by Teradata Access Module for Tivoli.

Remedy: Correct the ARCMAIN statement and resubmit the job.

BAM1006 Access Module detected multiple backups for NameSpace= < >, Path= < >, Segment= < >

TSM qualified multiple backups for the indicated Namespace, Pathname, and Segmentname pattern. This is an error because a backup and restore needs to work with only one high-level name per ARCMAIN statement.

The most likely reason for this error is that the Namespace or Pathname fields contain a wildcard character that qualifies multiple backup files from the TSM catalog. Test this by using the native API query tool to see what backup file names come back, making sure that you are logged on as the same user ID to the TSM server.

Wildcard characters are acceptable for a low-level segment name because Teradata Access Module for Tivoli reserves those names for its own purposes.

Remedy: Correct the indicated name by removing the wildcard characters, and resubmit the job.





BAM1007 No backup file(s) found with NameSpace= < >, Path= < >, Segment= < >, Generation= < >

No backup file matched the indicated Namespace, Pathname, Segmentname pattern, and Backup File Generation number.

The Namespace field defaults to Teradata.

The Pathname is set by one of the following:

• The DATASETNAME field on the IOPARM string

• The external name of the FILEDEF parameter

• The value assigned on the FILE= clause of the ARCMAIN restore statement

Segmentname is controlled only by Teradata Access Module for Tivoli, but is shown in case you want to include it in an administrative query.

The generation number is entered as an IOPARM field or defaults to zero. Relative numbers, such as -1 and -2, count backwards from the current active backup (gen=0).

Remedy: Correct the indicated name and resubmit the restore job.

BAM1008 Duplicate storage objects found with NameSpace= < >, Path= < >, Segment= < >, Generation= < >

Teradata Access Module for Tivoli creates storage object names with a particular format. Also, a non-negative generation number is stored in the Object Info portion of the storage catalog metadata. If duplicate storage objects were found with the same name/generation one of the following has happened:

• An existing ARCMAIN backup was copied or the Object Info field was corrupted.

• The storage catalog is corrupted or the access module has a bug.

The access module relies on the generation number to distinguish between separate runs of the same backup job, so all file segments that correspond to a single backup job execution need to have the same generation number.

Remedy: Verify the heritage of the pertinent storage objects and, if necessary, delete the corrupt objects or update the Object Info metadata with distinct generation numbers. Ensure that the backups are not creating new objects when the metadata is updated.

If the remedy does not work, contact a field engineer or the Teradata Global Support Center.





BAM1009 Access Module currently does not support repositioning when writing to backup files

Teradata Access Module for Tivoli does not support restart processing when a backup file is opened in WRITE mode because it is not possible to reposition to the exact point of failure inside TSM. This means that the access module rolls back and deletes all data written to TSM up to this point.




BAM1010 SetPos generation < > does not match current file generation of < >

When Teradata Access Module for Tivoli creates a new backup file, it stores a unique generation number in the Object Info field of the storage object. This error occurs when a reposition operation detects that the position being requested is for a backup file with a different generation number from the one that is currently open.

Normally, this condition indicates a corrupted position field managed by ARCMAIN. However, when using the CATALOG feature of ARCMAIN to get fast repositioning on a restore, ARCMAIN can pick up a position that is inconsistent with the backup files in storage.

This condition can happen under the following circumstances:

1 Regularly running the same backup job, saving position information to the CATALOG database.

2 Creating additional backups without using the CATALOG option, so there is no position information saved.

3 Running a restore using the most recent backup image from storage. In this case, the most recent image in storage might correspond to generation 103, when the most recent backup image in the CATALOG database corresponds to generation 102.

Remedy: Examine ARCMAIN listings and the storage catalog, and do one of the following:

• If a user error occurred, make corrections and resubmit the job.

• If no user error occurred, consult a field engineer or the Teradata Global Support Center.





BAM1011 SetPos file segment number < > not found in retrieved list of backup segments

Teradata Access Module for Tivoli cannot find the requested file segment number when a request was made to reposition the file within the backup set. Either the position information is corrupted, or a mismatch occurred between the backup set being requested and the position information.


BAM1012 < > < > error < > < > Teradata Access Module for Tivoli detects an unexpected error when starting a function of TSM. The nature of the error is indicated in the message by naming the TSM product, the API function being called, the error code, and the error message text.

This type of error can be difficult to fix. Teradata Access Module for Tivoli is customized to work with site-specific APIs, but configuration to work with TSM and ARCMAIN can be complex.

Remedy: Correct the job or configuration settings.

To run Teradata Access Module for Tivoli with an option that is not recognized on the IOPARM of an ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.

To avoid resubmitting a job, issue a RELEASE LOCK statement on the Teradata Database to remove any database locks set and clean up the server.

BAM1013 Storage object created on platform < > The backup file being restored was generated on a different operating system.

The platform number identifies the operating system that created the backup.

Remedy: Resubmit the job on the same platform that created backup.





BAM1014 Invalid Segment name for NameSpace= < >, Pathname= < >, Segment= < >, CopyId= < >. Skipping.

When querying the TSM storage catalog metadata, Teradata Access Module for Tivoli found a storage object that qualified on the name pattern, but does not follow the proper naming convention. This is not a fatal error message, but the relevant object is omitted from processing because the access module cannot properly parse the segment name.

Teradata Access Module for Tivoli stores segment sequence numbers as part of the file segment name. For example, F0014 corresponds to the 15th file segment of a single ARCMAIN backup file. (File segment numbering starts at zero.)

Remedy: Rename the segment name if NameSpace and PathName are too close to the name chosen for another storage process.

If the skipped object was created by a Teradata backup operation, report the issue to a field engineer or to the Teradata Global Support Center.

BAM1015 Unable to open diagnostic file < > because < >. Logging disabled.

Diagnostic logging is requested, but Teradata Access Module for Tivoli is unable to open the file. This is a non-fatal error, but no diagnostic logging is captured. The cause of the file open error is indicated.

Teradata Access Module for Tivoliopens the log file in write-append mode. Periodic purging of this file is necessary.

Remedy: Correct the problem, and resubmit the job.

BAM1017 Unable to open DEFAULT file < > because < >

Teradata Access Module for Tivoli is unable to open the command line DEFAULT file. The cause of the file open error is indicated.

The DEFAULT file is specified with the BARAM_DEFAULT environment variable.

Remedy: Specify a valid path to a DEFAULT file that is accessible to your user ID, then resubmit the job.




Appendix D: Troubleshooting: Command Line UtilityTSM Error Messages

TSM Error Messages

Error messages that range from 1200 to 1299 (shown in Table 35) originate in the TSM portion of Teradata Access Module for Tivoli. Note that some of the error codes have multiple error messages.

BAM1018 Access module is aborting the backup transaction Teradata Access Module for Tivoli was called to close the backup file in an error condition. The write transaction is aborted and all storage objects created by this job are rolled back.

This is an informational message rather than a report of the root cause of an error condition. ARCMAIN indicates the cause of the error or reports that the backup process is interrupted.

Remedy: Correct the root cause of the error and resubmit the job. For further information, refer the output listing to the Teradata Global Support Center.

BAM1019 Access module is aborting due to Insufficient Memory This error occurs when Teradata Access Module for Tivoli runs out of memory while attempting to allocate resources.

A number of conditions can cause insufficient memory, including a lack of memory or swap space.

Remedy: Correct the root cause of the error, then resubmit the job.



Table 35: TSM Error Messages


BAM1200 Access Module needs Tivoli Version < > Release < > but client library is Version < > Release < >

Teradata Access Module for Tivoli detects an invalid software library release level.

The path to the loaded access module is set with the IOMODULE command line parameter to ARCMAIN.

Remedy: Correct the configuration issue and resubmit the job.



BAM1201 Tivoli dsmEndTxn error < >, (reason < >): < >

Teradata Access Module for Tivoli detects an unexpected error when starting a TSM End Transaction function. The error code, reason code, and error message text indicate the nature of the error. Reason codes usually correspond to numbers 1 through 50 of the API return codes. For more information on the API return codes, see IBM’s TSM Messages manual.

If this error occurs when writing backup files to the TSM, Teradata Access Module for Tivoli rolls back and deletes all file segments written to TSM up to this point, except file segment 0 (F000).



• To run Teradata Access Module for Tivoli with an option that is not recognized on the IOPARM of the ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.


BAM1202 Tivoli Backup Copy Group does not exist for object FileSpace= < >, HighLevel= < >, LowLevel= < >

TSM is unable to assign a copy group for the backup object being created.

This situation is the result of an API dsmBindMC call. The object name is listed as FileSpace, HighLevel name, and LowLevel name.

Remedy: Consult the TSM administrator to determine the source of the problem.





BAM1203 Tivoli Storage object FileSpace= < >, HighLevel= < >, LowLevel= < >, ID= < > is not recognized by Access Module. Skipping.

Teradata Access Module for Tivoli is unable to interpret the formatted metadata, which is usually stored with the storage object. The object is skipped and processing for the object stops, although processing continues for the balance of the job.

This error is usually generated because a storage object exists in TSM that has a similar name to a Teradata backup created by Teradata Access Module for Tivoli. The specified object name in the query is picking up more than it should.

This warning message does not terminate processing because Teradata Access Module for Tivoli cannot communicate a non-fatal warning condition to ARCMAIN. As a result, the return code indicator from ARCMAIN can be zero, even though this message is displayed.

Remedy: Use the indicated diagnostic information to verify the status of the storage object. If the storage object is considered for Teradata backup and restore, contact the Teradata Global Support Center.

If the object is being incorrectly qualified because the wildcard specification is too general, restate the query so it is correctly limited to the storage objects created by Teradata Access Module for Tivoli.

BAM1204 TDDSMC syntax error: < > The TDDSMC utility in Teradata Access Module for Tivoli detects a syntax error in the command.

The message indicates the source of the error.

Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP command or refer to Appendix C: “The TDDSMC Administrative Utility”.

BAM1205 TDDSMC syntax error: < > field width cannot exceed < >

The TDDSMC utility in Teradata Access Module for Tivoli detects a syntax error on a FORMAT string. The field width override value for the indicated substitution variable is too long.

Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP FORMAT command or refer to Appendix C: “The TDDSMC Administrative Utility”.





BAM1206 Tivoli server aborted transaction during < > call. Error < >, (reason < >): < >

TSMserver aborted the client transaction for the noted reason code. For more information on the API return codes, see the TSM Messages manual. Reason codes usually correspond to numbers 1 through 50 of the API return codes.

If this error occurs when writing backup files to the TSM, Teradata Access Module for Tivoli rolls back and deletes file segments written to TSM up to this point, except file segment 0 (F000).

If the text of the message indicates a zero value for the reason code, issue a QUERY ACTIVITYLOG command on the TSM server to determine the root cause of the abort.



• To run Teradata Access Module for Tivoli with an option that is not recognized on the IOPARM of the ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option.


BAM1207 TDDSMC syntax error: Expected quote string at >> ( ) << on command line

The TDDSMC utility in Teradata Access Module for Tivoli detects a syntax error on the command line arguments used to start the utility. This error is the result of a quote string not being found at the specified position.

Remedy: Correct the syntax and resubmit the job. For more details about command line syntax, issue the HELP command or refer to Appendix C: “The TDDSMC Administrative Utility”.

BAM1208 TDDSMC syntax error: No matching and quote character on command line

The TDDSMC utility in Teradata Access Module for Tivoli detects a syntax error on the command line arguments used to start the utility. A quote string was detected, but no matching end-quote was found.

The TDDSMC utility recognizes single- and double-quote characters, but sometimes the operating system strips quotes before passing the command line to the utility. After a quote character is detected, the utility will keep scanning the command line for a matching end-quote.






BAM1209 TDDSMC syntax error: Extraneous information follows < > command starting at: < >

The TDDSMC utility in Teradata Access Module for Tivoli detects a syntax error on the command line arguments used to start the utility. A valid command was parsed, but non-blank trailing characters were detected.

This error can occur when an unquoted name pattern contains embedded blanks. There are optional fields after the name pattern,. Therefore, the actual source of the syntax error might be prior to the position indicated.


BAM1210 Access Module cannot backup more than 4080 objects.

TSM limits the number of objects that can be retrieved at one time to DSM_MAX_GET_OBJ (4080). Therefore Teradata Access Module for Tivoli does not back up more than 4080 object segments. The maximum size of one backup job cannot exceed approximately 8 TB.

Remedy: Modify backup jobs to contain less data.






Glossary

A

AMP Access Module Processor, which is a virtual processor that receives steps from a parsing engine (PE) and performs database functions to retrieve or update data. Each AMP is associated with one virtual disk, where the data is stored. An AMP manages only its own virtual disk and not the virtual disk of any other AMP.

API Application programming interface.

ARCMAIN ARC executable that extracts (or inserts) database headers and data rows from the HUT (Host Utility) archive interface.

B

BAR Backup and restore; a software and hardware product set. Also referred to as Backup/Archive/Restore.

Backup Application Software A product set of backup and restore products designed to be used with Teradata Database. The products include Teradata access modules to backup and restore products by Symantec Veritas, BakBone, and IBM.

The prior term for Backup Application Software was Open Teradata Backup (OTB).

C

CLI Teradata Call Level Interface API (application programming interface); allows an application or utility program to communicate to a Teradata system through standard TCP/IP protocol.

CLI2 Call-Level Interface Version 2, also called CLI for Windows

CLIv2so Call-Level Interface Version 2 Shared Object (CLIv2so); this program installs the CLI libraries required by other utilities. When the CLIv2so program submits a request to a Teradata Database, CLI Library components transform the request into Teradata Database formats. The CLI Library sends requests to, and receives responses from, the Teradata Database over a network.

Cluster Logical, table-level archive whereby only those rows residing on specific AMPs, and which are members of the specified cluster, are archived onto a single tape dataset. This allows multiple jobs to be applied for backup of large tables, to reduce the backup window. This method is used to affect a parallel archive/restore operation through a “divide and conquer” backup strategy.


Glossary

D

DBA Database Administrator.

F

FIFO First In First Out queue.

G

GB Gigabyte.

L

LAN Local Area Network.

M

MB Megabyte.

MP-RAS UNIX-variant operating system installed to run many Teradata installations.

MPP Massively Parallel Processing.

N

NIC Network Interface Card.

NO REWIND A tape device definition that prevents a rewind operation at file open or file close. NO REWIND allows a program to access multiple files on a tape by leaving the tape positioned at the end of the current file at close, thus allowing the subsequent file to be easily accessed by the next open.

O

ODBC Open Database Connectivity.

OTB Open Teradata Backup. This term has been replaced by Backup Application Software.

P

PE Parsing Engine.

R

RDBMS Relational Database Management System.

S

SAN Storage Area Network.


Glossary

SSO Single Sign-On.

T

TB Terabyte.

TDDSMC Teradata Database System Management Console that allows users to view and perform maintenance activities on ARCMAIN backups that are stored in Tivoli Storage Management.

TDP In a Teradata context, TDP refers to Teradata Director Program.

TDP In an IBM TSM context, TDP refers to Tivoli Data Protection, which is an extension product written to the TSM API that manages backup and restore of specific types of application data. Examples include TDP for Lotus Domino and TDP for Oracle.

For details about Teradata TDP, see TDPID.

TDPID Name in the Teradata connection string used to identify a specific host alias that corresponds to the Teradata server of interest when using the native CLI interface software.

For example, if User1 wants to open a Teradata connection, User1 might use a logon string in the form of name1/user1, password where name1 is the TDPID. For the TDP to be valid, there must be a corresponding host alias entry that maps “name1cop1” to a valid IP address for the specific Teradata server of interest.

TIVBAR Teradata Access Module for Tivoli.

TSM Tivoli Storage Management; IBM’s storage management solution.

W

W2K Windows 2000.


Glossary


Index

Symbols%gen% 119.jar file 100.out files 101

Aadditional directories 109administrative user ID 127ALL option 120ARC output files 101arcdflt variable 129arcdflt.txt 108, 128

installation 107archive

database object 54archive jobs

states 100ARCHIVE object selection dialog box 54archive script

example of multiple-node 123example of single-node 121

ARCHIVE statements 120ARCMAIN

configuration 105datasetname 118default directories 109error log 83, 141files that mediate TSM 108overview 17restrictions 119, 120scripts 118start-in directory 107Teradata Database connections 115

ARCMAIN scripttest before production 116

Bbackups

configuration of TSM 37, 110controlling access 128created storage objects 119generations 119object names 117overview 117test before production 116

BAM####0-999 86, 1441000-1200 89, 1461200-1299 95, 153

BAR Configuration Directory 107BAR Working Files directory 107BARAM_DEFAULT variable 129BARAMLOG variable 129BARAMLOGLEVEL variable 129batch files 108build ARC script 65

CCATALOG option 120character set 59, 68Client directory 109client options 39, 112Client Options file

configuration 39, 112description 107

CLIv2configuration 105

collocation 120COMMMETHOD 113COMMTIMEOUT server option 38, 112components

arcdflt.txt 108TDDSMC.exe 108TIVADM.BAT 108TIVARC.BAT 108TIVBAR.dll 108TIVDFLT.TXT 108Tivoli.Readme.TXT 108

configurationARC options 49client groups 45client options 39, 112client systems 43command line utility requirements 105files for command line utility 128installed files 108LAN 115LAN connections 106of TSM 37, 110replacing files 107required TSM options 113


Index

Teradata Database system 42TSM policy objects 37, 110TSM server options 38, 111

connectionsTeradata Database 115

core files 102cross-platform restrictions 120

DData Connector

configuration 105error messages 86, 144

DataSetName 118debug log 82, 140default

directories 109file location 107timeout 39, 112

default files 128dialog box

ARCHIVE object selection 54RESTORE object selection 62Script Options (for archive operations) 57Script Options (for restore operations) 66

dsm.opt file 129installation 107

DSMI_CONFIG variable 129DSMI_DIR variable 129DSMI_LOG variable 130dsmsta.opt file 114dual backup support 120

Eencryption 58

algorithms 58environment variables 129error logs

access module 82, 140ARCMAIN 83, 141TSM client log 84, 142TSM errors 83, 141TSM Server Activity log 83, 141

error messages 81, 1390 to 999 86, 1441000 to 1200 89, 1461200 to 1299 95, 153BAM#### 86, 144Data Connector 86, 144TSM 95, 153vendor independent 89, 146

Ethernet connections 106EXCLUDE option 120export job data in html format 71

Ffile size

indicator 39, 112files

with installation 108

Ggenerations

backups 119Graphic User Interface Configuration dialog box

Teradata TARA 41GUI

Teradata TARA 53

Hhardware

configuration 105html format

exporting job data in 71

IIDLETIMEOUT server option 38, 112Install Configuration Files dialog box 106installation 19, 106

additional directories 109ARCDFLT.TXT 108default files 128TDDSMC.exe 108testing after completion 116TIVADM.BAT 108TIVARC.BAT 108TIVBAR.dll component 108TIVDFLT.TXT 108Tivoli.Readme.TXT 108

inter-operability 120IOPARM

datasetname field 118

JJava Runtime Extension

running under 100job history 71jumbo frames 106

LLAN configuration 106

Teradata Database connections 115LAN-free mode 106LANFREETCPPORT option 114LANFREETCPSERVERADDRESS option 114


Index

launch timesusing the command line to obtain 99

logfile 103logon security 127logs

access module debug log 82, 140

Mmanagement classes

configuring 59maximum files restored 39, 112multiple jobs

controlling access 128naming conventions 119on a single volume 120

NNAMEDPIPENAME 113naming conventions

objects 117parameters 124

NODENAME 113nodes

pseudo nodes 128

Oobject names

naming conventions 117online archive 58operating systems

restriction 120optional files 108outlog 83, 141overview 17

PPASSWORD 113password 127

security 127PASSWORDACCESS 113platform

configuration 105restrictions 120

port number 41positioning data 50, 59, 68product overview 17product version numbers 4pseudo nodes 128

Qquery banding 58, 67

Rreadme.txt 108replace configuration files 107RESOURCETIMEOUT server option 39, 112RESTARTduring rewrite 120restore

database object 62restore file

maximum number indicator 39, 112RESTORE object selection dialog box 62restrictions

ARCHIVE statements 120ARCMAIN 119collocation 120dual backup support 120inter-operability 120multiple-node 123no RESTART during write 120single-node 121

RETEXTRA field 38, 111RETONLY field 38, 111runarctiv.bat file 101

Sscript names

using the command line to obtain 99scripts

edit 59, 68security 127

controlling access to backups 128files containing passwords 127logon 127pseudo nodes 128TSM 127

Server Activity log 83, 141server configuration 37, 110server options 38, 111sessions per stream 67set up 106shared ICU Libraries for Teradata 106software

configuration and versions 105software releases

supported 3start-in directory 107, 109starting the TARA server 99state conditions

build phase 59dictionary 59table data 59

stopping the TARA server 99storage agent options file 114storage objects


Index

created at backup 119storage pools 120storing backup data 117syntax rules 124system management

security 127

TTARA Server Configuration dialog box

ARC Options tab 49Client Groups tab 45Clients tab 43Teradata tab 42Tivoli tab 46

TARA server logchange verbosity 103

taragui.jar file 100TCPPORT option 114TCPSERVERADDRESS 113TDBAR directory 109TDDSMC

start-in directory 107TDDSMC.exe 108tdicu 106TDPID 57, 66, 115Teradata GSS Client 106Teradata Tiered Archive/Restore Architecture 53timeout 39, 112TIVADM.BAT 108, 128TIVARC.BAT 108, 128TIVBAR.dll 108tivdflt.txt 128

installation 107Tivoli.Readme.TXT 108

installation 107trial backup 116troubleshooting 81, 139TSM

client error log 84, 142configuration 37, 110error logs 83, 141policy object fields 38, 111policy objects 37, 110required options 113security 127Server Activity log 83, 141server configuration 37, 110

TSM client options 39, 112TSM Client Options file 107TXNGROUPMAX server option 39, 112

UUnicode support 105

user IDs 127user name 57, 67

Vvariables 129VERDELETED field 37, 111VEREXISTS field 38, 111verify checksum 59, 68version numbers 4versions

Tivoli Storage Manager 105view job history 71

Xxinetd process 32

Zzero return code

none on a job 116
