Teradata Access Module for Tivoli - Online Tutorials...

Teradata Access Module for TivoliInstallation and User Guide

Release 12.00.00B035-2444-067A

June 2007

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, DB2, MVS, RACF, Tivoli, and 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 trademarks 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-2007 by Teradata Corporation. All Rights Reserved.

mailto:[email protected]

Preface

Purpose

This book provides information about Teradata Access Module for Tivoli, which is a Teradata® Tools and Utilities product. Teradata Tools and Utilities is a group of products designed to work with the Teradata Database. The book also provides information about installing Teradata Access Module for Tivoli on Windows® 2000 and 2003 operating systems.

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

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.2 and 5.3

• Teradata Archive/Recovery Utility (ARC) 08.00.00 or later

• Teradata Tools and Utilities 08.00.00 or later

• Teradata Access Module for Tivoli 01.00.02.00

Note: See “Invoking the TDDSMC Utility” on page 43 to verify the Teradata Access Module for Tivoli version number, which is displayed in the TIVBAR log file when TDDSMC is invoked.

To locate detailed supported-release information:

1 Go to www.info.teradata.com.

2 Navigate to General Search>Publication Product ID.

3 Enter 3119.

Teradata Access Module for Tivoli Installation and User Guide 3

http://www.info.teradata.com

PrefacePrerequisites

4 Open the version of the Teradata Tools and Utilities ##.##.## Supported 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

• NCR 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 NCR server

• Teradata Backup and Storage procedures

• Microsoft® Windows® 2000 operating system

• Microsoft® Windows® 2003 operating system

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.

Date and Release Description

June 2007

01.00.02

Removed reference to ASF2 Tape Reader, which is no longer supported.

September 200601.00.02

Changed preface and book number. There are no technical changes.

April 200501.00.02

Added support for Windows 2003.

January 200501.00.01

Changed layout of book. There are no technical changes.

April 200401.00.01

• Support for TSM’s LAN-free data movement

• Increased TXNGROUPMAX server option

• Addition of 4080 objects in the error messages section.

4 Teradata Access Module for Tivoli Installation and User Guide

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.

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

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

2 Select the General Search check box.

3 In the Publication Product ID box, type 2029.

4 Click Search.

5 Select the appropriate Release Definition from the search results.

Additional product information

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


2 Select the Teradata Data Warehousing check box.

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 a link to any of the data warehousing publications categories listed.

Specific books related to Teradata Access Module for Tivoli 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 Select the General Search check box.

3 In the Title or Keyword box, type CD-ROM.

4 Click Search.


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



PrefaceAdditional Information

Ordering information for manuals

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


2 Select the How to Order check box under Print & CD Publications.

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Component Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2: Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Local Area Network (LAN) Connections/Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Installed Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Additional Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Removing the Teradata Access Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configuring TSM for Teradata Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

TSM Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

TSM Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

LAN Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Multiple Network Cards and TDPID Addressing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Teradata Database Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Network Settings for a Single Card. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Preparing for Production . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28


Table of Contents

Chapter 3: Storing Backup Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

How Backup Data is Stored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Object Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

DataSetName in ARCMAIN Backups and Restores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

Backup Generations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Functional Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

No RESTART During Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

ARCHIVE Statement Recommendation Per Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

No Dual Backup Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Inter-operability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Collocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Examples of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

IOPARM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Securing Files that Contain Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Controlling Access to Backup Images Stored in TSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

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

Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Chapter 4: The TDDSMC Administrative Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Invoking the TDDSMC Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Command-Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Format Specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

TDDSMC Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Query TSM Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Prompt Off Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

Query Backup/Query Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

Delete Backup/Delete Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Inactivate Backup/Inactivate Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49


Table of Contents

Chapter 5: Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Interpreting Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Access Module Debug Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

ARCMAIN Outlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

TSM Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

TSM Server Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

TSM Client Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Error Conditions and Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Data Connector Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Vendor-Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

TSM Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73


Table of Contents


List of Figures

Figure 1: Overview of a Teradata Access Module for Tivoli Backup . . . . . . . . . . . . . . . . . . . . 16


List of Figures


List of Tables

Table 1: Files Created at Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Table 2: Additional Directories Created at Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Table 3: Tasks to Uninstall Complementary Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 4: Fields to Consider for the Backup Copy Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 5: TSM Server Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 6: TSM Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 7: Specifying Backup Image Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Table 8: Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 9: Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Table 10: Security Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Table 11: Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Table 12: Metadata Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Table 13: Log File Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Table 14: Error Conditions and Recovery Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Table 15: Data Connector Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Table 16: Vendor Independent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Table 17: TSM Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65


List of Tables


CHAPTER 1

Introduction

The Teradata Access Module for Tivoli for Windows 2000/2003 is supported by ARCMAIN as an interface for backing up and restoring objects in a Teradata Database. The Teradata Access Module manages the input/output (I/O) interfaces between the Teradata ARCMAIN client utility and IBM’s 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 the Teradata Access Module for Tivoli, and about how to perform backup and restore jobs. A troubleshooting section provides guidance for resolving error conditions and error messages.

This guide also provides information about the administrative command-line utility, called the Teradata Database System Management Console (TDDSMC), that is installed with Teradata Access Module for Tivoli. The TDDSMC utility reports on ARCMAIN backups that are stored in TSM and performs maintenance activities, such as deleting backups that are no longer needed. For more information about TDDSMC, see Chapter 4: “The TDDSMC Administrative Utility”.

Component Overview

ARCMAIN either 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 the Teradata Access Module for Tivoli interfaces with ARCMAIN through use of the Data Connector to store backups onto TSM.


Chapter 1: IntroductionComponent Overview

Figure 1: Overview of a Teradata Access Module for Tivoli Backup

ARCMAIN largely interacts with the access module, but ARCMAIN does not call the access module directly. Access is through a Data Connector component that dynamically loads the requested module and standardizes the interfaces.

The Data Connector and ARCMAIN software must be installed before using the Teradata Access Module for Tivoli. For more about the hardware and software requirements, see “Configuration Requirements” on page 17.

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

TDDSMC

2444A001

LAN-FreeMode


CHAPTER 2

Installation and Configuration

The following topics are in this chapter:

• Configuration Requirements

• Installation

• Removing the Teradata Access Module

• Configuring TSM for Teradata Backups

• LAN Configuration

Configuration Requirements

The following hardware, software, and LAN configurations are required before you install the Teradata Access Module for Tivoli.

Hardware

The Teradata Access Module for Tivoli is certified for installation only on 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: Teradata 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 it 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 you expect to execute ARCMAIN with the 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 you expect to execute ARCMAIN with the Teradata Access Module for Tivoli. However, the Storage Agent cannot reside on the same node where the TSM server is installed.

• Windows versions of all of the following Teradata Tools and Utilities 08.00.00 or above:

• ARCMAIN


Chapter 2: Installation and ConfigurationInstallation

• Data Connector

• Call-Level Interface version 2 (CLIv2)

• Teradata GSS Client

• Shared ICU Libraries for Teradata (tdicu)

Local Area Network (LAN) Connections/Platforms

The Teradata Access Module for Tivoli can operate in both 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 will perform large-volume data transfers. To ensure optimal throughput, it is also recommended that the gigabit adapter be configured 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 both ARCMAIN and the Teradata Access Module for Tivoli.

• If you are running TSM 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 you are running TSM 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, since 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 opens.

2 Specify the installation location for the BAR configuration files and customize the files as shown.



The fields for this dialog box are:

3 Click OK to install the tddsmc.exe, tivbar.dll, tivadm.bat, and tivarc.bat files into the directory where the ARCMAIN executable is installed.

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.

Field Description

BAR Configuration Directory 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 20.

BAR Working Files Directory This is an empty directory, which is recommended as the “start in” directory for all ARCMAIN and TDDSMC processes.

TSM Client Options File 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 the tddsmc.exe, tivbar.dll, and Tivoli.readme.txt files 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 Teradata Access Module for Tivoli installation CD puts the following files in the same directory where the Teradata client executables are installed.

Table 1: Files Created at Installation

Installed Component Description

TIVBAR.DLL The application library that mediates between the ARCMAIN software and the TSM API software. This is the library specified via the ARCMAIN IOMODULE parameters.

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 invoking ARCMAIN and the TDDSMC utility with the Teradata Access Module for Tivoli.

Note: These files are optionally installed, based on your response to “Install Configuration Files” in the installation process.

ARCDFLT.TXT ARCMAIN command-line default file, which is optionally installed.

TIVDFLT.TXT Options passed to the Access module; 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.

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.


Chapter 2: Installation and ConfigurationRemoving the Teradata Access Module

Additional Directories

The following directories are also created during installation in order to standardize running the Teradata BAR processes on the node. The installation program allows you to set the location of these directories.

Removing the Teradata Access Module

The standard uninstall process only removes the following components from the directories where they were installed, but it will not remove the directories:

• tivbar.dll

• tddsmc.exe

• dsm.opt

• tivoli.readme.txt

• the shortcut to the TDDSMC utility

The following table 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 2: Additional Directories Created at Installation

Directory Description

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 “start in” directory that allows the creation of subdirectories so you can group similar BAR processes.

C:\Program File\NCR\Teradata Client\TDBAR

The configuration directory contains the various sample default files that are used by ARCMAIN, by the Teradata Access Module for Tivoli, and by the TSM software.

You can customize the location of these files in the TIVARC.BAT and TIVADM.BAT files. For more information, see “Default Files for ARCMAIN and the Access Module” on page 40.


Chapter 2: Installation and ConfigurationConfiguring TSM for Teradata Backups

Configuring 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, the TSM server is generally configured first, then the TSM client is configured, then options are set 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 pre-existing or newly-created, but only TSM “backup” object types are supported.

The following TSM policy objects fields 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

Table 3: 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 you established during installation. For detailed information on the recommended procedures, refer to the appropriate manual.

Remove BAR Configuration Directory and all its contents.

Deletes arcdflt.txt, tivdflt, txt, Tivoli.Readme.txt, and the optional dsm.opt file, if created.

Delete or modify customized copies of sample batch files.

If you stored these files under a name or category other than the installation defaults, locate the customized files, and delete or modify them so they no longer point to the Teradata Access Module for Tivoli components.



already stored on the server. For information on how backup data is stored, see “How Backup Data is Stored” on page 29.)

TSM Client Node

In the TSM software, by default a client node can only access 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’s 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, and then set the BACKDELETE option to YES. If this option is not set to YES, you cannot delete backup objects with the TDDSMC utility. For more information, see Chapter 4: “The TDDSMC Administrative Utility”. For more information about the TSM register node command, refer to the Tivoli Storage Manager Administrators Guide on IBM’s Web site at http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

Table 4: Fields to Consider for the Backup Copy Group

Field Description

Versions Data Exist (VEREXISTS)

Number of inactive versions, if active versions exist. The default is 1.

Versions Data Deleted (VERDELETED)

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

Retain Extra Versions (RETEXTRA)

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

Retain Only Version (RETONLY)

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


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


TSM Server Options

The following TSM server option values might need to be adjusted for both the TSM server (dsmserv.opt) and the TSM Storage Agent (dsmsta.opt), depending on your site requirements.

It is recommended that the TXNGROUPMAX option, which controls the number of files allowed in a transaction, be set 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 x 2 GB, or approximately 8.1 terabytes. For more information about how backup data is stored, see “How Backup Data is Stored” on page 29.

TSM Client Options

Before performing Teradata backups, you must properly configure the TSM Client Options file(s). If you choose to copy the TSM Client Options file 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, and the default file name is “dsm.opt.” However, you can give the file any name or store it in any directory provided the following conditions apply:

• The file must be read-accessible when ARCMAIN or TDDSMC are invoked at execution.

• The path to the file is identified by:

Table 5: 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 doesn’t 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 your 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.

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.

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.



• 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 21.

Installation wizards in the TSM products create a Client Options file for you, but you can edit it with 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.

The Teradata Access Module for Tivoli requires the following minimal TSM options in the TSM Client Options file.

Table 6: TSM Client Options

Required TSM Option Description

TCPSERVERADDRESS Specifies the TCP/IP address for the TSM server.

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.

COMMMETHOD Specifies the communication method to provide connectivity for client-server communication as NamedPipes or TCPIP.

• Use NamedPipes if you run the TSM client and server software on the same node.

• Use TCPIP if you perform backups from a different node and both nodes need to see each other’s backups.

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 have registered a pseudo node, use the pseudo name.

PASSWORD Specifies a TSM password. This password is used when registering the node.

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.




Chapter 2: Installation and ConfigurationLAN Configuration

For more details about the TSM options, see the Tivoli Backup-Archive Client Installation and User’s Guide.

Example 1

Following is an example of a TSM Client Options file in LAN-attached mode:

TCPSERVERADDRESS 128.00.00.00PASSWORDACCESS PROMPTCOMMMETHOD NAMEDPIPESNAMEDPIPENAME \\.\pipe\server1NODE NODE1PASSWORD <NODE1 Password>

This scenario is appropriate if both the TSM server software and the Teradata Access Module software are installed on the same node.

Example 2

Following is an example of a TSM Client Options file in LAN-free mode:

TCPSERVERADDRESS 155.00.00.00COMMMETHOD TCPIPPASSWORDACCESS PROMPTENABLELANFREE YESLANFREECommmethod NAMEDPIPESNAMEDPIPENAME \\.\pipe\adsmpipeNODE LANFREENODE1PASSWORD <LANFREENODE1 Password>

In this scenario, the pipe name is the SAN pipe name. To support other TSM SAN configurations, consider the following 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

Since the TSM client software is not supported on the MP-RAS platform, the Teradata Access Module for Tivoli will need to access the Teradata Database across a LAN. The following LAN configurations will 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.


Chapter 2: Installation and ConfigurationLAN Configuration

Teradata Database Connections

Teradata Database sessions are connected in the following ways:

• 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, it defaults to the value “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.

You can ensure that the IP address of your TDPID provides maximum output by issuing the ifconfig -a command on UNIX platforms so you can see the IP addresses associated with a given node. You can also ping the desired IP addresses from the BAR node.

Network Settings for a Single Card

After you have verified that ARCMAIN jobs are opening sessions through the proper network cards, you also should 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.

All machines in an Ethernet configuration must be set 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 that can be used may be dependent 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), then the MTU size cannot be changed.

Since ARCMAIN generally sends and receives 64 KB packets (the maximum size for one database parcel), using the highest allowed MTU size reduces the packet fragmentation.

Receive Descriptors/Buffers

The Receive Descriptors setting specifies the number of Receive Descriptors (and/or Buffers) allocated for a given interface. This setting is particularly important when a system receives data under a heavy load (CPU or network utilization), since packets might be dropped if not enough Receive Descriptors are available.


Chapter 2: Installation and ConfigurationPreparing for Production

The minimum number of receive descriptors needed for a system under a heavy load depends on the following:

• Maximum packet size of the running applications

• Total number of sessions/connections being used

• MTU setting for the Ethernet interface

Preparing for Production

When installation and configuration are complete, it is recommended that you perform a trial backup to demonstrate that the configuration works before you customize it further for your production environment. Follow these steps 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, and issue the following command:

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 your 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 “How Backup Data is Stored” on page 29.

3 Use the TDDSMC utility described in Chapter 4: “The TDDSMC Administrative Utility” to see metadata information about the backup.

If you do not get a zero return code from the ARCMAIN job, refer to Chapter 5: “Troubleshooting”.


CHAPTER 3

Storing Backup Data

The following topics are discussed in this chapter:

• How Backup Data is Stored

• Functional Restrictions

• IOPARM Parameters

• Security

How Backup Data is Stored

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. While ARCMAIN is unaware of the particular storage medium that is used, it is able to reposition to different database objects on the backup image.

Object Names

Following are the naming conventions used by the TSM storage catalog. The conventions used by TSM 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-most 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 information, see the description of the DATASETNAME field in “Parameter Definitions” on page 37.


Chapter 3: Storing Backup DataHow Backup Data is Stored

• The right-most 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 4-digit integer with leading zeros. For example, a backup of 9 gigabytes of data with the default segment size of 2 GB creates 6 storage objects with the 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 Chapter 4: “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 will not cause a Teradata Access Module for Tivoli error.

The Teradata Access Module for Tivioli uses the following rules to determine a DATASETNAME:

• If the DATASETNAME field is specified in the IOPARM string, that name is used.

• If the DATASETNAME field is 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” may 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.

The following table 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.


Chapter 3: Storing Backup DataHow Backup Data is Stored

Backup Generations

Typically you define backup options once, then run multiple backup jobs 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 invokes the File Open function. You can view these numbers by invoking the %gen% format field in TDDSMC QUERY BACKUP and QUERY OBJECT commands. For more information about these commands, see Chapter 4: “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. To request a restore of the latest (active) backup generation, the generation parameter is not needed. To restore 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 37.

Table 7: Specifying Backup Image Names

Backup Image Name Storage Objects Created

tivarc <arc.txt ioparm=’datasetname=Marketing\Research.data’

Marketing\Research.data\F0000



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


Chapter 3: Storing Backup DataFunctional Restrictions

Functional Restrictions

The following restrictions apply to ARCMAIN jobs that use the Teradata Access Module for Tivoli.

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

It is recommended that you 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. If you need 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, so you cannot 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.

Inter-operability

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, which allows you 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 following:

To tailor these examples to your needs, refer to the Teradata Archive/Recovery Utility Reference.

Example of 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 absolute 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, the DATASETNAME corresponds to the name indicated on the FILE= clause of the ARCMAIN ARCHIVE statement.

Table 8: Restrictions

Parameter Assumption or Name Used

Environment Windows 2000/2003

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 40.

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

Teradata User ID dba1

Password pwd

TDPID td1



1 Ensure that file pointed to by the ARCDFLT environment variable is Iomodule=’tivbar.dll’.

2 Execute the following command-line:

tivarc <arcin.txt

This arcin ARC script contains the following:

Logon td1/dba1 , pwd;Archive data tables (db1) , release lock , file= db1_data; Logoff ;

3 This ARC script produces the following backup information in TSM catalog:

• Node = NODE1

• Filespace = Teradata

• High Level = db1_data

• Low Level = F0000, F0001, F0002, etc.

Example of 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

The arcin ARC script contains the following:

Logon td1/dba1 , pwd; Restore data tables (db1) , release lock , file= db1_data; Logoff ;

3 This ARC script refers the following backup in the TSM catalog:

• Node = NODE1



• Low Level = F0000, 0001, F0002, etc.

To restore the backup generation just before the latest backup, use the following IOPARM value:

tivarc <arcin.txt ioparm=’generation=-1’

For information about specifying relative and absolute generation numbers, see “Parameter Definitions” on page 37.

Example of Archive Script for Multiple-Node Backup

The following 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.


Chapter 3: Storing Backup DataIOPARM Parameters

1 Ensure that the file pointed to by ARCDFLT environment variable is dsm.opt.


tivarc <arcin.txt

The arcin ARC script contains the following:

Logon td1/dba1 , pwd; Archive data tables (db1), release lock , file= db1_data; Logoff ;

Contents of the referenced dsm.opt file:

TCPSERVERADDRESS 128.00.00.00PASSWORDACCESS PROMPTCOMMMETHOD TCPIPNODE EDW001PASSWORD EDW_PASSWORD

3 This ARC script produces the following backup information in the TSM catalog:

• Node = EDW001



• Low Level = F0000, F0001, F0002, etc.

The considerations described above for archive also apply to restore. Since the TSM Administrator password is stored in the dsm.opt file, you may want to restrict who can read this special Options file, as explained in “Securing Files that Contain Passwords” on page 39.

If password expiration is in effect for this TSM Administrator, you will need to regularly update the dsm.opt file on every node where an ARCMAIN job will reference it to reflect the new password or set the password.

You might want to define TSM nodes for multiple Teradata servers (such as, when you have both a production and development server in your data center). In this case, the ARCMAIN command-line is similar to the one shown above, but you may be pointing to a different dsm.opt file that indicates the appropriate node name and password for that server. You will also need to use the correct Teradata logon in the ARCMAIN script.

IOPARM Parameters

Teradata Access Module for Tivoli specifies processing options in one of two places. The following sections define parameters that can be specified in either place.

• Teradata Access Module for Tivoli checks the BARAM_DEFAULT environment variable, described in “Environment Variables” on page 40, for the path to a file that contain one or more of the parameters indicated in “Parameter Definitions” on page 37.

• ARCMAIN passes a string to Teradata Access Module for Tivoli that contains a list of parameters, described in “Parameter Definitions” on page 37, that are user-defined with the IOPARM command-line option. The IOPARM string can be specified explicitly on the



ARCMAIN command-line, or it can be included in the ARCMAIN default file, described in “Default Files for ARCMAIN and the Access Module” on page 40.

Syntax Rules

The following syntax rules explain the criteria for acceptable parameters and how to properly assign values to parameters.

• Multiple parameter assignments can be separated by blanks or by commas. Repeated blanks, tab characters, and other white space characters are ignored. Unless otherwise stated, each parameter assignment has the following 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:

• An 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.

• A 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.

• A 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 outer-most quote characters, but a second occurrence of an opening quote will terminate the string.

For example, ‘a “ b’ and “a ‘ b” are both 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.

• A directory path value is similar to a name token with the possible inclusion of forward slashes, back slashes, 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.

• Parameters may be defined multiple times in a IOPARM string, but only the last assignment for the relevant parameter in the IOPARM string will take effect. This convention can be used 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 following IOPARM parameters. In some cases, if you do not specify a parameter causes the default value in the description column to be assigned as the parameter name.

Table 9: Parameter Definitions

Parameter Value Type Description

CONFIG Directory Path Path to TSM client configuration file (the dsm.opt file). The DSMI_CONFIG environment variable typically establishes a basic environment context.

Note: The CONFIG setting, 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 either 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.

The DATASETNAME parameter can also contain the following substitute variables that generate unique names for the backup. However, if either of these variables are used, the DATASETNAME must be specified 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 the DEFAULT parameter 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 last the TSM Client Options file indicated in the myopts.txt file:

Tddsmc -config=mydsm.opt -default=myopts.txt


Chapter 3: Storing Backup DataSecurity

Security

Consider the following security features when configuring your system. For additional information about managing security for Teradata Archive and Recovery, TSM, and Windows, see the appropriate manual listed in “Additional Information” on page 5.

DIRDELIM Single non-blank character

Override TSM default directory path delimiters in storage object names. By default, this value is a back slash (\) on Windows platforms and a forward slash (/) on UNIX platforms.

Note: This can only be specified 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 Chapter 4: “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 positive value indicates the specific generation number in storage (active or inactive).

• A negative value 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 the GENERATION parameter restores the latest backup.

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 (dsm.opt) file. 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 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 the ARCMAIN processing.

Table 9: Parameter Definitions (continued)

Parameter Value Type Description



Securing 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 you want to execute ARCMAIN backups or invoke the TDDSMC utility.

To secure access to the job execution directory, such as, C:\TDBAR, do the following:

1 Use the LOGON Option in the ARCMAIN default file and 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, since operating system diagnostic traces or screen printouts can often disclose those items. For more information about default, refer to “Default Files for ARCMAIN and the Access Module” on page 40.

Controlling 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 since stored data often contains sensitive information, such as financial material, that requires restricted access. Access can be limited to particular subsets of Teradata backups by creating additional TSM client nodes that correspond to each security domain that you want to establish.

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. For

Table 10: Security Features

Component Security

Teradata Database Teradata server user ID and password authenticate the authority of an ARCMAIN job to backup 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 allow you to avoid having to store passwords in the configuration files or scripts. For a list of those documents, see “Additional Information” on page 5.



example, the following TSM server administration console commands could be used to segregate financial data backups from other data warehouse backups.

Register node EDW001 EDW_PASSWORDRegister node EDW_FINANCE FINANCE_PASSWORD

Choosing this option requires that you create special copies of the Default and Client Options files so you can 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. The TIVARC.BAT and TIVADM.BAT configuration files establish environment variables that point to the Default and Client Option files. (For a list of these variables, see “Environment Variables” on page 40.) Copy and customize the Client Options files to match site-specific requirements.

It is recommended that you 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 the ARCDFLT.TXT file (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 you presumably created during the TSM installation process.

For information about configuring TSM for Teradata backups, see “Configuring TSM for Teradata Backups” on page 22. 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

The TIVARC.BAT and TIVADM.BAT files establish environment variables that point to the location of sample Client Option files. These variables can be copied and customized to match site requirements.



Table 11: Environment Variables

Variable Description

DSMI_CONFIG Path to the TSM client configuration file, the dsm.opt file.

If this variable is undefined or set to the null string, the TSM API software expects to see a dsm.opt file 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 the following directory: C:\ProgramFiles\Tivoli\TSM\baclient.

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, a dsierror.log file is created in the local directory that executes the ARCMAIN or TDDSMC.

For information about using this file in troubleshooting, refer to Chapter 5: “Troubleshooting”.

ARCDFLT Path to ARCMAIN command-line DEFAULT file.

Note: Because of the way ARCMAIN processes this environment variable, you need to include the path name in quotes if you have embedded blanks in the string. (This is not necessary for the other environment variables.)

BARAMLOG Path to diagnostic log file for the Teradata Access Module for Tivoli. If this path variable is left undefined, then it defaults to the current working directory with a default log name of baram_log.txt.

Note: Logging always appends to this file. Periodically purge this file to prevent it from growing indefinitely as you keep re-running jobs.

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, then logging defaults to 1.

BARAM_DEFAULT Path to command-line defaults file for the Teradata Access Module for Tivoli. The fields defined in this file can be overridden on the command-line or you can 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.



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 invoke the access module.


CHAPTER 4

The TDDSMC Administrative Utility

This chapter provides the following information:

• Invoking the TDDSMC Utility

• Command-Line Parameters

• Format Specifiers

• Query TSM Command

• TDDSMC Help Command

Invoking the TDDSMC Utility

The TDDSMC Administrative utility is a command-line utility that allows database administrators and Tivoli Storage Manager (TSM) administrators to do the following:

• View Teradata backups in the TSM server catalog (you view the client node and file spaces associated with those backups, 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, and it can be executed through batch mode or interactive mode by way of the command-line. During the installation process, a shortcut is created.

Invoke the TDDSMC utility through the Windows command-line with the following string:

tddsmc [options] [command]

In batch mode, a single command for execution is included on the command-line. However, 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 sample TIVADM.BAT file that sets the same environment variables as described in “Environment Variables” on page 40. So it is possible to store frequently used options in the file pointed to by the BARAM_DEFAULT environment variable.

Each time the TDDSMC utility is invoked, 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 invoked.


Chapter 4: The TDDSMC Administrative UtilityCommand-Line Parameters

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

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 37, can also be entered as command-line parameters in the TDDSMC utility. Adding a prefix to each field name with a leading hyphen (-) makes it easy to distinguish command-line options from TDDSMC commands.

Use the IOPARM string specification from an ARCMAIN job as a command-line option to the TDDSMC utility. The following is an example of an acceptable string specification:

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

Syntax Conventions

The TDDSMC utility uses the following commands, which follow the same rules described in “Syntax Rules” on page 36: Additional command syntax and semantics are explained below.

• 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 following command syntax and semantics also apply to the above commands:

• Uppercase letters denote the shortest acceptable abbreviation of a command. Commands that are entirely uppercase cannot be abbreviated. For example, the QueRY key word can be expressed as QUERY, QRY, or Q.



• 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.

Following is an example of how to apply the above rules. In this 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 ]

Comment lines can be added 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, enter the following:

%crdate% JJ %name%

Note: The one exception to this rule is that the literal “\t” character sequences are translated to tab characters, so you can generate tab-delimited output files with something like: ‘%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 12: 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%



Examples

Following are examples of the effect of specifiers on string length and field width:

• The %name:15% specifier restricts the name field to 15 characters and right-justifies the string in the field.

• The %name:-15% specifier has the same field width, but strings will be left-justified in the field. Values longer than 15 characters are not truncated, but will they will skew the alignment on the line. The maximum field width is 255 characters.

Following is a sample command and the report it generates. The report illustrates 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

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

-12 Media Class %media%

Number of file segments 4 # Seg %segcnt%

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

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

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

Table 12: Metadata Fields (continued)

FieldDefault Width Heading Format Specifier



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:

• Invoke the TDDSMC utility with a question mark character (?) in the command:tddsmc ?

When you invoke the TDDSMC Help utility with a question mark (?), it will not attempt to open a session with the TSM server.

• In interactive mode, enter : TDDSMC> Help

The following 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.

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 & 11 delimiter - \



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. If you use multiple node names to store your Teradata backups, any QUERY BACKUP and QUERY OBJECT commands will 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.

For more information about field display, refer to the following 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 your TDDSMC output a bit more readable if you are using I/O re-direction to pass an entire script of TDDSMC commands to the utility and save the results in a file.

Re-enable the prompt with the PROMPT ON command.

Query Backup/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.

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



The optional gen field allows you to filter 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 45.

Delete Backup/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/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

This command only operates on active storage objects, but otherwise operates in a similar way to the DELETE command. Objects are not deleted, but the file retention rules for the backup copy group will eventually 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 expired.

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


CHAPTER 5

Troubleshooting

This chapter discusses the following:

• Interpreting Error Messages

• Access Module Debug Log

• ARCMAIN Outlog

• TSM Log Messages

• Error Conditions and Recovery

• Data Connector Error Messages

• Vendor-Independent Error Messages

• TSM Error Messages

Interpreting Error Messages

If errors occur with the Teradata Access Module for Tivoli during a Teradata backup, the access module and Tivoli Storage Manager (TSM) generate debug logs that can be used for troubleshooting.

Error messages reported by the 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:

• ARCnnnn messages are generated by ARCMAIN client code.

• BAMnnnn messages are generated by the Teradata Access Module for Tivoli. For more information, see “Data Connector Error Messages” on page 56.

• ANSnnnn messages are TSM client messages. For more information, refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM you are using. See http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

• ANRnnnn messages are TSM Server messages. For more information, refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM you are using. See http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

• Other error messages that are associated with the Teradata Access Module for Tivoli or TSM have error numbers that range from -50 to +50. For more information, refer to the version of IBM’s Tivoli Storage Manager Messages that correlates to the version of TSM you are using. See http://publib.boulder.ibm.com/tividd/td/tdprodlist.html.

• ARCMAIN errors range from 1 to 50, and are associated with the Data Connector component. For more details see “Data Connector Error Messages” on page 56





Chapter 5: TroubleshootingAccess Module Debug Log

• ARCMAIN error messages in the form of "*** Failure nnnn: ..." most likely originate with the Teradata Database. For more information, see Teradata’s Messages reference.

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

Access Module Debug Log

The Teradata Access Module for Tivoli automatically writes diagnostic tracing information to a debug log file. The name and location of this log file and the level of tracing can be controlled using the environment variables BARAMLOG and BARAMLOGLEVEL. For more information on these variables, see “Environment Variables” on page 40.

By default, the debug log file is called baram_log.txt and is located in the current working directory where ARCMAIN is executing. Diagnostic tracing in the Teradata Access Module debug log is available at the following levels.

ARCMAIN Outlog

It is recommended that you always evaluate ARCMAIN output to ensure that each job runs successfully, since all error messages (including the error code and message text) are displayed in the ARCMAIN outlog.

The 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 the Teradata Access Module.

Table 13: Log File Levels

Level Description

1 The default is 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 certain memory buffer information.

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


Chapter 5: TroubleshootingTSM Log Messages

TSM Log Messages

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

• TSM Server Activity Log

• TSM Client Log

TSM Server Activity Log

The Teradata Access Module 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 command generates the report, below, of Teradata Access Module messages that are associated with opening a Teradata backup file in WRITE mode:

Query actlog search=TDB0002

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 run-time by the DSMI_LOG environment variable or it is written to the local directory.

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 5: TroubleshootingError Conditions and Recovery

Because the TSM client log file is always opened in APPEND mode, 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 following error conditions can occur while invoking the Teradata Access Module or while backing up data. Use this information to ensure that the installation process is successfully completed and that all possible recovery options are considered.

Table 14: Error Conditions and Recovery Options

Error Condition Possible Recovery Option

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.

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 invokes ARCMAIN with the sample ARCDFLT.TXT file as the ARCMAIN default command-line option file.

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 40 are not properly set. Edit the TIVARC.BAT and TIVADM.BAT files accordingly.

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 either with the DSMI_LOG environment variable or it 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.


Chapter 5: TroubleshootingError Conditions and Recovery

dsmInitEx -- Session rejected This is an open session error from the Teradata Access Module, 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 “Configuring TSM for Teradata Backups” on page 22.

Unable to see backups in storage using TDDSMC

If the ARCMAIN process seems to be error-free, but you are unable to verify that the storage object was created on the TSM server, check the following:

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

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

query activitylog search=TDB0002

• Did you correctly type the DATASETNAME pattern? (TSM is case-sensitive.)

The QUERY TSM command from the TDDSMC utility might provide additional information. See Chapter 4: “The TDDSMC Administrative Utility.”

Errors that include a traceback

The Teradata Access Module 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.

1 Capture a complete output listing. For information about generating diagnostic traces, see “Environment Variables” on page 40 for details about the BARAMLOG and BARAMLOGLEVEL environment variables, as these variables control the diagnostic tracing for the access module.

2 When you have collected the trace information, contact the Teradata Global Support Center.

You might also encounter file locking contention when two jobs attempt to write to the same log file at the same time.

ANSnnnn or ANRnnnnTSM errors

The Teradata Access Module attempts to gather as much information as it can about the root cause of errors. Try to 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 53.

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

Hung up on a Teradata Database lock

Consult the Teradata QUERYSESSION and SHOWLOCKS console utilities for help.

Table 14: Error Conditions and Recovery Options (continued)



Chapter 5: TroubleshootingData Connector Error Messages

Data Connector Error Messages

The following error messages correspond to Data Connector error codes that range from 0 to 999.

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 53.

Table 14: Error Conditions and Recovery Options (continued)


Table 15: Data Connector Error Codes

Error Code Error Message Text Description and Remedy

BAM0011 Access module called by < > when expecting < >

The Teradata Access Module is being called by a program other than ARCMAIN, but the access module can only be used for Teradata backup and restore.

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

BAM0013 Invalid open mode < > requested The Teradata Access Module 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, but more likely it 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 the 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.



Chapter 5: TroubleshootingData Connector Error Messages

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

• < > value cannot exceed < > characters

• Unrecognized field name starting at: < >

The IOPARM string or the command contain 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.

BAM0024 Unsupported function code < > The Teradata Access Module is incompatible with the calling program.

The access module can only be used for Teradata backup and restore. Your version of ARCMAIN software is possibly incompatible with the Teradata Access Module software.


Table 15: Data Connector Error Codes (continued)



Chapter 5: TroubleshootingVendor-Independent Error Messages

Vendor-Independent Error Messages

The following error messages originate in the vendor-independent portions of the Teradata Access Module. These error codes range from 1000 to 1200.

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

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

The Teradata Access Module is incompatible with the calling program.

The access module can only be used for Teradata backup and restore. This error suggests that you are using a version of ARCMAIN software that is not compatible with the access module software level.


Table 15: Data Connector Error Codes (continued)




Table 16: 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.

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.



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 may be hidden behind this error.


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

The Teradata Access Module only functions in PASSWORD PROMPT mode.

Remedy: In the dsm.opt file, specify the PASSWORD mode as PROMPT.

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

The Teradata Access Module 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.

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 the Teradata Access Module.

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 the Teradata Access Module reserves those names for its own purposes.

Remedy: Correct the indicated name by removing the wildcard characters, and resubmit the job.

Table 16: Vendor Independent Error Messages (continued)




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

The Segmentname is only controlled by the Teradata Access Module, but it is shown in case you want to include it in an administrative query.

The generation number is entered as an IOPARM field or it 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= < >

The Teradata Access Module 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, either delete the corrupt objects or update the Object Info metadata with distinct generation numbers. Ensure that the backups are not creating new objects when you update the metadata.

If the remedy does not work, contact your field engineer or the Teradata Global Support Center.





BAM1009 Access Module currently does not support repositioning when writing to backup files

The Teradata Access Module 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.

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.

BAM1010 SetPos generation < > does not match current file generation of < >

When the Teradata Access Module 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 than the one that is currently open.

Normally, this condition would indicate a corrupted position field managed by ARCMAIN. However, it is possible that when using the CATALOG feature of ARCMAIN to get fast repositioning on a restore, ARCMAIN picks up a position that is inconsistent with the backup files in storage.

This condition could happen under the following circumstances:

1 Regularly run the same backup job, saving position information to the CATALOG database.

2 Create additional backups without invoking the CATALOG option, so there is no position information saved.

3 Run a restore using the most recent backup image from storage. In this case, the most recent image in storage may 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

The Teradata Access Module 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 mis-match occurred between the backup set being requested and the position information.


BAM1012 < > < > error < > < > The Teradata Access Module detects an unexpected error when invoking 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 may be difficult to fix. The Teradata Access Module 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 the Teradata Access Module 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, the Teradata Access Module 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 skipped from processing, because the access module cannot properly parse the segment name.

The Teradata Access Module 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 the Teradata Access Module 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.

The Teradata Access Module 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 < >

The Teradata Access Module is unable to open the command-line DEFAULT file. The cause of the file open error is indicated.

The DEFAULT file is specified via 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 The Teradata Access Module was called to close the backup file in an error condition. The write transaction is aborted and all storage objects created by this job will be 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. If you are unclear about the reason for the aborted backup, refer the output listing to the Teradata Global Support Center.




Chapter 5: TroubleshootingTSM Error Messages

TSM Error Messages

Error messages that range from 1200 to 1299 originate in the TSM portion of the Teradata Access Module. Note that some of the error codes have multiple error messages.

BAM1019 Access module is aborting due to Insufficient Memory This error occurs when the Teradata Access Module 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 17: TSM Error Messages


BAM1200 Access Module needs Tivoli Version < > Release < > but client library is Version < > Release < >

The Teradata Access Module 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 < >): < > The Teradata Access Module detects an unexpected error when invoking 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, the Tivoli Access Module 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 the Teradata Access Module 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 your TSM administrator to determine the source of the problem.

BAM1203 Tivoli Storage object FileSpace= < >, HighLevel= < >, LowLevel= < >, ID= < > is not recognized by Access Module. Skipping.

The Teradata Access Module 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 the Teradata Access Module. The specified object name in the query is picking up more than it should.

This warning message does not terminate processing because the Teradata Access Module cannot communicate a non-fatal warning condition to ARCMAIN. As a result, the return code indicator from ARCMAIN may 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 really should be considered for Teradata backup and restore, contact the Teradata Global Support Center.

If the object is being incorrectly qualified because the wild-card specification is too general, restate the query so it is correctly limited to the storage objects created by the Teradata Access Module.

BAM1204 TDDSMC syntax error: < > The TDDSMC utility in the Teradata Access Module 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, either issue the HELP command, or refer to Chapter 4: “The TDDSMC Administrative Utility”.

BAM1205 TDDSMC syntax error: < > field width cannot exceed < >

The TDDSMC utility in the Teradata Access Module 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, either issue the HELP FORMAT command, or refer to Chapter 4: “The TDDSMC Administrative Utility”.

Table 17: 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, the Tivoli Access Module rolls back and deletes all 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.

Remedy: For recommendations about correcting the cause of this error, refer to the TSM documentation.

Do one of the following:

• To run the Teradata Access Module 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.

BAM1207 TDDSMC syntax error: Expected quote string at >> ( ) << on command line

The TDDSMC utility in the Teradata Access Module detects a syntax error on the command-line arguments used to invoke 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, either issue the HELP command or refer to Chapter 4: “The TDDSMC Administrative Utility”.

BAM1208 TDDSMC syntax error: No matching and quote character on command line

The TDDSMC utility in the Teradata Access Module detects a syntax error on the command-line arguments used to invoke 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. Once 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 the Teradata Access Module detects a syntax error on the command-line arguments used to invoke the utility. A valid command was parsed, but non-blank trailing characters were detected.

This error can occur when an un-quoted name pattern contains embedded blanks. Because of optional fields after the name pattern, the actual source of the syntax error may 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 backup more than 4080 object segments. The maximum size of one backup job cannot exceed approximately 8 terabytes.

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; also referred to as Backup/Archive/Restore; a software and hardware product set.

C

CLI Teradata Call Level Interface API (application programming interface); allows an application or utility program to communicate to a Teradata system via 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 via a “divide and conquer” backup strategy.

D

DBA Database Administrator.

F

FIFO First In First Out queue.


Glossary

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 either 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; a product set consisting of OTB-Veritas, OTB-BakBone, and others; Teradata backup products for MP-RAS/UNIX, NT, and Windows 2000 platforms.

P

PE Parsing Engine.

R

RDBMS Relational Database Management System.

S

SAN Storage Area Network.

SSO Single Sign-On.

T

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.


Glossary

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’s 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% 31

Aadditional directories 21administrative user ID 39ALL option 32arcdflt variable 41arcdflt.txt 20, 40

installation 19archive script

example of multiple-node 34example of single-node 33

ARCHIVE statements 32ARCMAIN

configuration 17datasetname 30default directories 21error log 52files that mediate TSM 20overview 15restrictions 32scripts 30start-in directory 19Teradata Database connections 27

ARCMAIN scripttest before production 28

Bbackups

configuration of TSM 22controlling access 39created storage objects 31generations 31object names 29overview 29test before production 28

BAM####0-999 561000-1200 581200-1299 65

BAR Configuration Directory 19BAR Working Files directory 19BARAM_DEFAULT variable 41BARAMLOG variable 41

BARAMLOGLEVEL variable 41batch files 20

CCATALOG option 32Client directory 21client options 24Client Options file 19

configuration 24CLIv2

configuration 17collocation 32COMMMETHOD 25COMMTIMEOUT server option 24components

arcdflt.txt 20TDDSMC.exe 20TIVADM.BAT 20TIVARC.BAT 20TIVBAR.dll 20TIVDFLT.TXT 20Tivoli.Readme.TXT 20

configuration 17, 40client options 24installed files 20LAN 27LAN connections 18of TSM 22replacing files 19required TSM options 25TSM policy objects 22TSM server options 24

connectionsTeradata Database 27

cross-platform restrictions 32

DData Connector

configuration 17error messages 56

DataSetName 30debug log 52default

directories 21file location 19timeout 24


Index

default files 40dsm.opt file 41

installation 19DSMI_CONFIG variable 41DSMI_DIR variable 41DSMI_LOG variable 41dsmsta.opt file 26dual backup support 32

Eenvironment variables 41error logs

access module 52ARCMAIN 52TSM client log 53TSM errors 53TSM Server Activity log 53

error messages 510 to 999 561000 to 1200 581200 to 1299 65BAM#### 56Data Connector 56TSM 65vendor independent 58

Ethernet connections 18EXCLUDE option 32

Ffile size

indicator 24files

with installation 20

Ggenerations

backups 31

Hhardware

configuration 17

IIDLETIMEOUT server option 24Install Configuration Files dialog box 18installation 18

additional directories 21ARCDFLT.TXT 20default files 40TDDSMC.exe 20testing after completion 28

TIVADM.BAT 20TIVARC.BAT 20TIVBAR.dll component 20TIVDFLT.TXT 20Tivoli.Readme.TXT 20

inter-operability 32IOPARM

datasetname field 30

Jjumbo frames 18

LLAN configuration 18

Teradata Database connections 27LAN-free mode 18LANFREETCPPORT option 26LANFREETCPSERVERADDRESS option 26logon security 39logs

access module debug log 52

Mmanagement classes 32maximum files restored 24multiple jobs

controlling access 39naming conventions 31on a single volume 32

NNAMEDPIPENAME 25naming conventions

objects 29parameters 36

NODENAME 25nodes

pseudo nodes 39

Oobject names

naming conventions 29operating systems

restriction 32optional files 20outlog 52overview 15

PPASSWORD 25


Index

password 38security 39

PASSWORDACCESS 25platform

configuration 17restrictions 32

product overview 15product version numbers 3pseudo nodes 39

Rreadme.txt 20replace configuration files 19RESOURCETIMEOUT server option 24RESTARTduring rewrite 32restore file

maximum number indicator 24restrictions

ARCHIVE statements 32ARCMAIN 32collocation 32dual backup support 32examples 33inter-operability 32multiple-node 34no RESTART during write 32single-node 33

RETEXTRA field 23RETONLY field 23

Ssecurity 38

controlling access to backups 39files containing passwords 39logon 39pseudo nodes 39TSM 39

Server Activity log 53server configuration 22server options 24set up 18shared ICU Libraries for Teradata 18software

configuration and versions 17software releases

supported 3start-in directory 19, 21storage agent options file 26storage objects

created at backup 31storage pools 32storing backup data 29syntax rules 36

system managementsecurity 38

TTCPPORT option 26TCPSERVERADDRESS 25TDBAR directory 21TDDSMC

start-in directory 19TDDSMC.exe 20tdicu 18TDPID 27Teradata GSS Client 18timeout 24TIVADM.BAT 20, 40TIVARC.BAT 20, 40TIVBAR.dll 20tivdflt.txt 40

installation 19Tivoli.Readme.TXT 20

installation 19trial backup 28troubleshooting 51TSM

client error log 53configuration 22error logs 53policy object fields 23policy objects 22required options 25security 39Server Activity log 53server configuration 22

TSM client options 24TSM Client Options file 19TXNGROUPMAX server option 24

UUnicode support 17user IDs 38

Vvariables 41VERDELETED field 23VEREXISTS field 23version numbers 3versions

Tivoli Storage Manager 17

Zzero return code


Index

none on a job 28


Teradata Access Module for Tivoli - Online Tutorials...

Documents

Transcript of Teradata Access Module for Tivoli - Online Tutorials...