Teradata Extension for Tivoli Storage Manager. Administrator Guide

Transcription

1 Teradata Extension for Tivoli Storage Manager Administrator Guide Release B K May 2014

2 The product or products described in this book are licensed products of Teradata Corporation or its affiliates. Teradata, Active Data Warehousing, Active Enterprise Intelligence, Applications-Within, Aprimo Marketing Studio, Aster, BYNET, Claraview, DecisionCast, Gridscale, MyCommerce, SQL-MapReduce, Teradata Decision Experts, "Teradata Labs" logo, Teradata ServiceConnect, Teradata Source Experts, WebAnalyst, and Xkoto are trademarks or registered trademarks of Teradata Corporation or its affiliates in the United States and other countries. Adaptec and SCSISelect are trademarks or registered trademarks of Adaptec, Inc. AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc. Apache, Apache Hadoop, Hadoop, and the yellow elephant logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Apple, Mac, and OS X all are registered trademarks of Apple Inc. Axeda is a registered trademark of Axeda Corporation. Axeda Agents, Axeda Applications, Axeda Policy Manager, Axeda Enterprise, Axeda Access, Axeda Software Management, Axeda Service, Axeda ServiceLink, and Firewall-Friendly are trademarks and Maximum Results and Maximum Support are servicemarks of Axeda Corporation. Data Domain, EMC, PowerPath, SRDF, and Symmetrix are registered trademarks of EMC Corporation. GoldenGate is a trademark of Oracle. Hewlett-Packard and HP are registered trademarks of Hewlett-Packard Company. Hortonworks, the Hortonworks logo and other Hortonworks trademarks are trademarks of Hortonworks Inc. in the United States and other countries. Intel, Pentium, and XEON are registered trademarks of Intel Corporation. IBM, CICS, RACF, Tivoli, and z/os are registered trademarks of International Business Machines Corporation. Linux is a registered trademark of Linus Torvalds. LSI is a registered trademark 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. NetVault is a trademark or registered trademark of Dell Inc. in the United States and/or other countries. Novell and SUSE are registered trademarks of Novell, Inc., in the United States and other countries. Oracle, Java, and Solaris are registered trademarks of Oracle and/or its affiliates. QLogic and SANbox are trademarks or registered trademarks of QLogic Corporation. Quantum and the Quantum logo are trademarks of Quantum Corporation, registered in the U.S.A. and other countries. Red Hat is a trademark of Red Hat, Inc., registered in the U.S. and other countries. Used under license. SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc. SPARC is a registered trademark of SPARC International, Inc. 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 registered trademark of Unicode, Inc. in the United States and other countries. 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 [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 by Teradata. All Rights Reserved. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

3 Preface Purpose This book provides information about Teradata Extension for Tivoli Storage Manager (TSM), which is a Teradata Tools and Utilities product. Teradata Tools and Utilities is a group of products designed to work with the Teradata Database. Teradata Extension for Tivoli Storage Manager is supported by ARCMAIN as an interface for backing up and restoring objects in a Teradata Database. Teradata Extension for Tivoli Storage Manager manages the input/output (I/O) interfaces between the Teradata ARCMAIN client utility and IBM Tivoli Storage Manager (TSM). In the framework of Teradata Extension for Tivoli Storage Manager is Teradata Tiered Archive Restore Architecture (TARA). TARA is composed of three components: TARA server, TARA GUI, and the backup application extension, TIVBAR. Audience This book is intended for use by: System administrators System operators Users who are responsible for backing up data and restoring tasks Supported Releases This book supports the following releases: IBM Tivoli Storage Manager 6.2, 6.3, 6.4, and 7.1 (for TSM clients only) Teradata Database 12.0, 13.0, 13.10, 14.0, and 15.0 Teradata Extension for Tivoli Storage Manager Teradata Tools and Utilities or later Note: Open Teradata Extension for Tivoli Storage Manager s GUI. Click Teradata Tiered Archive/Restore Architecture>Help>About to display the Teradata Extension for Tivoli Storage Manager version number. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

4 Preface Prerequisites To locate detailed supported-release information: 1 Go to 2 Under Online Publications, click General Search. 3 Type 3119 in the Publication Product ID box. 4 Under Sort By, select Date. 5 Click Search. 6 Open the version of the Teradata Tools and Utilities ##.##.## Supported Platforms and Product Versions spreadsheet associated with this release. The spreadsheet includes supported Teradata Database versions, platforms, and product release numbers. Prerequisites The following prerequisite knowledge is required for this product. A familiarity with information covered in these IBM Tivoli manuals: Tivoli Storage Manager Administrator's Guide Tivoli Storage Manager for Linux 6.4: Administrator s Guide Tivoli Storage Manager for Windows 6.4: Administrator s Guide Tivoli Storage Manager for Windows Backup-Archive Clients Version 6.4 Basic concepts and facilities of the Teradata Database and the Teradata server Teradata backup and storage procedures A basic understanding of Microsoft Windows operating system administration A basic understanding of SUSE Linux operating system administration 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 May Description Clarified that only 1 stream should be used when specifying a Dictionary Only backup job. New topics: Estimating the Size for the TARA Server Repositories TARA Server and TARA Client Log Files Disabling Space Reclamation 4 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

5 Preface Additional 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 2 Under Online Publications, click General Search. 3 Type 3114 in the Publication Product ID box. 4 Click Search. 5 Select the appropriate Release Definition from the search results. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

6 Preface Product Safety Information Type of Information Description Access to Information Additional product information Use the Teradata Information Products web site to view or download specific manuals that supply related or additional information to this manual. 1 Go to 2 [Optional] For a list of Teradata Tools and Utilities documents: a Select Browse by Category>Data Warehousing. b Click Teradata Tools and Utilities. c Select a release or a specific title. 3 [Optional] For a specific title relating to a BAR software product: a b Click General Search. Enter a book name or keyword in Title or Keyword. Ordering information for manuals General information about Teradata Use the Teradata Information Products web site to order printed versions of manuals. 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 c Click Search. Specific books related to Teradata Extension for Tivoli Storage Manager are as follows: Teradata Archive/Recovery Utility Reference B mmyx Teradata Tools and Utilities Installation Guide for Microsoft Windows B mmyx Teradata Tools and Utilities Installation Guide for UNIX and Linux B mmyx 1 Go to 2 Under Print & CD Publications, click How to Order. 3 Follow the ordering instructions. 1 Go to Teradata.com. 2 Select a link. Product Safety Information This document may contain information addressing product safety practices related to data or property damage, identified by the word Notice. A notice indicates a situation which, if not 6 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

7 Preface Product Safety Information avoided, could result in damage to property, such as equipment or data, but not related to personal injury. Example: Notice: Improper use of the Reconfiguration utility can result in data loss. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

8 Preface Product Safety Information 8 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

9 of Contents Preface Purpose Audience Supported Releases Prerequisites Changes to This Book Additional Information Product Safety Information Chapter 1: Introduction Component Overview Migration from Legacy Product Older Version of Teradata Extension Discontinued Encryption UTF-8 Support Chapter 2: Teradata TARA Installation and Uninstallation System Requirements Linux Windows User Account Requirements Linux Windows Teradata TARA Installation Overview of Installation Packages Installation Location Installation Order Estimating the Size for the TARA Server Repositories Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

10 of Contents TARA Component Upgrade Installation of Teradata TARA Components on Linux Installation of Teradata TARA Components on Windows The xinetd Process on Linux Installed Components TARA Server Package Teradata TARA GUI Package Tivoli Access Module Package Uninstallation on Windows Uninstallation on Linux Chapter 3: TSM and Teradata TARA Configuration Configure TSM for Teradata Backups TSM Server Configuration TSM Client Options Configure the TARA Server GUI TARA Server Port Increasing the Java Heap Size Configure the TARA Server Step 1 - Configure the Teradata Database System Step 2 - Configure the Client Systems Step 3 - Configure the Client Groups Step 4 - Configure Tivoli Information Step 5 - Configure ARC Options Step 6 - Configure Logging Configure the Log File Chapter 4: Backup and Restore Using the GUI Starting the Teradata TARA GUI Displaying Help Archiving a Database Object Dictionary Only Archive TSM Parameters Overwrite at Runtime Selecting Individual Objects to Archive or Restore Restoring a Database Object Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

11 of Contents Dictionary Only Restore Analyze Using Script Options Dialog Box Analyze Using Restore DBC Dialog Box Restoring Latest Backup Job Restoring a Multistream Archive Using Fewer Streams Manually Restoring Multistream Archive Using Fewer Streams Restoring the DBC Database Backup Job Valid Keywords Validating Edited Job Scripts Keywords No Spaces Permitted Characters Stream Values CopyScript Options Excluding s in Job Script Viewing Job History Deleting Failed Jobs in Job History Aborting Jobs Searching for Strings in Job Logs Extensions for Job Files Deleting Temporary Files in baruser Directory Chapter 5: taratddsmc Command-Line Utility Overview of taratddsmc Installation Command Line Parameters Syntax Conventions Format Specifiers Taratddsmc Help Command Query TSM Command Prompt Off Command Query Backup and Query Object Commands Delete Backup and Delete Object Commands Batch Mode Inactivate Backup and Inactivate Object Commands Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

12 of Contents Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Sample Lines of Code Sample List Option Output Sample Query Option Output - Traditional View Sample Query Option Output - Hierarchical View TARAJobRM TARALaunch Guidelines and Parameters for Launching Scripts Parameters for Aborting Jobs TARALaunch Parameters TARALaunch Return Codes Sample Lines of Code Output taraping Sample Lines of Code TARASetCfg Sample Lines of Code Output Chapter 7: Teradata TARA Troubleshooting Troubleshoot Utility Creating a Diagnostic Bundle for Support TARA Support Bundle Script, Log, and.zip File Names and Location Support Bundle Information Overview of Error Messages Teradata Extension for Tivoli Storage Manager Debug Log TARA Server and TARA Client Log Files TARA Server Audit Log ARCMAIN Outlog TSM Log Messages TSM Server Activity Log TSM Client Log Error Conditions and Recovery Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

13 of Contents Data Connector Error Messages Vendor-Independent Error Messages TSM Error Messages Failure 8205 Error Message TARA Server Repositories Backup Client and Server System Health Client Heartbeat Server Heartbeat Backup Jobs with the Same Name TARA Server Stop and Restart Command Line for Obtaining Information Teradata TARA GUI on Java Runtime Extension States for Archive Jobs Job Stream Connection Failure Symptom Step 1: Verify that ARC Output Files are Being Created Step 2: Examine the Script that Launches Teradata ARC TARA Job Output Errors Symptom Remedy Unresponsive TARA Server Symptom Step 1: Add ulimit Step 2: Change Verbosity of TARA Server Log Recovery to a Different TARA Server Run an Analyze Job TARA Restore and Copy Procedure Restoring Data for Disaster Recovery TARA Server Directories for Disaster Recovery Recovering a Backup Dataset in the TSM Repository Appendix A: Storage of Backup Data: Command Line Utility Overview of Backup Data Storage Object Names DataSetName in ARCMAIN Backups and Restores Backup Generations Functional Restrictions No RESTART During Write Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

14 of Contents ARCHIVE Statement Recommendation per Script No Dual Backup Support Interoperability Collocation IOPARM Parameters Syntax Rules Parameter Definitions Security Security for Files that Contain Passwords Control of Access to Backup Images Stored in TSM Default Files for ARCMAIN and the Access Module Environment Variables Appendix B: Disabling Space Reclamation Overview of Space Reclamation Moving Data Appendix C: TVI Events TVI Messages Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

15 of Contents Glossary Index Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

16 of Contents 16 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

17 List of Figures Figure 1: Overview of a Teradata Extension for Tivoli Storage Manager Backup Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

18 List of Figures 18 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

19 List of s 1: User Accounts and Permissions for Linux Environment : User Accounts and Permissions for Windows Environment : CD Installation Packages and Locations : Actions Taken when TARA Server Package Installed : Subdirectories of taraserver_postinstall.sh : Files in bin Subdirectory : Folders and Registry Entries : Fields to Consider for the Backup Copy Group : TSM Server Options : TSM Client Options File Characteristics : Object Icons : Keywords for Job Scripts : Metadata Fields : Parameters for TARAJobQuery : Parameters for TARAJobRM : TARAJobRM Return Codes : Parameters for TARALaunch : TARALaunch Return Codes : Taraping Parameters : taraping Return Codes : Parameters for TARASetCfg : Script, Log, and.zip File Names and Location : Support Bundle Information : Types of Messages : Log File Levels : Error Conditions and Recovery Options : Data Connector Error Codes : Vendor Independent Error Messages : TSM Error Messages : States for Archive Jobs : Required TARA Directories : Optional Directories Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

20 List of s 33: Specifying Backup Image Names : Configuration for Examples : Parameter Definitions : Security Features : Environment Variables Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

21 CHAPTER 1 Introduction Teradata Extension for Tivoli Storage Manager is an access module that is supported by ARCMAIN as an interface for backing up and restoring objects in a Teradata Database. Teradata Extension for Tivoli Storage Manager manages the input/output (I/O) interfaces between the Teradata ARCMAIN client utility and IBM Tivoli Storage Manager (TSM). The same ARCMAIN executable code can communicate with a variety of access modules. This guide provides information about the installation and configuration of Teradata Extension for Tivoli Storage Manager, and how to perform backup and restore jobs. A troubleshooting section provides guidance for resolving error conditions and error messages. Note: This book changes the product name to Teradata Extension for Tivoli Storage Manager. The prior product name, Teradata Access Module for Tivoli, is used in the appendixes to describe the legacy Teradata Access Module for Tivoli product. The legacy product was accessed with a command line utility. The chapters use the term Teradata Extension for Tivoli Storage Manager for the new product, which is accessed through a Graphical User Interface (GUI). Component Overview ARCMAIN retrieves data from a Teradata Database server for tape storage, or retrieves data from tape storage to insert into a Teradata Database. In Figure 1, Teradata Extension for Tivoli Storage Manager interfaces with ARCMAIN through Data Connector to store backups onto TSM. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

22 Chapter 1: Introduction Migration from Legacy Product Figure 1: Overview of a Teradata Extension for Tivoli Storage Manager Backup Teradata Server ARCMAIN Single Process with Shared Library Calls TARA High-Speed LAN Connection Recommened When ARCMAIN Process Runs On a Remotely- Connected Node Data Connector Teradata Extension for Tivoli Storage Management Tivoli Client API Library LAN-mode Tivoli Client API Library TSM Server LAN-Free Mode Managed Storage TSM Database 2444C001 ARCMAIN does not call Teradata Extension for Tivoli Storage Manager directly. Instead, access is through a Data Connector component that dynamically loads the module and standardizes the interfaces. The Data Connector and ARCMAIN software must be installed before using Teradata Extension for Tivoli Storage Manager. For more about hardware and software requirements, see System Requirements on page 25. Migration from Legacy Product Use the legacy Teradata Access Module for Tivoli to restore backups that were created by Teradata Access Module for Tivoli. It is not possible to use Teradata Extension for Tivoli Storage Manager s GUI to restore those backups. Older Version of Teradata Extension Discontinued Teradata Extension for TSM with TIVBAR x has reached end-of-life. Teradata Extension 13.0 for TSM which uses TARA 13.0 is the replacement for TIVBAR 1.0.2x. TSM 5.5, TTU 13.0, and Teradata DBMS 13.0 are the final release versions supported by TIVBAR x. TSM users are encouraged to switch to Teradata Extension 13.0 for TSM when they upgrade to Teradata DBMS 12.0 or All Teradata DBMS archives created with Teradata Extension for TSM - TIVBAR can not be restored with Teradata Extension 13.0 for TSM. They can only be restored with Teradata Extension for TSM with TIVBAR. In addition, the final Teradata DBMS release for which TIVBAR archives can be restored is Teradata Therefore, TSM users who want to retain these archives post Teradata DBMS 22 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

23 Chapter 1: Introduction Encryption 13.0 must restore them to their Teradata DBMS using Teradata Extension for TSM - TIVBAR. They will also have to be archived using Teradata Extension 13.0 for TSM. Encryption In the release and later, Teradata Extension for Tivoli uses StorageTek Crypto Key Management System (KMS) from Oracle for encryption to replace the Protegrity encryption module. UTF-8 Support TARA supports UTF-8 database objects. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

24 Chapter 1: Introduction UTF-8 Support 24 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

25 CHAPTER 2 Teradata TARA Installation and Uninstallation This chapter describes installing Teradata TARA for SUSE Linux and Windows hosts: System Requirements User Account Requirements Teradata TARA Installation Installed Components To uninstall Teradata TARA, see: Uninstallation on Windows Uninstallation on Linux System Requirements Linux The next sections list the required software for Teradata TARA on Linux or Windows operating systems. Note: For any updates in installation requirements, refer to the most recent version of the Teradata BAR Backup Application Software Release Definition. Operating System Use one of the following for the TARA GUI, TARA server, and Tivoli access module: SUSE Enterprise Server 10 Linux SUSE Enterprise Server 11 Linux Non-Teradata Software Use Java Runtime Environment 1.6 or later. Teradata Tools and Utilities Software for 64-Bit Linux For TARA 15.00, you must install: Teradata Archive and Recovery Utility (ARC) or later The ARC version must be equal to the ICU, CLI, PIOM, and GSS versions. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

26 Chapter 2: Teradata TARA Installation and Uninstallation System Requirements Windows Version or later of the following software: Shared ICU Libraries for Teradata Teradata Call-Level Interface (CLI) V2 Teradata Data Connector (PIOM) Teradata GSS (TeraGSS) Note: Backup images that were created using TARA and TTU or earlier can be restored in a TARA and TTU BAR server environment. See the Teradata BAR Backup Application Software Release Definition for specific TARA and TTU software compatibility. Note: 32-Bit Linux is no longer supported. Operating System For the TARA GUI, use one of the following: Microsoft Windows bit SP2 for Tivoli Storage Manager 6.2, 6.3, and 6.4 Microsoft Windows bit SP1 for Tivoli Storage Manager 6.3 and 6.4 Microsoft Windows bit for Tivoli Storage Manager 6.3 and 6.4 For the TARA server and the Tivoli access module, use Microsoft Windows 2003 SP1 or later. Non-Teradata Software Install Microsoft Windows Script Host, version 5.6. If you are installing the Teradata TARA GUI package, also install Java Runtime Environment 1.6 or later. Teradata Tools and Utilities Software for 32-Bit Windows For TARA 15.00, you must install: Teradata Archive and Recovery Utility (ARC) or later The ARC version must be equal to the ICU, CLI, PIOM, and GSS versions. Version or later of the following software: Shared ICU Libraries for Teradata Teradata Call-Level Interface (CLI) V2 Teradata Data Connector (PIOM) Teradata GSS Client nt-i386 Note: Backup images that were created using TARA and TTU or earlier can be restored in a TARA and TTU BAR server environment. See the Teradata BAR Backup Application Software Release Definition for specific TARA and TTU software compatibility. 26 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

27 Chapter 2: Teradata TARA Installation and Uninstallation User Account Requirements Teradata Tools and Utilities Software for 64-Bit Windows For TARA 15.00, you must install: Teradata Archive and Recovery Utility (ARC) or later The ARC version must be equal to the ICU, CLI, PIOM, and GSS versions. Version or later of the following software: Shared ICU Libraries for Teradata Teradata Call-Level Interface (CLI) V2 Teradata Data Connector (PIOM) Teradata GSS Client nt-x8664 Note: Backup images that were created using TARA and TTU or earlier can be restored in a TARA and TTU BAR server environment. See the Teradata BAR Backup Application Software Release Definition for specific TARA and TTU software compatibility. User Account Requirements Teradata TARA requires specific user accounts and permissions for proper operation. Linux 1: User Accounts and Permissions for Linux Environment Linux User Account Required Permission Description taraserver 755 User Read/Write/Execute Group Read/Execute baruser 755 Other Read/Execute Windows 2: User Accounts and Permissions for Windows Environment Windows User Account Required Permission Description taraserver Local Administrators This account and permission is required to start the TARA server. The TARA server uses the LocalSYSTEM account for the TCS communication mechanism. baruser Local Administrators This account is necessary to launch TARA jobs. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

28 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation Teradata TARA Installation Overview of Installation Packages There are three TARA-related installation packages for Linux and Windows: TARA server Teradata TARA GUI Tivoli access module (tivbar) 3 lists installation package locations on the Teradata Extension for Tivoli Storage Manager (TARA ) CD. 3: CD Installation Packages and Locations OS TARA Server Package and Location TARA GUI Package and Location Tivoli Access Module Package and Location Linux 64-bit Linux/taraserver/x8664/taraserver- <version>-<release>.x86_64.rpm Linux/taragui/x8664/taragui- <version>-<release>.x86_64.rpm Linux/tivbar/x8664/tivbar- <version>-release.x86_64.rpm Windows 32-bit Windows 64-bit Windows\i386\taraserver\setup.exe Windows\i386\taragui\setup.exe Windows\i386\tivbar\setup.exe Windows\x8664\taraserver.setup.exe Windows\x8664\taragui\setup.exe Windows\x8664\tivbar\setup.exe Installation Location The TARA server runs on a node called the TARA server host, which contains the Job Information Repository, the Script Repository, the TARA server logs, and the default configuration file. The TARA server is the executable that manages the data stored in the different repositories and controls the flow of data between the TARA server, Teradata TARA GUI, and the Tivoli access module. On this host, the TARA server executable runs as a service. The Teradata TARA GUI can run on any node connected to the TARA server; such a node is called the TARA GUI host. The Teradata TARA GUI acts as the user interface to the TARA system. The Tivoli access module runs on a node called the TIVBAR host. The TIVBAR host must also be a BAR server node. The Tivoli access module is a Teradata-provided library file that interfaces with the ARCMAIN module, which is installed on the BAR server node during a Tivoli backup or restore job. Install all three packages on a single server, each package on a different server, or any combination in between. Base the decision about where the TARA components are installed on the availability of servers and the anticipated usage and load on those servers. 28 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

29 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation Installation Order For installation in a multiple BAR server environment, these recommendations apply: Install the TARA server on only one of the BAR servers. Install the Tivoli access module on every BAR server that is part of the Tivoli and TARA configuration. Install the Teradata TARA GUI on either or both of the sets of components that will be used as the administrative interface to TARA: BAR servers Workstations There are restrictions on the order of installation: Install the TARA server before the Tivoli access module. Install any product dependencies before installing the required TARA package (dependencies are noted in the next sections). Estimating the Size for the TARA Server Repositories The TARA server has JobFile and Script repositories that grow over time. It is important to maintain them so that they do not contain obsolete information. To initially estimate the size necessary to contain these repositories, you need to review your backup strategy in terms of: the backup jobs you will complete each week. the number of objects (database names and tables) of the backup jobs. the retention cycle of the images created by your backups. JobFile Repository (jir) For each backup job, estimate the JobFile size by the following formula: ((Number_of_objects * Number_of_streams * 2000 bytes) bytes) * Number_of_retentions The sum of the backupscript Repository (sr) jobs is the estimated size needed for the JobFile Repository. Script Repository (sr) For each script that you will need to create for the backup jobs, estimate the size by the following formula: (Number_of_streams * 200 bytes) + (Number_of_objects * 60 bytes) bytes The sum of the script sizes is the estimated size needed for the Script Repository Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

30 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation TARA Component Upgrade Logs Repository (logs) The default maximum taraserver log file size is 2,147,483,648 (2GB). The taraserver retains the currently-active logfile and one previous logfile. Maximum size necessary is 4,294,967,296 (4GB). Note: You can reduce the maximum size by configuring the maximum file size limit. Refer to Configure the Log File on page 63.<TARA-1557] When you are upgrading a TARA component from a prior release, remove the existing package before installing the new package: In Linux, use rpm - e <TARA_component_name>. In Windows, use the Control Panel Add/Remove Programs. Installation of Teradata TARA Components on Linux To install the TARA server On the Linux server where you want the TARA server to run: 1 Install the TARA server package with the rpm utility by typing one of the following: (For 64-bit) rpm -ih taraserver x86_64.rpm 2 Manually run the post-installation script. The post-installation script, taraserver_postinstall.sh, is usually located in /opt/teradata/tara/server/bin. Run the post-installation script by typing one of the following: /opt/teradata/tara/server/bin/taraserver_postinstall.sh cd /opt/teradata/tara/server/bin./teraserver_postinstall.sh 3 At the command-line prompt for the name of the Backup Application, type t for Tivoli. 4 Enter the user name for the owner of the TARA server service. The default is taraserver, which can be selected by clicking Enter. 5 Enter the user home directory. The default is /home/taraserver, which can be selected by clicking Enter. After a taraserver is installed or upgraded, the TARA directories are: # ls -l /opt/teradata/tara total 0 drwxr-xr-x 4 root root 128 Sep 18 07:40 gui drwxr-xr-x 4 root root 96 Aug 25 16:38 tivbar # ls -l /etc/opt/teradata/tara/server total 0 # ls -l /var/opt/teradata/tara/server total Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

31 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation drwxr-xr-x 2 root root 528 Oct 12 06:09 bin drwx taraserver root 112 Oct 20 08:54 config drwx taraserver root Oct 20 08:43 jir drwx taraserver root 104 Oct 20 08:43 logs drwx taraserver root 656 Oct 20 08:42 sr To install the Teradata TARA GUI On the Linux server where you want the Teradata TARA GUI to run: 1 Install the rpm version of the Java runtime routines with the rpm utility. 2 Install the Teradata TARA GUI package with the rpm utility by typing one of the following: (For 32-bit) rpm -ih taragui i386.rpm (For 64-bit) rpm -ih taragui x86_64.rpm The Teradata TARA GUI package has no post-installation script. Note: A dependency clause is included in the Teradata TARA GUI rpm file to check for the existence of Java runtime routines. The rpm utility only verifies that the Java runtime routines are installed if they were installed with the rpm utility. If the routines have been installed without the rpm utility, the utility does not detect them and the installation of the Teradata TARA GUI will fail due to a dependency error. To correct this error, uninstall the Java runtime routines and reinstall the rpm version of the Java runtime routines with the rpm utility. To install the Tivoli access module On the Linux server where you want the Tivoli access module to run: 1 Install the TTU packages for Teradata ICU, Teradata GSS, PIOM, CLIV2, and ARC with the rpm utility. 2 Install the Tivoli access module package with the rpm utility by typing one of the following: (For 32-bit) rpm -ih tivbar i386.rpm (For 64-bit) rpm -ih tivbar x86_64.rpm Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

32 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 3 Execute the post-installation script by typing one of the following: /opt/teradata/tara/tivbar/bin/tivbar_postinstall.sh cd /opt/teradata/tara/tivbar/bin./tivbar_postinstall.sh The post-installation script, tivbar_postinstall.sh, is usually located in /opt/teradata/tara/ tivbar/bin. As the message indicates, the post-install script designates the local server as a BAR server and sets up the required TARA client elements. Verify the taraserver process is active in its designated BAR server, then: 1 Click Enter. 2 At the prompt, enter the machine name where the taraserver process is running. The default is localhost, which can be selected by clicking Enter. 3 Enter the client name for this BAR server. The default is uname -n, which can be selected by clicking Enter. Note: The client name must be a valid name in the hosts file of this BAR server and the BAR server where the taraserver process is running, or a valid name in DNS. 4 Enter y or n to the following prompt: TARA needs 'baruser' user to have write permission to dsm.sys. Do you want to change permissions on dsm.sys? (y/n) /opt/tivoli/tsm/client/api/bin64/dsm.sys If you enter y, the permissions are changed on the dsm.sys file to allow the Teradata Extension write access. If you enter n, permissions are not changed and any attempts to run a job result in a Tivoli Storage Manager dsmsetup error. Installation of Teradata TARA Components on Windows The installation order of Teradata TARA components on Windows is: 1 TARA server 2 Tivoli access module and Teradata TARA GUI, in any order (installation instructions are given for the Tivoli access module first) To install the TARA server 1 Do one of the following: Download the TARA server (taraserver ) from the Teradata Software Server at: Save the file to your system. On the Teradata Extension for Tivoli Storage Manager CD, go to: (For 32-Bit) Windows\i386\taraserver\setup.exe (For 64-Bit) Windows\x8664\taraserver\setup.exe 32 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

33 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 2 Double-click setup.exe. (If the Backup Application is not installed, an error message displays. Click Yes to continue with the installation.) 3 Do one of the following: If this is a new installation of the TARA server, proceed to step 6. If this is a reinstallation of taraserver , or taraserver was previously removed with the Windows Add or Remove Programs, select Remove when a screen displays the choice of modifying, repairing, or removing the program. Click Next. 4 Click OK when asked to verify if the prior application should be removed. An Uninstall Complete dialog box verifies the removal of the TARA server. 5 Click Finish. 6 The TARA Server - InstallShield Wizard dialog box appears. 7 Click Next. The license agreement appears. 8 To accept the agreement and install the TARA server, click Yes. The Choose Destination Location dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

34 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation For an installation location different than what is shown in Destination Folder, click Browse and select an alternate location. 9 Click Next. The Start Copying Files dialog box appears. 10 Click Next if the destination folder is correct. The Setup Status dialog box displays installation status, then displays that installation is complete. 11 Click Finish. 12 At the command-line prompt, type t to install Tivoli, then click Enter. 34 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

35 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 13 Enter, then reenter the administrator password to complete TARA server installation. Passwords must have at least: Eight characters One numeric character One upper-case alphabetic character One lower-case alphabetic character Passwords cannot: Have three consecutive identical characters Be the reverse of the logon name Note: Use the password when logging on to the TARA server with the TARA GUI and when using the command-line utilities. See Chapter 6: Teradata TARA Command-Line Utilities. 14 Press any key to continue. To install the Tivoli access module 1 Double-click setup.exe. If the TSM Backup-Archive Client is not installed, a warning message appears. Note: If the warning message appears, cancel installation and install the TSM Client before reinstalling the Tivoli access module. 2 Do one of the following: If this is a new installation of the Tivoli access module, proceed to step 3. If this is a reinstallation of tarativbar , or tarativbar was previously removed with the Windows Add or Remove Programs, select Remove when the screen displays the choice of modifying, repairing, or removing the program. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

36 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation InstallShield Wizard Completed verifies the removal of TARA TIVBAR. Go to step Click OK. The TARA TIVBAR welcome screen appears. 4 Click Next. A license agreement appears. 5 If you agree with the terms of the license, select the radio button indicating consent, then click Next. Destination Folder appears. 36 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

37 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 6 Accept the default destination, or click Change to browse for another folder. Click Next. Ready to Install the Program appears. 7 Click Install. Status of the installation is displayed. When installation is complete, a dialog appears indicating completed installation. 8 Click Finish. A command-line interface opens. 9 Choose the path for the baruser home directory, following these rules: Choose a folder that already exists. Include a drive letter, followed by a colon (:) at the beginning of the path. Include a backslash (\) at the end of the path. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

38 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation The script automatically appends the name baruser to the path. If no path is entered, the default path, C:\Documents and Settings\, is created. 10 Click Enter. The baruser directory is created. 11 At the prompt for the name of the TARA server host, enter the name of the BAR server where the TARA server is running. Click Enter. The default is localhost. 12 Click Enter to complete the postinstall script. A connection is made to the TARA server host. 13 Click any key to continue. InstallShield Wizard Completed appears. 14 Click Finish. The Teradata Extension for Tivoli Storage Manager has been successfully installed. To install the Teradata TARA GUI 1 From the Teradata Extension for Tivoli Storage Manager CD, double-click one of the following: (For 32-bit) Windows\i386\taragui\setup.exe (For 64-bit) Windows\x8664\taragui\setup.exe Note: If this is a reinstallation of the TARA GUI, the prior copy will be removed. Click Finish to complete uninstallation, then double-click setup.exe again. 2 The TARA GUI InstallShield Wizard welcome screen appears. 3 Click Next. The license agreement appears. 4 To accept the agreement and install the Teradata TARA GUI, click Yes. The Choose Destination Location dialog box appears. 38 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

39 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components 5 For an installation location different than what is shown in Destination Folder, click Browse and select an alternate location. Otherwise, click Next. Start Copying Files is displayed with the specified destination. 6 Click Next if the destination folder is correct. The setup status is shown, then a message appears when installation is complete. 7 To create a shortcut icon on the desktop, select that option. Click Finish. The xinetd Process on Linux The xinetd process is similar in functionality to the inetd process, which starts programs that provide Internet services. The xinetd process is automatically disabled. To enable xinetd in SUSE: 1 Click Control Center>YAST>Network Services (xinetd). 2 Click Enable. 3 Tab to Status for All Services and press Enter. 4 Highlight and press Activate All Services. 5 Click Finish, then OK. The xinetd process is not necessary for Teradata TARA, however, it is vital for Tivoli software. Installed Components This section includes information on which items were installed and their location. The install path for the TARA directories and files is: (Linux) /opt/teradata/tara (Windows) \Program Files\Teradata\Teradata\TARA Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

40 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components The install path is referenced by install_path. There are three TARA-related install packages: TARA server install package Teradata TARA GUI install package Teradata Extension for Tivoli Storage Manager install package TARA Server Package The Windows install package and Linux taraserver_postinstall.sh script take the actions described in 4 upon installation of the TARA server package. 4: Actions Taken when TARA Server Package Installed Action Creates a new login account. Sets up the TARA server to run as a service on the TARA server host. Creates the TARA server install_path directory, /opt/teradata/tara/server. Details The user specifies the account name and home directory; the defaults are taraserver and /home/taraserver. Note: To install the TARA server on the same node as the Teradata Extension for Tivoli Storage Manager, do not change the TARA server's login information to baruser and /home/baruser. The packages cannot share the baruser account. Do not change the baruser account for the Teradata Extension for Tivoli Storage Manager. Instead, change the default taraserver account for the TARA server. None Under this directory, the taraserver_postinstall.sh script creates the bin, jir, sr, logs, and config subdirectories, which are described in 5. 5: Subdirectories of taraserver_postinstall.sh Subdirectory Name /bin /etc Description of Subdirectory Contains the TARA server executable file, plus the executable files for those programs that are needed to support the TARA server. The executable files provide these command-line utilities: taralaunch This utility launches a backup or restore job from the Script Repository on a specified TARA server. tarasetcfg This utility causes the TARA server to reset its configuration parameters by reading the defaults configuration file again. Contains the file named defaults. This file contains the default configuration parameters that the TARA server uses during initialization. Although this file is text-readable, it is advisable to modify it only through the Teradata TARA GUI, and not manually through a text editor. Note: Specifying the size of the log file must be done manually in defaults. 40 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

41 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components 5: Subdirectories of taraserver_postinstall.sh (continued) Subdirectory Name /jir /sr /logs /config Description of Subdirectory This is the Job Information Repository. These are binary files that contain the most current results of each backup or restore job that the TARA server controls. These files are a combination of binary and ascii, and should not be viewed and edited through a manual editor. This is the backup/restore script repository for the TARA server. Edit these scripts with the Edit feature of the Teradata TARA GUI. Contains the trace entries that the TARA server generates. Normally, the trace level is set to minimum, but can be increased in the event that troubleshooting becomes necessary. Used as a taraserver work directory for launching jobs and internal queries. Teradata TARA GUI Package When the Teradata TARA GUI package is installed, the Teradata TARA GUI install_path directory is created: (Linux) /opt/teradata/tara/gui (Windows) Program Files\Teradata\TARA\gui Under this directory, the bin subdirectory is created. This subdirectory contains the files described in 6. 6: Files in bin Subdirectory File taragui.jar TARALaunch TARAJobQuery TARAScriptConv taragui Config errors.xml Details This is the Teradata TARA GUI executable file. This utility launches a Tivoli backup or restore job from the script repository on a specified TARA server. This utility displays information that is stored a Job Information file, which is stored in the Job Information Repository on a specified TARA server. This option is not valid for the Teradata Extension for TSM. (Linux) The taragui script file is located in /opt/teradata/tara/gui/bin. To launch the Teradata TARA GUI with the script file, type one of the following: export DISPLAY=<your_IP_address or host_alias> /opt/teradata/tara/gui/bin/taragui & cd /opt/teradata/tara/gui/bin./taragui & (Windows) Double-click on the taragui.jar file. This file contains the release number of the TARA GUI. This is the error message file. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

42 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components The command-line utilities are useful for field personnel who do not have access to the Teradata TARA GUI. 42 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

43 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components For Linux, run the command-line utilities by typing one of the following: /opt/teradata/tara/gui/bin/<utility name> <parameters> cd /opt/teradata/tara/gui/bin./<utility name> <parameters> For Windows, run the command-line utilities by typing one of the following: <drive>\program Files\Teradata\TARA\gui\bin <utility name> <parameters> cd <drive>\program Files\Teradata\TARA\gui\bin <utility name> <parameters> Tivoli Access Module Package After the Tivoli access module package is installed, the Windows install package and the Linux tivbar_postinstall.sh script do the following: Copy runarctiv.bat to the /home/baruser home directory. (Linux) Set up a path and symbolic link to allow access to the libtivbar.so library file in opt/teradata/tara/tivbar/lib. (Windows) Place tarativbar.dll in Program Files/Teradata/tara/tivbar/lib directory. Create a new login account. The user cannot modify the account name and home directory. The login account is baruser and the home directory is /home/baruser. Note: To install the TARA server on the same node as the Tivoli access module, do not change the TARA server's login information to baruser and /home/baruser. The packages cannot share the baruser account. Instead, change the default taraserver account for the TARA server. (Linux) Create the /opt/teradata/tara/tivbar install_path directory. (Windows) Create the Program Files/Teradata/TARA/tivbar install_path directory. Under the install_path directory, the tivbar_postinstall.sh script creates the bin, lib, and logs subdirectories: Subdirectory Name /bin /lib /logs Description of Subdirectory Contains the executable files for those programs that are needed to support the Tivoli access module. Contains the Tivoli access module library file, libtivbar.so on Linux or tarativbar.dll on Windows. The file is used in conjunction with ARCMAIN during a Tivoli backup or restore job. Contains tivbar and taratddsmc log files. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

44 Chapter 2: Teradata TARA Installation and Uninstallation Uninstallation on Windows Uninstallation on Windows During installation, Teradata TARA creates folders and registry entries under Program Files\Teradata\Teradata TARA, then copies required files under the folders. When uninstalling Teradata TARA components, remove all of the folders and registry entries. This means, in some cases, that manual deletion is necessary in addition to using Windows Add or Remove Programs. 7 lists the folders that are created during installation, the associated registry entries, and information on manually removing files, folders, and registry entries. Typically, manual deletion is necessary if files were manually modified. 7: Folders and Registry Entries Folder Created During Installation Registry Entry Created During Installation Manual Deletion During Uninstallation gui HKEY_LOCAL_MACHINE\TERADATA\TARA Gui This folder and its registry entry are automatically removed during uninstallation. However, if any of the files under this folder were manually modified, the file is retained with the folder and the registry entry is not deleted. Manually delete the folder and the registry entry. server HKEY_LOCAL_MACHINE\TERADATA\TARA Server The uninstallation process does not automatically clear all folders and registry details. Manual deletion of files is necessary in some of the subfolders: bin This folder is automatically removed during uninstallation. However, if any of the files under this folder were manually modified, the file is retained with the folder. Manually delete the file and folder. config, jir, logs, sr These folders are not automatically deleted. Manually delete these folders and registry entries. tivbar HKEY_LOCAL_MACHINE\ TERADATA\tivbar This folder and its registry entry are automatically removed during uninstallation. However, if any of the files under this folder were manually modified, the file is retained with the folder and the registry entry is not deleted. Manually delete the folder and the registry entry. Other folders and files that require manual deletion are: \home\baruser the defaults file in \config 44 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

45 Chapter 2: Teradata TARA Installation and Uninstallation Uninstallation on Linux Uninstallation on Linux To uninstall Teradata TARA components, run rpm -e <name_of_the_component> For example: rpm -e taragui rpm -e taraserver rpm -e tarativbar The uninstallation process does not delete all files. (Some files may be retained for specific reasons.) Also, if any of the files under the TARA component directory were manually modified, they are retained with the directory. Manual deletion of those files is necessary (if they are no longer needed). The list of directories and files not deleted after uninstallation are: config /etc/opt/teradata/tara jir logs sr the defaults file in /etc/opt/teradata/tara /home/baruser Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

46 Chapter 2: Teradata TARA Installation and Uninstallation Uninstallation on Linux 46 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

47 CHAPTER 3 TSM and Teradata TARA Configuration Configure TSM before configuring Teradata TARA: Configure TSM for Teradata Backups Configure the TARA Server Configure the TARA Server GUI To configure the size of the log file, add an entry in the defaults file. See Configure the Log File. Configure TSM for Teradata Backups TSM Server Configuration A Teradata backup can be a backup of an entire Teradata Database, a selected database, or a selected table. To perform a Teradata backup, configure the TSM server first, the TSM client second, then set options for TSM. 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, Teradata Extension for Tivoli Storage Manager requires a backup copy group policy object. The backup copy group policy object can be preexisting or newly-created, but only TSM backup object types are supported. 8 lists TSM policy object fields that control the removal of inactive objects from storage. Objects become inactive when a backup is performed with the same name as an object that is already stored on the server. See Overview of Backup Data Storage on page 181. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

48 Chapter 3: TSM and Teradata TARA Configuration Configure TSM for Teradata Backups 8: Fields to Consider for the Backup Copy Group Field Description Default Versions Data Deleted (VERDELETED) Versions Data Exist (VEREXISTS) Number of inactive versions, if active versions do not exist. 1 Number of inactive versions, if active versions exist. 1 Retain Extra Versions (RETEXTRA) Retain Only Version (RETONLY) Number of days to keep the last inactive versions, if active versions do not exist. Number of days to keep the last inactive versions, if active versions do not exist TSM Client Node In the TSM software, by default, a client node can access only the backup storage objects that it creates. For instance, when a backup is performed on client node1, all ARCMAIN backups are registered in the TSM server catalog as belonging to node1 and all other nodes are prevented from accessing the storage objects created by node1. However, it is possible to grant authorization for nodes to access other backups by creating a pseudo node that is used by all clients performing backups. To create a pseudo node, use the TSM register node command that provides the node name and password. Then set the BACKDELETE option to YES. If this option is not set to YES, backup objects cannot be deleted with the TDDSMC utility. For information about the TSM register node command, refer to the Tivoli Storage Manager Administrators Guide on the IBM Web site at TSM Server Options Depending on site requirements, the TSM server option values for the TSM server (dsmserv.opt) and the TSM Storage Agent (dsmsta.opt) might need adjustment. 9 describes these options. 48 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

49 Chapter 3: TSM and Teradata TARA Configuration Configure TSM for Teradata Backups 9: TSM Server Options TSM Server Option COMMTIMEOUT IDLETIMEOUT RESOURCETIMEOUT TXNGROUPMAX Description Specifies how long the server waits for an expected client message during an operation that causes a TSM database update. If a message does not arrive before the specified wait period, the server ends the session with the client. To prevent clients from timing out while backing up large files or during a heavy network load, increase the time-out value. Specifies the amount of time, in minutes, that a client session can be idle before the server cancels the session. To prevent clients from timing out due to a heavy network load in the environment, increase the time-out value. Note: If the time-out value is increased, a large number of idle sessions could prevent other users from connecting to the server. 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. 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. TSM Client Options The TXNGROUPMAX option controls the number of files allowed in a transaction. Set this option to Although the maximum value allowed is 65000, TSM limits the number of objects restored at the same time to 4080 objects. Teradata Extension for Tivoli Storage Manager maps ARCMAIN backup files to a series of smaller storage objects or files segments with an object size of 2 GB. Therefore, the maximum size of a single backup cannot exceed 4080 * 2 GB, or approximately 8.1 TB. Every time an archive or restore job is run, Teradata TARA creates an options file and sets DSMI_CONFIG to point to this file. Options provided through the Tivoli tab of the TARA Server Configuration dialog box (see Step 4 - Configure Tivoli Information on page 58) creates <job_id>.opt. However, when a job requires overriding the node name and password, or requires more parameters, click ManagementClass in the Script Options dialog box when archiving (see step 4 on page 69). The Management Class Selection dialog box appears, in which the node name, password, and user parameters can be changed. 10 describes client user and client system options files. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

50 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server GUI 10: TSM Client Options File Characteristics Operating System TSM Client Options Files Description Directory or Folder Linux dsm.sys Specifies client system options: Servers to contact for services Communications options for each server Authorization options Archive processing options Scheduling options /opt/tivoli/tsm/client/api/bin/dsm.sys <job_id>.opt Specifies client user options. /home/baruser Windows <job_id>.opt The Linux Client System File Note: The TSM administrator gives the Teradata DBA write permission for dsm.sys, the client system file. Configuration choices made through the Tivoli tab of the TARA Server Configuration dialog box are appended to dsm.sys. If only the existing information in dsm.sys is needed (that is, no configuration information should be appended to that file) enter the Server Name only in the Tivoli tab of the TARA Server Configuration dialog box. Leave all other boxes in the dialog box blank. A <job_id>.opt file is also created, which contains the servername that points to the correct server stanza in dsm.sys. Teradata TARA sets DSMI_CONFIG to point to <job_id>.opt when a job runs. Configure the TARA Server GUI Use the Teradata TARA GUI for this procedure. After opening the Teradata Tiered Archive/Restore Architecture dialog box, use this procedure to configure the TARA server on which the Teradata TARA GUI is installed. 50 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

51 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server GUI To configure TARA server GUI 1 Click Settings>Graphical User Interface Configuration. The Graphic User Interface Configuration dialog box appears. TARA Server Port 2 The localhost name is the default and appears in the TARA Server box when the GUI is first run. Enter another TARA server name if the server on which the Teradata TARA GUI is installed changes. 3 The TCP port on which the TARA server listens for GUI and ARC connections appears in the TARA Server Port Number box. The default is and appears when the GUI is first run. 4 Click Apply to apply changes. By selecting the TARA Server Port tab, the port number can be changed. (The default port number is ) Changing the Port Number 1 Verify the Tara Server is idle. No jobs can be running when you change the port number. (The port number will be used later by the GUIs.) 2 The TARA GUI has a panel in the TARA Server Configuration screen that allows you to change the port number. Select the TARA Server Port tab. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

52 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server GUI 3 Enter the new TARA Server Port Number. Click OK. 4 From the Teradata Tiered Archive/Restore Architecture screen, select Settings>Graphical User Interface Configuration. 5 Enter the new Tara Server Port Number. Click OK. 6 Close all the existing TARA User Interface (UI) windows. 52 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

53 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 7 Restart the TARA Server and the TARA Client services. 8 Double-click or click Start>All Programs>Teradata Client>TARA GUI. 9 Logon to the TARA Server. Note: If the port is not changed on the client, change the port number in the config file in the home/baruser directory of the client. Note: For any of the TARA command line utilities, you must use the -P option to specify the correct TARA server port after changing the port number. Otherwise, the utilities will continue to use the default port number which is Increasing the Java Heap Size Increasing the Java heap size is necessary if the TARA GUI will monitor a job whose ARC output causes the GUI to exceed the default heap size of the Java Virtual Machine (JVM). A symptom of exceeding the default size is the GUI may freeze. If this happens, close the existing TARA GUI. For Linux, modify the script for the TARA GUI to include this JAVA heap size extension: -Xmx512m -jar "<path to Teradata taragui>\bin\taragui.jar" For Windows, modify the TARA GUI desktop icon to include the Java heap size extension: C:\WINDOWS\system32\java.exe -Xmx512m -jar "<path to Teradata taragui>\bin\taragui.jar" This increases the maximum heap size from 128 MB to 512 MB. Configure the TARA Server Use the Teradata TARA GUI for this procedure. There is a required order of configuration after a new installation of Teradata TARA. The first time after installation, define at least one of each of the following components before proceeding to the next definition. Follow the order given below: 1 Teradata Database system (refer to To configure the Teradata Database system on page 54) 2 Clients system (refer to To configure the client systems on page 55) 3 Client Groups (refer to To configure the client groups on page 57) 4 Tivoli information (refer to To configure Tivoli information on page 58) Click Refresh to populate the Client-Management Class Association and Available Management Classes columns. Note: Do not click Apply until you have completed these four steps. Applying these changes before defining the Tivoli information results in an external query failure. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

54 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server Step 1 - Configure the Teradata Database System After a new installation of Teradata TARA, the first step to configuring the TARA server is defining the Teradata Database system. Refer to Configure the TARA Server for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration. To configure the Teradata Database system Click Teradata Tiered Archive/Restore Architecture>Settings>Server Configuration. The TARA Server Configuration dialog box appears with the Teradata tab selected by default. 1 Do one of the following: From the Teradata System list, select the Teradata Database system to configure for the TARA server. The list contains display names, not TDPID names. Click New to add a Teradata Database system name. To remove a name from the list, select the name, then click Remove. 54 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

55 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 2 In Display Name, type the name that should appear for this TDPID within the Teradata TARA GUI environment. Usually, the display name and the Teradata TDPID name are the same. 3 In Teradata TDPID, type the Teradata Database machine name. Usually, the display name and the Teradata TDPID name are the same. 4 Enter a Browse user name in Browse User and an associated password in Password; both must be valid within the target Teradata Database. The Browse user and password form the Teradata Database logon information that the TARA server uses to query the Teradata Database. 5 Enter an ARC user name in ARC User and an associated password in Password; you must have backup and restore privileges for the ARC User name that you specify. 6 Click Single stream or Multi stream. For Multi stream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams. 7 In Default Session Count, the default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions are a waste of resources as some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail. 8 Select the Clients tab of the TARA Server Configuration dialog box, then go to To configure the client systems. Step 2 - Configure the Client Systems After a new installation of Teradata TARA, the second step to configuring the TARA server is defining the client systems. Refer to Configure the TARA Server on page 53 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration. To configure the client systems Select the Clients tab of the TARA Server Configuration dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

56 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 1 Do one of the following: Select a client system from the Client System list. Click New to indicate information for a new client system. To remove a client system from the configuration, select the client system from the Client System list, then click Remove. 2 Do one of the following: In Display Name, enter the client name that should appear for this client within the Teradata TARA GUI environment. (It is not necessary for the display name to match the system name.) Click New to change the client system information. The Display Name box now displays New Client Machine. Enter a new display name in the box. 3 Enter the system name of the client node in Client Machine Name. 4 Enter the maximum streams per job in Max Streams Per Job. Each stream is a portion of the entire backup job and consists of an ARCMAIN process sending to or receiving from Tivoli. 5 Select the Client Groups tab of the TARA Server Configuration dialog box, then go to To configure the client groups. 56 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

57 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server Step 3 - Configure the Client Groups After a new installation of Teradata TARA, the third step to configuring the TARA server is defining the client groups. Refer to Configure the TARA Server on page 53 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration. To configure the client groups Select the Client Groups tab of the TARA Server Configuration dialog box. 1 Do one of the following: From the Client Group list, select a client group. Click New to add a new client group to the configuration. To remove a client group from the configuration, select the group in the Client Group list, then click Remove. 2 In the Display Name box, type the client group name that should appear for this client group within the Teradata TARA GUI environment. It is not necessary for the display name to match the system name. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

58 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 3 The Selected Clients column contains the clients that have been added to a client group. To remove a client from the group, highlight the client, then click Remove. The client name is then transferred to the Available Clients column. 4 The Available Clients column contains the clients that can be added to a client group. Highlight the client, then click Add. The client name appears in the Selected Clients column. 5 To move a client up in the order in which it is used for backup, highlight the client in the Selected Clients column, then click Move Up. If there are more clients than streams, the client that appears first will be used for backup. The first client defined becomes the ARC master in a multi-stream job. The remaining clients rely on the ARC master to provide direction on what and how to run the backup or restore operation. To move a client down in the order in which it is used for backup, highlight the client in the Selected Clients column, then click Move Down. 6 Select the Tivoli tab of the TARA Server Configuration dialog box, then go to To configure Tivoli information. Step 4 - Configure Tivoli Information After a new installation of Teradata TARA, the fourth step to configuring the TARA server is configuring Tivoli information. This configuration information will be included in <job_id>.opt, the TSM client options file that is dynamically created when a TARA job is launched. Refer to Configure the TARA Server on page 53 for information on the other steps of configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration. To configure Tivoli information Select the Tivoli tab of the TARA Server Configuration dialog box. Note: If you are reconfiguring Tivoli information and the TSM client is on Linux, delete the Teradata stanza in the dsm.sys file. 58 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

59 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 1 Do one of the following: Click ConfigureLANFree for LAN-free mode, which is recommended for TSM. The LAN Free dialog box appears. Proceed to step 2. Clear the Enable LAN Free button for LAN mode. Proceed to step 4. 2 Select the communication method between the storage agent and the client from CommMethod. Note: For Linux systems operating in LAN-Free mode, select TCPIP. The Shared Memory communication method is not supported. For more details, refer to IBM Tivoli Storage Manager Administrator's Guide. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

60 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 3 Depending on the communication method selected, in: TCPPort, enter the TCP port to be used for communication between a client and the storage agent SHMPort, enter the Shared Memory port to be used for processing between a client and the SAN-attached storage device NamedPipeName, enter the name of the named pipe to be used for communication between the client and the storage agent Click OK. 4 In Server Name, enter the name of the TSM server instance. If the TSM client is on Linux, the server name identifies the Teradata TSM server stanza, as listed in dsm.sys. If you do not enter a new server name but make other changes on the Tivoli tab, delete the Teradata stanza in the dsm.sys file. 5 In TCPServer Address, the address of the TSM server is displayed. Or, enter another address. 6 Communication methods listed in the Communication drop-down list enable communication between the TSM server and the client: If LAN-free mode is enabled on Windows, TCPIP is the only allowed communication protocol. Port is the server s TCP/IP port address. The default value is If Sharedmem is selected (for Linux operating systems), Port is the port address where the TSM server establishes a Shared Memory connection. If Namedpipes is selected, Name becomes enabled. Enter the name of the named pipe. 7 Enter the TSM client node name in Node Name. The node name is in the TSM options file. The node name identifies the workstation to the TSM server and is used as a pseudo node name so that backups can be referenced from any client. 8 Enter the password assigned to the TSM client node in Password. 9 [Optional] In User Parameters, enter any other TSM client options, for example tcpwindowsize 63 or diskbuffsize 64. Refer to TSM Client Options on page 49 and Tivoli documentation for other client options. 10 In the Client Group drop-down list, the client group that was configured using the Client Groups tab appears. Or, select another group from the drop-down list and click Refresh to refresh the list of available clients under Client-Management Class Association. Click Default to set the client group displayed in the Client Group drop-down list the default. 11 The Enter Management Class Name drop-down list contains management classes listed in Available Management Classes. To add or delete existing management classes, do one of the following: To add a management class, enter the name. Click to add the management class to the Available Management Classes list. To delete a management class, select it from Enter Management Class Name and click to delete it from the Available Management Classes list. 60 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

61 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server 12 Client-Management Class Association lists the management classes that have been added to a client node. Expand the tree next to the client name to view the management class. 13 Do one of the following to add or delete a management class: To add a management class to the client node, highlight the: Client in Client-Management Class Association Management class in Available Management Classes Click Add. The management class is added to the client. To delete a management class from the client, highlight the management class listed under the client in Client-Management Class Association. Click Remove. 14 [Optional] Do one of the following to change the order in which a management class is used for a backup or restore job: To move a management class up, highlight it in the Client-Management Class Association list. Click Move Up. If there are more management classes than streams, the management class that appears first will be used for the backup or restore job. To move a management class down, highlight it in the Client-Management Class Association list. Click Move Down. 15 Click Apply to apply changes. Select the ARC Options tab of the TARA Server Configuration dialog box, then go to To configure ARC options. Step 5 - Configure ARC Options If this is a new installation of Teradata TARA, configure ARC options only after you have completed the first four steps described in Configure the TARA Server on page 53. If this is not a new installation of Teradata TARA, there is no required order of configuration. To configure ARC options Select the ARC Options tab in the TARA Server Configuration dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

62 Chapter 3: TSM and Teradata TARA Configuration Configure the TARA Server Step 6 - Configure Logging 1 [Optional] Select Use Catalog to specify positioning data, so that when an object is restored, Tivoli can locate it without searching the entire tape. 2 [Optional] Select Use Checksum Verification to verify that what it is archiving or restoring is valid data. 3 [Optional] Select a character set other than ASCII in the Default Character Set list. ASCII is the default. Refer to Teradata Archive/Recovery Utility Reference for details on valid ARCMAIN command-line options. 4 [Optional] In Extra ARC Options, enter any ARCMAIN command-line options that are not part of the GUI ARC build flow. If this is a new installation of Teradata TARA, configure logging only after you have completed the first four steps described in Configure the TARA Server on page 53. If this is not a new installation of Teradata TARA, there is no required order of configuration. 62 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

63 Chapter 3: TSM and Teradata TARA Configuration Configure the Log File To configure logging 1 [Optional] Check Enable Audit Log to track TARA Server configuration changes. See TARA Server Audit Log on page 151 for more information. 2 [Optional] Clear the Override Global Log Level box to change the log level. The Global Log level is pre-set to 32, which is the minimum, or normal, log level. The maximum level is 63. Increasing the Global Log level adds verbosity to the log for each TARA server component. 3 [Optional] Change other logging levels in the dialog box. Logging levels of the individual components of the TARA server are pre-set and cannot be changed unless the Override Global Log Level check box is selected. Note: Do not customize log settings unless Teradata Customer Support recommends it. Configure the Log File The default size of the Linux TARA server's logfile is 2GB. When this limit is reached, the TARA server saves the existing log as logfile.prev, then creates a new logfile before writing more Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

64 Chapter 3: TSM and Teradata TARA Configuration Configure the Log File log entries. Do not set the value greater than 2GB. Doing so can cause the TARA server to become unresponsive. Adjust the logfile maximum length to a value less than 2GB by adding an entry within the [Defaults] stanza of the: /etc/opt/teradata/tara/defaults file (Linux) <install_path>/teradata/tara/server/config/defaults file (Windows) Example Specify the file size in bytes: filesize=numofbytes For example, to set the log file size to exactly 500MB (500 * 1024), type: filesize= Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

65 CHAPTER 4 Backup and Restore Using the GUI After completing installation and configuration, you can start Teradata backup and restore operations through the Teradata TARA GUI. This chapter includes the following topics: Starting the Teradata TARA GUI Archiving a Database Object Selecting Individual Objects to Archive or Restore Restoring a Database Object Restoring a Multistream Archive Using Fewer Streams Manually Restoring Multistream Archive Using Fewer Streams Restoring the DBC Database Backup Job Valid Keywords Validating Edited Job Scripts CopyScript Options Viewing Job History Deleting Failed Jobs in Job History Aborting Jobs Searching for Strings in Job Logs Extensions for Job Files Deleting Temporary Files in baruser Directory Starting the Teradata TARA GUI To start the Teradata TARA GUI 1 To check the status of the TARA server service, type: /etc/init.d/tdtaraserver status 2 To start the TARA server service, type: /etc/init.d/tdtaraserver start Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

66 Chapter 4: Backup and Restore Using the GUI Starting the Teradata TARA GUI 3 To start the Teradata TARA GUI: For Linux, type one of the following: /opt/teradata/tara/gui/bin/taragui & cd /opt/teradata/tara/gui/bin./taragui & For Windows, do one of the following: Double-click on if you installed the TARA GUI icon on your desktop. Click Start>All Programs>Teradata Client>TARA GUI. The Logon to TARA Server dialog box appears. 4 Enter the previously configured password. The Teradata Tiered Archive/Restore Architecture dialog box appears. Displaying Help There are problems displaying numbered lists when viewing help with Internet Explorer V8.0. To remedy this problem, enable the browser setting to be compatible with Internet Explorer V7.0. When using a Linux operating system, the icon to expand a database tree is displayed as. 66 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

67 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object When using a Windows operating system, the icon to expand a database tree is displayed as. Archiving a Database Object You must log on to Teradata Database before you can select objects to archive or use Auto Generate to automatically archive databases. To log on to Teradata Database on page 67 To archive a database object on page 67 To use Auto Generate to archive databases on page 73 To log on to Teradata Database 1 Click Teradata Tiered Archive/Restore Architecture>Task>Archive. The Log on to Teradata DBS dialog box appears. 2 To log on to a Teradata Database, select it from the TDPID list. 3 Type a user account name for the Teradata Database in the UserID box. 4 Type the password for the user account in the Password box, then click Connect. The ARCHIVE object selection dialog box appears. To archive a database object 1 In the left and right panes of the ARCHIVE object selection dialog box are database objects that are available for archival. To archive a database, highlight or select the box next to the Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

68 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object database in the left pane. The tables of the database to be archived appear in the right pane, as shown in the next screen capture. 2 Right-click on a table in the right pane, then click Options. A dialog box for Partitioned Primary Index (PPI) options appears for that table. 68 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

69 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object 3 Under Partition selection, click on one of the radio buttons: Full table, which is the default, archives the entire table All Partitions option is not valid for archive operations Selected Partitions archives the specified partitions Other PPI Options is not valid for archive operations. 4 From the ARCHIVE object selection File menu, click Build ARC script or click. After the database objects are selected, the Selection dialog box appears. 5 Click OK. The Script Options dialog box appears. 6 Select options: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

70 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option Job Name Description Entries in Job Name are case-sensitive. A job name must not contain any spaces, or these characters: < > ~ " *,?. \ / The maximum length of the job name for Archive and Restore scripts is 220 characters. If this limit is exceeded, an error message requests that the job name be re-entered. Description TDPID User Name Password Single stream or Multi stream Default Group The entry in this box reflects the TDPID with which you logged on. It is not possible to change the TDPID. The user name with which you logged on appears. To create another job for the specified database, type a new user name. The password with which you logged on appears. To create another job for the specified database using another user name and password, type the new password. Click Single stream or Multi stream. For Multi stream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams. The list defaults to all clients, which are assigned to streams in a round-robin manner. For example, if there are six streams and four clients, the stream assignment is: Client1 is assigned to Stream1 Client2 is assigned to Stream2 Client3 is assigned to Stream3 Client4 is assigned to Stream4 Client1 is assigned to Stream5 Client2 is assigned to Stream6 If there are many clients, select a name from the list of available client groups. Using a client group reduces the amount of selections needed when building a new archive or restore job. 70 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

71 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option Assign Clients Description Each stream is defaulted to All clients. Click Assign Clients to assign a specific client (or a specific client group) to each stream. Configure Protegrity Encryption QueryBanding Online Backup Sessions (per stream) Extra Options Backup Application This option is no longer valid. The Crypto Key Management System (KMS) replaces Protegrity encryption. [Optional] Select QueryBanding. In the QueryBanding box, specify one or more pairs of names with associated values to identify the source of a query. This allows setting different priorities for different requests, and the ability to make better use of system resources. For example, enter a name and value pair, ending with a semi-colon: aaa=bbb;ccc=ddd; [Optional] 1 Select Online Backup to archive rows from a table at the same time update, insert, or delete operations on the table are taking place. When an online archive is initiated on a table or a database, a log is created for the specified table or separate logs are created for each table in the specified database. The log, which contains all changes to the table, is saved as a part of the archive process. When the table is restored or copied, the changes recorded in the log are used to roll back those changes in the table. The table is rolled back to the point that was established when online archive logging was started on that table. 2 In the drop-down list, select Default or NoSync. With the NoSync option, no read or access lock is placed on the database and the tables are not synchronized. The tables do not have a shared consistency point. Instead, each table has its own consistency point for restore jobs. The primary purpose of NoSync is to minimize the effect of transactions writing to the database. See Teradata Archive/Recovery Utility Reference for more information on online archive. The default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions waste resources because some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail. [Optional] Enter any ARCMAIN command line options that are not part of the GUI ARC build flow. IOTRACE=5, a debug parameter that ARCMAIN uses to enable a level of tracing, is the default. The default is Tivoli. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

72 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option Full Backup or Dictionary Only Use Catalog Verify Checksum Force online logging off Character set Management Class Description [Optional] Select Dictionary Only from the drop-down list to archive only the dictionary, or allow the Full Backup selection to archive the dictionary and data. If you choose Dictionary Only, specify only one stream per job. [Optional] Select Use Catalog to specify positioning data, so that when an object is restored, Tivoli can locate it without searching the entire tape. [Optional] Verify Checksum verifies that the data being archived is valid. The checkbox is selected by default. However, the overhead of error checking slows the archive process. To improve performance, clear the checkbox. Note: Job scripts created prior to clearing the Verify Checksum box have the verify checksum feature enabled by default. [Optional] To stop online logging: 1 Check the Online Backup box. 2 Check the Force online logging off box. Normally, Teradata ARC allows online logging to continue even when a job fails or is aborted. Log files can become so large that subsequent attempts to archive the same database result in job failure. Turning online logging off avoids the problem of log files becoming too large if a job fails or is aborted. An ONLINE LOGOFF job is created and runs immediately after the parent job completes, except when the TARA server aborts the parent job because no connection could be made to stream 1 within 10 minutes. The ONLINE LOGOFF job is also aborted for connection failure after 10 minutes. Note: The ONLINE LOGOFF job can be aborted from the GUI, regardless of its state. The default is UTF-8. Select another character set if appropriate. Click to display the Management Class Selection dialog box. Select one of the following: A group from Use Configuration from Group A management class for a stream after selecting Manual Selection Other Buttons Save Launch Preview Close Click Save to accept the current script. Click Launch to launch the job. [Optional] Click Preview to open the Script Editor dialog box and display the job script. The job script can be edited, then saved. Click Launch to launch the job. Click Close to close the Script Options dialog box. 72 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

73 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object 7 Click Save, then Launch. The Teradata Tiered Archive/Restore Architecture dialog box displays the launched job. Under the jobname, each of the job's streams appears. To view the ARC progress for the streams, double-click on one of the streams. In the next example, the State column indicates that Stream 1 has table data. The state conditions are: (B): Build phase (only for restore operations) (D): Dictionary (for archive and restore operations) (T): Data (for archive and restore operations) To use Auto Generate to archive databases The Auto Generate feature automatically generates the scripts required for archiving only the DBC database or all databases except the DBC database. 1 From the ARCHIVE object selection dialog box, click File>Auto Generate. The Auto Generate dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

74 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object 2 Select one of the following: Archive DBC database only Archive all databases except DBC database An ARC script is automatically generated for the selected archive job. 3 [Optional] Edit the ARC script. 4 Click OK. The Auto Generate dialog box closes and the Script Options dialog box appears. 5 Enter a job name in Job name. 6 [Optional] Enter or change other options in the Script Options dialog box. 7 Click Save. 8 Click Launch. Dictionary Only Archive Job status can be tracked in the State column of the Teradata Tiered Archive/Restore Architecture dialog box. To create a Dictionary Only archive job 1 In the Script Options dialog box, select Dictionary Only from the Full Backup and Dictionary Only drop-down list. 2 Ensure that SingleStream is selected. 74 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

75 Chapter 4: Backup and Restore Using the GUI Selecting Individual Objects to Archive or Restore TSM Parameters Overwrite at Runtime TARA archive and restore jobs allow you to use Tivoli Storage Manager (TSM) options such as node name and password at runtime. They overwrite the node name and password options provided globally in the TARA Server Configuration - Tivoli panel. If the node name and password are provided for the Archive Script during runtime, ensure they are provided when the Restore Script is created. To use TSM options 1 [Optional] For an archive job, access the parameters from the Script Options dialog box by clicking ManagementClass. 2 [Optional] For a restore job, access the parameters from the Script Options dialog box by clicking Options. Selecting Individual Objects to Archive or Restore Beginning with Teradata Database 13.0, selecting an individual view, macro, procedure, or other Teradata object to archive or restore is valid. Prior to Teradata TARA 13.0, archiving and restoring was limited to databases and tables. The prerequisites for this feature are version 13.0 or higher of: TARA Teradata ARC Teradata Database In the next screen example, the DiskEvents macro in the guest database is the only object selected for archive. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

76 Chapter 4: Backup and Restore Using the GUI Selecting Individual Objects to Archive or Restore 11 lists the icons that represent the objects. 11: Object Icons Icon Object Database Function Index Join Index Journal Macro 76 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

77 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object 11: Object Icons (continued) Icon Object Procedure SQL-H Trigger User Installed File View Restoring a Database Object To restore a database Use the next procedure to run a restore operation. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

78 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object 1 Click Teradata Tiered Archive/Restore Architecture>Task>Restore. The RESTORE object selection dialog box appears. In the left pane are datasets (jobs). The names underneath the Datasets icon are backup images and are listed in chronological order (earliest image to latest image). Click to the left of the dataset name to expand the tree further. 2 To restore a job, select the box next to it. The name of the specified object appears in the upper right pane, and the Backup Application name in the lower right pane under Details. The screen capture shows a database example without a hierarchical view. If the database has a hierarchical view, go to step 3. If the database does not have a hierarchical view, skip to step Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

79 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Double-click on the icon to the left of the object name to expand the tree and show the specific tables to be restored. 3 This screen capture shows a database with a hierarchical view. Double-click to navigate to a level in the left pane. The job and its tables appear in the right pane. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

80 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object 4 Right-click on the database icon or table in the right pane. A dialog box for copy and Partitioned Primary Index (PPI) options appears. 5 The options for the COPY options tab are: Option Rename Object Disable fallback on table (NO FALLBACK) Disable journaling on table (NO JOURNAL) Replace table creator value (REPLACE CREATOR) Specify different journal table APPLY TO list Description Gives the object in the archive a different name from the target object. Copies fallback tables into non-fallback tables. If the archived table is already non-fallback, this option has no effect. Copies all tables with journaling disabled, whether journaled in the archive or not. Replaces the LastAlterUID, creator name, and Creator ID of the tables in the target database with the user ID and the current user name, that is, the user name specified in the LOGON command. Specifies that a copied database has journaling for the specified database and journal table. Identifies the tables in the target system where the change images apply. Checking any of the boxes on this tab automatically selects the COPY script option of the Script Options dialog box for restore operations. 6 On the PPI options tab, under Partition selection, click on the radio button for one of these three options: 80 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

81 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Full table, which is the default, restores the entire table All Partitions restores all partitions Selected Partitions restores the specified partitions Under the Other PPI Options portion of the dialog box, select the LOG WHERE box to specify rows to be logged to an error table for manual insertion and deletion. Select the Error table name box to enter a table name other than the default name that is shown. Note: All PPI options are valid when restoring a table. Only the All Partitions option is valid when restoring a database. 7 Click RESTORE object selection>file>build ARC script. After the database objects are selected, the Selection dialog box appears. 8 Click OK. The Script Options dialog box appears. Note: If you are restoring a job that backed up only the DBC database or all of the DBC database, the Restore DBC dialog box appears instead of the Script Options dialog box. 9 Select options as described in the following table: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

82 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Job Name Always restore latest Description Entries in the Job Name box are case-sensitive. A job name must not contain any spaces, or these characters: < > ~ " *,?. \ / Note: Scripts that are created or modified manually are not checked to see if the name contains spaces or the characters listed above. The maximum length of the job name for Archive and Restore scripts is 220 characters. If this limit is exceeded, an error message requests that the job name be re-entered. [Optional] Check the Always restore latest box to automatically restore the last image that was backed up successfully. Note: If you are restoring an image created with a version of Teradata Extension for TSM prior to 14.0, update the job IDs before restoring the image. Update Latest Job Ids box in RESTORE object selection>edit>update Latest Job Ids Description TDPID User Name Password SingleStream or MultiStream This list reflects the TDPID with which you logged on. To restore a database or table from one Teradata Database to another Teradata Database, select another TDPID from the list of TDPIDs. The user name with which you logged on appears. To create another job for the specified database using another user name and password, type the new user name. The password with which you logged on appears. To create another job for the specified database using another user name and password, type the new password. Click SingleStream or MultiStream. For MultiStream, type the number of streams in the Multi stream box. The number of streams is essentially the number of BAR server tape drives that are configured. For example, if there are four BAR servers, each having two tape drives, enter eight streams. It is possible to specify fewer streams when restoring a job than were specified when the job was archived. 82 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

83 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Default Group Assign Clients Description The list defaults to all clients, that is, no client group. If there are many clients, select a name from the list of available client groups. Using a client group reduces the amount of selections needed when building a new archive/restore job Each stream defaults to All clients. Click Assign Clients to assign a specific client to each stream. Configure RestoreScript CopyScript Analyze QueryBanding Objects are restored instead of copied. The RestoreScript radio button is automatically selected. To copy objects, click CopyScript. To copy, instead of restore an object, click CopyScript. The RestoreScript radio button is cleared. When this option is selected, all the records are validated to ensure the correct order and type of records are on the tape. The entire backup image is analyzed, regardless of the databases that are selected for the analyze job. [Optional] Select QueryBanding. In the QueryBanding box, specify one or more pairs of names with associated values to identify the source of a query. This allows setting different priorities for different requests, and the ability to make better use of system resources. For example, enter name and value pairs, ending with a semicolon: aaa=bbb;ccc=ddd; Selecting QueryBanding enables the QB Options button. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

84 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option QB Options Sessions (per stream) Extra Options Use Catalog Description [Optional] Click QB Options to open the QueryBanding Options dialog box. Selected options are added to the job script. [Optional] Check the TVS Temperature box to enable a list with the following selections: Hot Specifies that the job is hot data, which is frequently accessed and changed. Warm Specifies that the job is warm data, which is more frequently accessed and changed than cold data. Cold Specifies that the job is cold data, which is infrequently accessed and rarely changed. Auto The temperature setting is based on the target system temperature settings. [Optional] Check the Block Compression box to enable a list with the following selections: Yes Block level compression is enabled. This setting overrides the setting information saved with the archive job. No Block level compression is disabled. This setting overrides the setting information saved with the archive job. Auto The block level compression setting is based on the target system block level compression settings. The default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions waste resources because some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference for more detail. [Optional] Enter any ARCMAIN command line options that are not part of the GUI ARC build flow. IOTRACE=5 is the default. [Optional] Select Use Catalog to specify positioning data so that when an object is restored, Tivoli can locate it without searching the entire tape. 84 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

85 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Verify CheckSum Skip Build Steps Character Set Options Description [Optional] Verifying the checksum verifies that the data being restored is valid. The checkbox is selected by default. However, the overhead of error checking slows the restore process. To improve performance, clear the checkbox. Note: Job scripts created prior to clearing the Verify Checksum box have the verify checksum feature enabled by default. [Optional] Select this check box to skip the build steps, which Tivoli considers idle time. If you skip the build steps now, manually run the build step outside of Tivoli after all data is restored. The default is ASCII. Select another character set if appropriate. [Optional] If TSM options such as node name and password were changed at runtime for the backup job, provide those options for the restore job. Extra Buttons Save Launch Preview Close Click Save to accept the script options that have been selected. Click Launch to launch the job. The job appears in the Teradata Tiered Archive/Restore Architecture dialog box. [Optional] Click Preview to open the Script Editor dialog box and display the job script. Make any corrections, then click Save in the Script Editor dialog box, then Launch to launch the job. Click Close, but do not click Save, to close the dialog box without saving any changes. 10 In the Script Options dialog box, click Save, then Launch. 11 The restore job status appears in the Teradata Tiered Archive/Restore Architecture dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

86 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Dictionary Only Restore A job can be created for a dictionary only restore. In the Script Options dialog box, select the Dictionary Only field from the Full Backup and Dictionary Only drop-down list. 86 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

87 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Analyze Using Script Options Dialog Box Selecting the Analyze option in the Script Options dialog box validates all records, which ensures the correct order and type of records are on the tape. The entire backup image is analyzed, regardless of the databases that are selected for the analyze job. For information about the ANALYZE command, see the Teradata Archive/Recovery Utility Reference. Note: The Script Options dialog box does not appear if you are restoring a job that backed up only the DBC database or all of the DBC database. Instead, the Restore DBC dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

88 Chapter 4: Backup and Restore Using the GUI Restoring Latest Backup Job Analyze Using Restore DBC Dialog Box To run an analyze job when restoring DBC database Use the Restore DBC dialog box to analyze a job that restores only the DBC database or all of the DBC database. 1 Select the DBC database job from the RESTORE object selection dialog box. 2 Click RESTORE object selection>file>build ARC script. 3 In the Restore DBC dialog box, click Skip Step 1. 4 Click Done in Step 2. 5 Click Generate in Step 3. Restoring Latest Backup Job To restore latest backup job You can automatically restore the last image that was backed up successfully. Depending on the version of Teradata Extension for TSM that created the image, you must update the job ID before restoring the image. 88 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

89 Chapter 4: Backup and Restore Using the GUI Restoring a Multistream Archive Using Fewer Streams If you are restoring an image created with: A version of Teradata Extension for TSM prior to 14.0, update the job ID Teradata Extension for TSM 14.0, updating the job ID is optional Note: Updating the job ID before restoring the last image is recommended. 1 (Optional for images created by version 14.0) In the RESTORE object selection dialog box: a b Click Edit>Update Latest Job Ids. All job IDs are updated in the latestjobs file on the server. Click OK. 2 In the RESTORE object selection dialog box, select the databases or objects for the restore job. 3 Click Build ARC script. 4 Click OK to confirm the selection. 5 In the Script Options dialog box, check the Always restore latest box. 6 Complete the other fields in the Script Options dialog box. 7 Click Save, then Launch to run the restore job. Restoring a Multistream Archive Using Fewer Streams To restore a multistream archive job using fewer streams To restore a database or table from a multistream backup when one or more of the disk or tape storage devices is unavailable, the restore job must be divided into two or more jobs. 1 Click Teradata Tiered Archive/Restore Architecture>Task>Restore. The RESTORE object selection dialog box appears. 2 Select the object to restore, then File>Build ARC Script. The Script Options dialog box appears. 3 Enter a job name. 4 In the Multi stream box of the Script Options dialog box, change the number of streams to the number of streams that are available. For example, if a backup job was created using 16 streams but only 4 storage devices are available for the restore job, select 4 streams. A dialog box requests validation of the client and stream assignments, and the stream count. 5 Click OK if the client and stream assignments are correct. If you click Cancel, the original stream count is restored. A dialog box notifies you that multiple jobs must be created to complete the entire restore job. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

90 Chapter 4: Backup and Restore Using the GUI Manually Restoring Multistream Archive Using Fewer Streams 6 Click OK. Job scripts are created for the streams that were specified and are displayed in the Teradata Tiered Archive/Restore Architecture dialog box. 7 In the Teradata Tiered Archive/Restore Architecture dialog box, select the first job script. In the example, 4 streams are specified for a restore job called new_test. The scripts that are created for the job are: new_test_1.res new_test_2.res new_test_3.res new_test_4.res Each job script contains 4 of the 16 streams specified in the backup job and must be run sequentially. In the example, new_test_1.res would be run first. 8 Click Launch. 9 Select and launch the next job that was created for the multistream restore job. In the example, new_test_2.res would be run. 10 Run the remainder of the job scripts sequentially. 11 [Optional] To display information job progress: a b Double-click the job or stream in the Teradata Tiered Archive/Restore Architecture dialog box. A dialog box appears with the job name. Select a stream to display its information in the bottom pane of the dialog box. Manually Restoring Multistream Archive Using Fewer Streams To manually restore a multistream archive job using fewer streams To restore a database or table from a multistream backup when one or more of the disk or tape storage devices is unavailable, divide the restore into two or more jobs. In the next example, the backup job for the multistream-4streams database was created using four streams. Only two storage devices are available, therefore streams 1 and 2 are restored in the first job, and streams 3 and 4 in the second job. 90 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

91 Chapter 4: Backup and Restore Using the GUI Manually Restoring Multistream Archive Using Fewer Streams 1 Click Teradata Tiered Archive/Restore Architecture>Task>Restore. The RESTORE object selection dialog box appears. 2 Select the object to restore, then File>Build ARC Script. The Script Options dialog box appears. 3 Type a job name. 4 In Multi stream, change the number of streams to the number of streams that are available. A dialog box advises reassigning the original clients and their streams before selecting fewer streams. In this example, two streams are specified. 5 Click OK. A warning that you are attempting to restore from fewer streams than the streams used for the original backup appears. 6 Click Cancel. 7 Click Cancel when asked if you want to revert to the original stream count. 8 Select the Skip Build Steps check box. The build step must be done only by the last restore job for this database, or separately, after all restore jobs have completed. 9 Click Save, then Launch. To display information on the job progress, double-click the job or stream. A dialog box appears. Select a stream to display its information in the bottom pane of the dialog box. 10 Create a new job for the remaining streams by editing the script for the job that just completed. Click Teradata Tiered Archive/Restore Architecture>Options>Edit or Preview in the Script Options dialog box. The Script Editor dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

92 Chapter 4: Backup and Restore Using the GUI Manually Restoring Multistream Archive Using Fewer Streams 11 Add the keyword STREAMNAME for each stream included in this job. The value of each STREAMNAME keyword is the name of each of the remaining streams. In the following example, the job restores the remaining two streams of the database multistream-4streams backup. 92 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

93 Chapter 4: Backup and Restore Using the GUI Restoring the DBC Database Backup Job Note: The NO BUILD statement is not removed from the script, therefore a separate ARCMAIN build is required after job completion. If the NO BUILD statement is removed, ARCMAIN automatically performs the build step. 12 Save the job with a name different from the original job name, then click Launch. View the job in the Teradata Tiered Archive/Restore Architecture dialog box and the Job History dialog box. Restoring the DBC Database Backup Job If you have created a job using Teradata TARA 14.0 or later in which only the DBC database or all of the DBC database was backed up, restoring the job requires a Teradata Database system initialization process that destroys all user and dictionary data and reinitializes the system. To reinitialize the system Before you restore all data from the backup job, delete the DBC database. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

94 Chapter 4: Backup and Restore Using the GUI Restoring the DBC Database Backup Job 1 Run sysinit to reinitialize the system. Refer to Utilities: Volume 1 (A-K), B [Optional] If necessary, reconfigure the system to the desired configuration. 3 Run the DBC Initialization Procedure (DIP) to initialize system views, macros, users, and error message tables. Refer to Utilities: Volume 1 (A-K), B To restore the DBC database backup job After you have deleted the DBC database and reinitialized the system, restore the DBC database backup job. 1 From the Teradata Tiered Archive/Restore Architecture dialog box, click Task>Restore. 2 In the Restore object selection dialog box, select the job that backed up all or only the DBC database. 3 Click File>Build ARC script. The Restore DBC dialog box opens. 4 Click Generate in step 1. The DBC database is deleted and restored. 5 [Optional] Check the Skip Step 1 box if you will not complete the remaining steps listed in this dialog box at the current time. Checking the box will remind you that the first step has been completed. 6 Validate that the DBC database has been restored by checking job status in the TARA GUI. 7 On a TPA node, run the post_dbc_restore script. When PUTTools is installed, the script is located at /opt/teradata/puttools/td14.xx.xx.xx/iumb_script. 94 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

95 Chapter 4: Backup and Restore Using the GUI Valid Keywords 8 Validate that the restore script completed successfully. A message indicates when the script has completed. 9 In the Restore DBC dialog box, click Done. 10 Click Generate in step After the data and journal tables are restored, run the post_data_restore script on the TPA node at /opt/teradata/puttools/td14.xx.xx.xx/iumb_script. 12 Click Close. Valid Keywords The following table describes valid keywords for backup and restore job scripts. 12: Keywords for Job Scripts Keyword Required for Backup Required for Restore Rules Description CATALOG No No The CATALOG keyword must be used in the backup job script that is associated with a restore job. CATALOG specifies positioning data so that when an object is restored, the object can be located without searching the entire tape. If the CATALOG keyword is used in a backup job script, positioning information is saved so that is can be used in the associated restore job. COMMANDLINE Yes Yes COMMANDLINE specifies the optional arguments that are passed to each ARC stream when the stream is launched. ENDSCRIPT Yes Yes ENDSCRIPT must be the last keyword in the script. ENDSCRIPT marks the end of the ARC script section. JOB Yes Yes The value is the name assigned to the TARA job. MULTISTREAM Yes Yes MULTISTREAM specifies the number of streams that will be launched for the job. TIVPOLICY Yes No There must be the same number of TIVPOLICY keywords as the MULTISTREAM value, unless TIVPOLICYGROUP is used instead of TIVPOLICY. The value is the name of the policy defined by the Backup Administrator. TIVPOLICYGROUP Yes No The value is the Client Group name, which is configured in TARA and contains Tivoli policy names. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

96 Chapter 4: Backup and Restore Using the GUI Valid Keywords 12: Keywords for Job Scripts (continued) Keyword Required for Backup Required for Restore Rules Description ONLINELOGOFF No N/A Users must not add the _ONLINE_LOGOFF suffix to backup job file names because the suffix is used by TARA. A backup job file name that has been specified with a suffix by the user does not appear in the RESTORE object selection dialog box. When ONLINELOGOFF is used, two jobs are launched. The first job is an active backup job. Status of the second job is pending until the first job completes, at which point the second job sets online logging off. The name of the second job appends _ONLINE_LOGOFF to the name of the first job. OTB Yes No The value of OTB is "Tivoli". PASSWORD No No PASSWORD is used with the USERID keyword. This value cannot be manually generated. SCRIPT Yes Yes SCRIPT must immediately precede the ARC script. PASSWORD is used by the ARC userid logon and Teradata Database. SCRIPT marks the end of the TARA script section and the beginning of the ARC script section. SESSIONS Yes Yes SESSIONS specifies the number of data sessions per stream that ARC establishes with Teradata Database for a backup or restore job. SOURCEUID No Yes SOURCEUID identifies the backup job that created the dataset used for the restore job. SOURCEUID is the file name and internal TARA job identifier. STREAM Yes Yes There must be the same number of STREAM keywords as the MULTISTREAM value. STREAMNAME N/A No If used, there must be the same number of STREAMNAME keywords as the MULTISTREAM value. STREAM is one of the following: Client name of the stream Client group (preceded by sign) In a restore job, STREAMNAME overrides the image name that is stored in the backup jobfile (SourceUID). TDPID Yes Yes The TDP identifier of the Teradata Database to which Teradata ARC connects to perform a backup or restore. USERID No No If used, there must be a PASSWORD keyword. USERID is the Teradata user database logon account that Teradata ARC uses. 96 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

97 Chapter 4: Backup and Restore Using the GUI Validating Edited Job Scripts Validating Edited Job Scripts You should validate any edited job script. Job script errors can result in the TARA server failing. Keywords No Spaces The following keyword lines are required in a job script: COMMANDLINE ENDSCRIPT JOB MULTISTREAM TIVPOLICY (backup job only) TIVPOLICYGROUP (backup job only) SCRIPT SESSIONS STREAM TDPID Ensure all keywords are spelled correctly. With the exception of the COMMANDLINE line, there must be no spaces at the end of a line of code. Permitted Characters Stream Values Ensure the values for the following lines contain only alphanumeric, underscore, and hyphen characters: JOB TIVPOLICY TIVPOLICYGROUP STREAM STREAMNAME There should be no embedded spaces or special characters except underscore and hyphen. Ensure the number of: STREAM lines matches the MULTISTREAM value STREAMNAME lines (if present) matches the MULTISTREAM value TIVPOLICY lines matches the MULTISTREAM value Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

98 Chapter 4: Backup and Restore Using the GUI CopyScript Options CopyScript Options Supported with TARA and later, there are three CopyScript options: Check/Uncheck Selections(s) Rename and Copy into Same Database Copy into New Database To access CopyScript options 1 From the Teradata Tiered Archive/Restore Architecture screen, select Task>Restore. 2 The Restore object selection dialog box appears. 3 From the left pane, select a database to display database objects in the right pane. 4 From the right pane, select two or more consecutive database objects: a b c Left-click on the first database object you want to select. Press Shift and left-click on the last database object in the series of database objects you want to select. In the next screen, BLOBT01, CLOBT01, COMBOLOBT01, and Count_Chars are selected. [Optional] To add another object to your list of objects, select the object by pressing CTRL and left-click. In the next screen, customer is added to the list of selected objects. 5 In the right pane, right-click. CopyScript options appear. 98 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

99 Chapter 4: Backup and Restore Using the GUI CopyScript Options 6 Go to one of the following sections for instructions on CopyScript options: To check or clear the selection of database objects To rename and copy database objects into the same database To copy into a new database Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

100 Chapter 4: Backup and Restore Using the GUI CopyScript Options To check or clear the selection of database objects 1 From CopyScript options, select Check/Uncheck Selection to toggle the checkmarks of highlighted database objects on or off. 100 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

101 Chapter 4: Backup and Restore Using the GUI CopyScript Options To rename and copy database objects into the same database 1 From CopyScript options, select Rename and Copy into Same Database. The Rename and Copy into Same Database dialog box appears. 2 Enter a new name for each database object. Click OK. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

102 Chapter 4: Backup and Restore Using the GUI CopyScript Options 3 From the Restore object selection screen, select File>Build Arc Script. The Selection dialog box appears. 4 Click OK to confirm the database object selections. The Script Options screen appears. 5 Enter the job name in Job Name. 6 Click Preview. The Script Editor screen appears displaying the renamed database objects. 7 Save the job by clicking Save when the Save Script dialog box appears. Leave the script type as not available. 8 Click Launch to launch the job. 102 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

103 Chapter 4: Backup and Restore Using the GUI CopyScript Options To copy into a new database 1 From CopyScript options, select Copy into New Database. The Copy Into New Database dialog box appears. 2 Enter the new database name. Click OK. 3 From the Restore object selection screen, select File>Build Arc Script. 4 The Selection dialog box appears. Click OK to confirm the database object selections. 5 The Script Options screen appears. 6 Enter the job name in the Job Name field. 7 Click Preview. The Script Editor screen appears displaying the database objects that will be copied into the new database. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

104 Chapter 4: Backup and Restore Using the GUI Excluding s in Job Script 8 Save the job by clicking Save when the Save Script dialog box appears. Leave the script type as not available. 9 Launch the job. Excluding s in Job Script If you back up the DBC database but exclude tables in the backup job script, only the dictionary information of the excluded tables is backed up. Data is not backed up. If you do not exclude tables when you restore the database, the excluded tables are empty when restored. You must explicitly exclude the tables in the restore job script to avoid overwriting the existing table. Viewing Job History To view job history, click Teradata Tiered Archive/Restore Architecture>Task>Job Viewer. There can be large amounts of job data, which is time-consuming to search. Export functionality, described in the next procedure, makes the task easier by placing the information into HTML table format. Then, a search can be quickly done for any value in the table. 104 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

105 Chapter 4: Backup and Restore Using the GUI Deleting Failed Jobs in Job History To export job data in HTML format 1 Click Teradata Tiered Archive/Restore Architecture>Task>Job Viewer. The Job History dialog box opens. 2 Click Job History>File>Export list to html. The Save dialog box opens. Save the HTML file in any location. Deleting Failed Jobs in Job History To delete failed jobs To clean up the Job History view and search for jobs more easily, delete failed jobs. 1 Click Task>Job Viewer. 2 Select one or more failed jobs or jobs with unknown status, which is indicated by?. 3 Right-click to display the shortcut menu. 4 Click Delete or Delete All. A warning appears. 5 Click OK. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

106 Chapter 4: Backup and Restore Using the GUI Aborting Jobs Aborting Jobs Abort a job by clicking Abort in the Teradata Tiered Archive/Restore Architecture dialog box. Note: A job will not abort if: A diagnostic ARC job is in progress A lock on Teradata Database has not been released yet The job is waiting on XBSA, for example, for a tape mount Searching for Strings in Job Logs To search for strings You can search for a specific string in a job log instead of logging onto the node and searching for the.out file in /home/baruser. For example, use the search function to determine if specific tables or databases were backed up or if there were any errors or warnings during the job. 1 Click Task>Job Viewer. 2 In Job History, double-click a job. A view with stream and object information for the specified job appears. 3 Click on a stream. Job log information appears in the bottom half of the view. 4 Position your cursor anywhere in the job log output and do one of the following: Right-click and select Search. Press Ctrl+F. 106 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

107 Chapter 4: Backup and Restore Using the GUI Extensions for Job Files The Search dialog box appears. 5 Enter the search string in Enter text. 6 Click OK. Extensions for Job Files Archive job files have the.arc extension. Restore job files have the.res extension. Existing jobs can be renamed so that they have the extensions. To rename a job 1 From the Teradata Tiered Archive/Restore Architecture screen, go to Options and select Rename. The Rename Script dialog box appears. 2 Enter the new name in Rename Script File. 3 [Optional] Select one of the following file extensions in Script Type:.arc(archive).res(restore) Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

108 Chapter 4: Backup and Restore Using the GUI Deleting Temporary Files in baruser Directory not available Select not available when there is no file extension. 4 Click Save. Deleting Temporary Files in baruser Directory In Linux, the baruser cron job that monitors the TARA client process automatically cleans up temporary files from /home/baruser on the 28th of each month at 6:00 pm. All temporary files prior to the current month are deleted. Temporary files are created by the TARA client when a job, query, or migration is run. The file format is????????????????_*, for example, 4f4660b _1.out. To clean up /home/baruser manually, change the first variable in the /home/baruser/tcsmon.bat script from CLEANUP=1 to CLEANUP= Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

109 CHAPTER 5 taratddsmc Command-Line Utility The taratddsmc command-line utility allows database administrators and TSM administrators to delete backup objects from TSM and: View Teradata backups in the TSM server catalog (the client node and file spaces associated with those backups are displayed, not the actual files in storage) Perform maintenance activities on backups Generate reports about specific backup images created by Teradata Extension for Tivoli Storage Manager For more information, see: Overview of taratddsmc Installation Command Line Parameters Syntax Conventions Format Specifiers Taratddsmc Help Command Query TSM Command Prompt Off Command Query Backup and Query Object Commands Delete Backup and Delete Object Commands Inactivate Backup and Inactivate Object Commands Overview of taratddsmc The Teradata Extension for Tivoli Storage Manager stores the generation number for each backup internally. That number can be displayed: In the Details pane of the RESTORE object selection dialog box With the TSM backup name and other details when a taratddsmc query command is issued on a backup (see Syntax Conventions on page 111 for details) When a backup job fails, Teradata TARA does not make an entry in the jir file and the job is not displayed in the Details pane of the RESTORE object selection dialog box. However, the job s backup name is listed in the TSM database with segment F0000. The job contains zero bytes. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

110 Chapter 5: taratddsmc Command-Line Utility Installation Use taratddsmc to delete the failed backup (segment F0000) and clear the TSM database of incomplete backups. Note: If taratddsmc or another TSM tool is used to delete a valid backup job (that is, a job that did not fail) in the TSM database, that job continues to be displayed in the RESTORE object selection dialog box. There is no mechanism to notify Teradata TARA of the deletion. Installation Taratddsmc is installed during Teradata Extension for TSM installation and is installed at: (Linux) /opt/teradata/tara/tivbar/bin (Windows) <destination_path>\teradata\tara\tivbar\bin The tarativadm.bat (for Windows) and tarativadm.sh (for Linux) script files are provided to establish environment variables that point to the location of files needed to run the utility. To run taratddsmc 1 In tarativadm.bat or tarativadm.sh, set the DSMI_CONFIG path to point to the correct options file (.opt): (Linux) Set DSMI_DIR to point to the path that contains the dsm.sys, dsmtca, en_us subdirectory, which is usually located in /opt/tivoli/tsm/api/bin. (Windows) Set DSMI_DIR to point to the dscenu.txt TSM API error message file. 2 Modify other values in tarativadm.bat or tarativadm.sh if necessary. 3 Run tarativadm.bat or tarativadm.sh to correctly set the environment variables. 4 Start taratddsmc through batch mode or interactive mode by typing the following at the command line: taratddsmc [options] [command] 5 To run taratddsmc in batch mode, type: Echo y taratddsmc DEL BA <pathname> <generation> Example Echo y taratddsmc DEL BA B90G100A 1 In the example, the backup object, B90G100A, is deleted. Multiple backup objects can be specified for deletion. Interactive mode occurs when no command is included on the command line. In interactive mode, taratddsmc prompts for input until a quit command is entered. Each time taratddsmc is started, a TSM server session is opened. In interactive mode, a single session is used for all commands. In batch mode, a different session is opened and closed each time taratddsmc is started. The next example shows variations of command line options for batch and interactive mode. 110 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

111 Chapter 5: taratddsmc Command-Line Utility Command Line Parameters Taratddsmc query backup * Taratddsmc? tddsmc> query tsm tddsmc> query backup fin* tddsmc> quit Taratddsmc -noheader query backup dbl_???? sort /+30 /R >backup.txt The prompt in interactive mode is 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 189, can also be entered as command line parameters in taratddsmc. Adding a prefix to each field name with a leading hyphen (-) makes command line options easy to distinguish from taratddsmc commands. Use the IOPARM string specification from an ARCMAIN job as a command line option to taratddsmc. An example of an acceptable string specification is: taratddsmc -ioparm config=mydsm.opt,mgmtclass=mymgmtclass q ba * Syntax Conventions The taratddsmc utility uses these commands: DELete Backup <pathname> [generation] DELete OBJect <pathname> <generation> <segname> FORMAT <formatstring> HELP <command-type> INActivate BAckup <pathname> INActivate OBJect <pathname> <segname> PROMPT [ ON OFF ] QueRY BAckup <pathname> [generation] [formatstring] QueRY OBJect <pathname> [generation] [segname] [formatstring] QueRY TSM QUIT Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

112 Chapter 5: taratddsmc Command-Line Utility Format Specifiers The commands follow the rules described in Syntax Rules on page 188, plus the following syntax and semantics: Uppercase letters denote the shortest acceptable abbreviation of a command. For example, express QueRY as QUERY, QRY, or Q. Commands that are entirely uppercase cannot be abbreviated. Formatstring means that a quoted string value is expected. Name means that a name value is expected using general syntax rules. Commands are not case-sensitive. In the next example, the user-supplied namepattern is required, but the gen and formatstring tokens are optional. The number of blanks or white space characters between keywords and tokens does not matter as long as the entire command is on a single line: QueRY BAckup namepattern [ gen ] [ formatstring ] Add comment lines in scripts by putting an asterisk (*) as the first non-blank character on a line. All-blank lines are echoed to the output stream. Format Specifiers Format string and format specifiers control the display output of the QUERY BACKUP and QUERY OBJECT commands. Any characters not contained within a format specifier are passed and displayed as is. For example, to produce Cr Time JJ BackupName, type: %crdate% JJ %name% Note: One exception to this rule is that the literal \t character sequences are translated to tab characters. To generate tab-delimited output files, type: %crdate%\t%name%\t%size%. Override the default field width of any of these metadata files by including a colon (:) and an integer width value inside the end delimiter. Positive width values are right-justified and negative width values are left-justified. 13 lists metadata fields, plus default widths, headings, and format specifiers. 13: Metadata Fields Field Default 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% 112 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

113 Chapter 5: taratddsmc Command-Line Utility Taratddsmc Help Command 13: Metadata Fields (continued) Field Default Width Heading Format Specifier Filespace Id 9 FS ID %fsi% Filespace Name -30 FS Name %fs% Generation Number 4 Gen %gen% Management Class -30 Mclass %mc% Media Class (such as, library, fixed-disk, off-site) -12 Media Class %media% Number of file segments 4 # Seg %segcnt% Segment Name (low-level) -30 Seg Name %segname% Total size in MB 9 Size (MB) %size% Examples The %name:15% specifier: Restricts the name field to 15 characters and right-justifies the string in the field. Has the same field width, but strings are left-justified in the field. Values longer than 15 characters are not truncated, but do skew the alignment on the line. The maximum field width is 255 characters. Next is an example of a command and the report it generates. The report shows that values longer than the specified width are not truncated, but the alignment is skewed. taratddsmc> q ba * * %crdate% %crtime% %name:-15% %gen% %status% Retrieved 17 records filtered to 8 backups Cr Date Cr Time Backup Name Gen A/I :01:14 new-multi_dstream A :34:50 new-multi_dstream I :01:56 new-multi_dstream A :35:27 new-multi_dstream I Taratddsmc Help Command The Help command causes taratddsmc to display syntax information for the defined command type. If no command is entered or an invalid command is entered, it is equivalent to HELP HELP. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

114 Chapter 5: taratddsmc Command-Line Utility Query TSM Command To access taratddsmc help, do one of the following: Start taratddsmc with a question mark character (?). On the command line, type: taratddsmc? When taratddsmc help is started with a question mark (?), the utility does not attempt to open a session with the TSM server. In interactive mode, type: tddsmc>help These Help commands are available: Help CMD displays syntax information for taratddsmc commands. Help FORMAT displays syntax information related to format strings. Help Help defines the various HELP commands that can be issued. Help TARATDDSMC displays information about the taratddsmc command line. 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:\Program Files\Tivoli\TSM\baclient\dsm.opt Note: This path can vary according to the value set in tarativadm. servername - SERVER1 commmethod - TCP/IP serveraddress nodename - NODE1 compress - 0 compressalways - 1 passwordaccess - PROMPT Server name - SERVER1 Server Host Server port Server type - Windows Servr Date/Time :22:08 Servr Release Client node type - Teradata Client filespace delimiter - : Client h1 and 11 delimiter - \ Client delete backup obj? - No 114 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

115 Chapter 5: taratddsmc Command-Line Utility Prompt Off Command Maximum objects in txn Client Node Name - PINOT Session Owner - API Config file - Policy Domain - STANDARD Management Class - STANDARD Backup retention grace period - 30 days The QUERY TSM command output is divided into three sections. The first section displays client-side options that connect the TSM server. For example, the first two lines indicate the environment variables currently in effect. The nodename field indicates the client node name that opens the TSM server connection. When using multiple node names to store Teradata backups, any QUERY BACKUP and QUERY OBJECT commands restrict access to only the backup created by this node. The other two sections of the QUERY TSM output describe the context of the TSM server session. Use this information to determine whether you are connecting to the correct TSM server, default management class, and so on. For more information about field display, refer to these IBM manuals: Tivoli Storage Manager for Windows: Administrator s Guide Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User s Guide Prompt Off Command The PROMPT OFF command disables the tddsmc> prompt. Using this prompt might make the taratddsmc output a bit more readable if I/O re-direction is used to pass an entire script of taratddsmc commands to the utility and save the results in a file. Re-enable the prompt with the PROMPT ON command. Query Backup and Query Object Commands The QUERY BACKUP and QUERY OBJECT commands print a formatted report about Teradata objects in storage that match an identified search pattern. The syntax is shown below. Note: QUERY OBJECT shows one record per storage object whereas the QUERY BACKUP command aggregates totals to have one record per Teradata backup generation. QueRY BAckup namepattern [ gen ][ formatstring ] QueRY OBJect namepattern [ gen ][ segnamepattern ][ formatstring ] The node name context is established at session logon. Tivoli API limitations cause casesensitive matching on the name patterns. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

116 Chapter 5: taratddsmc Command-Line Utility Delete Backup and Delete Object Commands The optional gen field filters output to specific backup file generations. The default value of zero for the gen field restricts output to only the most recent generation of a backup. An asterisk (*) character in the gen field qualifies for all versions of the qualified backups. Relative generation numbers, such as -1 for the second-to-last most recent backup, can also be indicated. The segname pattern refers to a segment number (F0000 through F9999). An asterisk (*) character in the segname pattern field returns all segments for a given object. For example, QRY OBJ span* 2 *1 returns segment F0001 for generation 2 of all objects matching the span pattern. If a format string is not specified in the command, the current default determined from the FORMAT command line option is used. For further explanation on format strings, see Format Specifiers on page 112. Delete Backup and Delete Object Commands The DELETE BACKUP and DELETE OBJECT commands expire, then remove the qualified objects from storage. DELete BAckup namepattern [ gen ] DELete OBJect namepattern [ gen ] segnamepattern Batch Mode To invoke taratddsmc in batch mode refer to this example: Echo y taratddsmc DEL BA B90G100A 1 This example accepts y (yes) as the standard input (stdin) and deletes the backup object, B90G100A. Inactivate Backup and Inactivate Object Commands The INACTIVATE BACKUP and INACTIVATE OBJECT commands change the qualified storage objects from an ACTIVE to an INACTIVE state. The syntax is shown below. INActivate BAckup namepattern INActivate OBJect namepattern segnamepattern These commands operate only on active storage objects; otherwise, the commands operate in a similar way to DELETE. Objects are not deleted, but the file retention rules for the backup copy group expire the object when it becomes inactive. Note: If the TSM server policy limits the number of inactive versions of a storage object, the oldest version might expire. 116 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

117 Chapter 5: taratddsmc Command-Line Utility Inactivate Backup and Inactivate Object Commands For more details about the TSM storage management policies, refer to the Tivoli Storage Manager for Windows: Administrator s Guide. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

118 Chapter 5: taratddsmc Command-Line Utility Inactivate Backup and Inactivate Object Commands 118 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

119 CHAPTER 6 Teradata TARA Command-Line Utilities This chapter contains information on Teradata TARA stand-alone command-line utilities: TARAJobQuery allows the display of job related information for completed TARA jobs without having to use the Teradata TARA GUI TARAJobRM provides the DBA the ability to delete scripts from the script repository, or job files from the job information repository. TARALaunch allows the execution of a TARA job without having to use the Teradata TARA GUI taraping tests TARA server health by testing TARA server connectibility interactively or in a script. TARASetCfg allows the explicit request of a TARA server to reset its configuration parameters by re-reading the defaults configuration file Note: Job scripts created prior to TARA must be changed to include the TARA Administrator name and the associated password. The change will take the form of: TARALaunch -j <TARA_script_name> -u Administrator -p <password> [other optional TARALaunch parameters] OR TARALaunch -j <TARA_script_name> -u Administrator -e <encoded_password filename> [other optional TARALaunch parameters]. Note: All command line utilities assume the TARA GUI and the TARA Server are running on the same system. If this is not the case, the TARA servername option is required. TARAJobQuery The TARAJobQuery utility allows the display of job-related information for all TARA jobs that have run (even those that have failed) without having to use the Teradata TARA GUI. TARAJobQuery is a stand-alone, command-line utility. The job information that TARAJobQuery accesses is stored in a Job Information file, which resides in the Job Repository (JIR directory) on a TARA server host. Only one Job Information file can be accessed at a time. TARAJobQuery provides two options for displaying job information: The List option allows the listing of summary job information for each Job Information file in the Job Repository. The information provided in this option allows the user to determine what data is stored in each Job Information file. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

120 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery The Query option allows the display of specific job information for a single Job Information file. Only one Job Information file can be accessed at a time. A typical scenario is to run TARAJobQuery using the List option first to find the Job Information file that you want to query. Then, rerun TARAJobQuery using the Query option to display the job data from that Job Information file. Run the TARAJobQuery utility by using the following job specifications. The command-line parameter indicators are case sensitive, therefore use the correct case when specifying the individual parameters. Also, specify each parameter only once in the command-line. To query for a list of summary information from each Job Information file, use: TARAJobQuery -u <username to log onto TARA server> -p <password to log onto TARA server> OR -e <path to encoded password file> -L[-s-P-f-v] -L <display summary list> -(required) -s <TARA servername> -[Optional] -P <port> -[Optional] -f<output file name> -[Optional] -v<verbose level: 1 2 3> [Optional] To query for specific job information from a single Job Information file, use: TARAJobQuery -u <username to log onto TARA server> -p <password to log onto TARA server> OR -e <path to encoded password file> -j [-s -S -O -f -l -L -N -P -v] -j <jobid> - (required) -s <TARA servername> - [Optional] -P <port> - [Optional] -S <stream options> - [Optional] -O <object options> - [Optional] -f <output file name> - [Optional] -l <output ARC logs> - [Optional] -L <output NetBackup logs> - (optional parameter that is not valid with Tivoli) -N <output NetBackup job data> - (optional parameter that is not valid with Tivoli) -v <verbose level: 1 2 3> - [Optional] 14 describes TARAJobQuery parameters, and indicates if the parameter is required. 120 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

121 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 14: Parameters for TARAJobQuery Parameter Description Required Default -u <User Name> Specifies the User Name that the utility uses to connect to the TARA Server. Currently the user names allowed are administrator and user. The user just has the read-only privilege. Example TARAJobQuery -u administrator -p Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARAJobQuery -u adminstrator -p xjmt94rs Yes Yes Not Applicable Not Applicable -e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name. Example TARAJobQuery -u administrator -e C:\Teradata\tara.pwd Note: The file containing the encoded password is created during the post-install of the TARA Server, and is located in the TARA server bin directory: \Teradata\TARA\server\bin). The name of the file is tara.pwd. If the utility is running on a machine different from the TARA server, tara.pwd can be copied to the machine, and the path to the file containing the encoded password can be specified. If you need to recreate a file with the encoded password, run the TARALogonGen executable located in the TARA server bin directory: \Teradata\TARA\server\bin. Enter the password and the tool creates a tara.pwd. This file contains the encoded password. Yes Not Applicable -L THIS PARAMETER IS NOT VALID WITH TIVOLI. This is the List option, which enables the listing of summary job information for each Job Information file in the Job Repository. The information provided for each Job Information file includes the file's associated jobid that is needed to execute TARAJobQuery using the Query option (see the -j parameter). There is no value specified with this parameter. Example -L Note: If you specify -L, you cannot use the -j <jobid> parameter. Yes Not Applicable Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

122 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 14: Parameters for TARAJobQuery (continued) Parameter Description Required Default -j <jobid> This is the Query option. This parameter enables the display of the job information stored in a single Job Information file. The jobid value specifies the Job ID of the Job Information file whose information is to be retrieved. The jobid value is typically a 16 digit number and is typically used as the name of the Job Information file. The names of the available Job Information files are in the Job Repository (JIR directory) on the specified TARA server host (see -s parameter). To determine what data is stored in a Job Information file (and its associated jobid), execute TARAJobQuery using the List option (see the -L parameter). Example -j 43c2ac Note: If you specify -j <jobid>, you cannot use the -L parameter. -s <TARA servername> This parameter specifies the TARA server host where the Job Information file and Job Repository are stored. The TARA servername value can be a host name (for example, taraserver1 or localhost) or an IP address of a host (for example, ). Example -s localhost Example -s This parameter is valid with the List option and the Query option. Yes No Not Applicable localhost -P <port number> Specifies the port number that the TARA server is running on. The default port is If the TARA Server port is changed to a different number, this option has to be specified with the correct TARA Server port number. Example TaraJobQuery -u administrator -p xflu74rs -j MyBackupJob -P No Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

123 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 14: Parameters for TARAJobQuery (continued) Parameter Description Required Default -S <stream options> This parameter specifies the job's stream information that will appear. The stream options value is a string of characters in which each character specifies a type of stream information. The string value can include one or more of the following characters: c - Client machine name e - Exit code f - File type (Archive or Journal) g - Group name n - Dataset name s - Stream size t - Stream time to complete (displayed in HH:MM:SS format) Example -S cefgnst This parameter is valid only with the Query option. -O <object options> This parameter specifies the job's object information that will appear. The object options value is a string of characters in which each character specifies a type of object information. The string value can include one or more of the following characters: c - Object count h - Hierarchical view (defaults to Traditional view) o - Owner name s - Object size t - Object time (displayed in HH:MM:SS format) y - Object type ( or Journal) The job's object information can be displayed in a Traditional or Hierarchical view. In a Traditional view, the objects appear in alphabetical order without regard to parent/child relationship. In a Hierarchical view, the objects appear in alphabetical order according to their parent/child relationship. Example -O chosty This parameter is valid only with the Query option. No No cest sty Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

124 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 14: Parameters for TARAJobQuery (continued) Parameter Description Required Default -f <output file name> This parameter specifies the name to be used in creating files for the output that is generated by TARAJobQuery. If the List option is specified, the output file name value is the full name given to the output file. If the Query option is specified, the output file name value is the base name given to these output files: <output file name>_job.txt - Job information and stream info <output file name>_obj.txt - Object information <output file name>_log_%d.txt - Log file for stream %d (only if -l specified) This parameter is optional. If not specified, the output generated will be sent to stdout, which is usually the monitor. When sending output to the monitor, a permanent copy of the file is not kept. If a fully-qualified output file name is used, the files are created in the specified directory. If a fully-qualified output file name is not used, the files are created in the current directory. Log records stored in the <name>_log_%d.txt file are the output lines from the ARC job that the TARA job executes. In other words, the log file contains output from the ARC job. In a multi-stream job, each stream-specific log file contains the output from the corresponding stream in the ARC job. Example -f myname If the List option is used, a single file, myname, would be created to store the output from TARAJobQuery. If the Query option is used, these files would be created: myname_job.txt myname_obj.txt myname_log_1.txt (if there is one stream and -l is specified) Example If the name contains embedded spaces or special characters, enclose the entire name in double quotes: "my name" OR "mydir/my Documents/myname" This parameter is valid with the List option and the Query option. No Not Applicable 124 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

125 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 14: Parameters for TARAJobQuery (continued) Parameter Description Required Default -l This parameter enables the creation of a file(s) to store ARC log information. There is one file created for each stream that is defined for the job. There is no value specified with this parameter. If you specify -l, the -f <output file name> parameter is also necessary. Example -l The -f <output file name> parameter generates a file(s) for ARC output (for example, myname_log_1.txt). This parameter is valid only with the Query option. No If this parameter is not specified, the ARC output that the TARA job generates will not be stored in a userspecified file. -v <verbose level: 1 2 3> This parameter specifies the level of debug information to display. There are three valid debug levels (1, 2, and 3), with higher values providing more extensive debug information. More extensive information is typically only useful for utility developers when gathering information about a reported problem. No If this parameter is not specified, debug information will not display. Example -v 3 Specifying 3 results in the highest level of debug information. This parameter is valid with the List option and the Query option. Sample Lines of Code tarajobquery -u administrator -p xdmjk4rs -L tarajobquery -u administrator -p xdmjk4rs -L -s localhost tarajobquery -u administrator -p xdmjk4rs -L -s f "my name" tarajobquery -u administrator -p xdmjk4rs -L -s remotehostname -f myname -v 3 tarajobquery -u administrator -p xdmjk4rs -j tarajobquery -u administrator -p xdmjk4rs -j s tarajobquery -u administrator -p xdmjk4rs -j s remotehostname -S cest - O sty Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

126 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery tarajobquery -u administrator -p xdmjk4rs -j s S cest - O sty -f "my name" -l tarajobquery -u administrator -p xdmjk4rs -j s localhost -S cefgnst -O chosty -f myname -l -v 3 Sample List Option Output This is output is generated by entering: tarajobquery -u administrator -p pword123 -L List of summary Job information for all Job Files in the Job Information Repository on TARA Server ' '. File Name/Job ID Job Name Date Stream Cnt bkjob3-dbc_all :14: c2ac bkjob6-rec-ptrs :33: c2ac bkjob2_db-level_2streams :34: d526d bkjob6-rec-ptrs :57: d526d bkjob4_table_level :02:09 0 List of summary Job information completed. Sample Query Option Output - Traditional View This output is generated by entering: tarajobquery -u administrator -p pword123 -j O oy Job "bkjob3-dbc_all" :14:31 (ID ) Operation: ARCHIVE TDPID: JKW2K Streams: 1 Stream Client Size Time Exitcode Jkw2k 680,532,117 :00:00 0 Object Type Owner ARCBARPPI_CATDB1 Database ARCBARPPI_CATU T1_PPI T2_PPI t3_ppi ARCBARPPI_CATDB2 Database ARCBARPPI_CATU T1_PPI T2_PPI 126 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

127 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery t3_ppi ARCBARPPI_CATU Database DBC Dbase ARCUSER Database DBC ARPTEST Database ARCUSER INDEXTABLE LOBTABLE PPITABLE BARP_FAOCPU Database DBC BARP_FAOD Database BARP_FAOU BARP_PPI_SIBT006 BARP_PPI_SIBT008 BARP_FAOU Database DBC BARP_PPIT001 BARP_PPIT002 BARP_PPIT003 BARP_PPIT004 BARP_PPIT005 BARP_PPIT006 BARP_PPIT007 BARP_PPIT008 BARP_PPI_TOO_LONG_TABLE_NAME editdistance_u editdistance_u_opt tokenize_u tokenize_u_opt BARP_FAO_ERRDB Database DBC BARP_ERR_TBL COPY29CHARDBNAMEWWWXXXXXYYYYY Database dbnametest twentyninechartbnamexxxxyyyyy COPY30CHARDBNAMEWWWXXXXXYYYYYZ Database dbnametest thirtychartbnamewwwxxxxxyyyyyz COPYSMALLDBNAME Database dbnametest smalltbname CRASHDUMPS Database DBC DBC Database DBC AccessRights AccLogRuleTbl Accounts CollationTbl Dbase Hosts LogonRuleTbl Next OldPasswords Owners Parents Profiles RCConfiguration RCEvent RCMedia RepGroup RoleGrants Roles SysSecDefaults Translation UDTCast UDTInfo UDTTransform Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

128 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery DBNAMETEST Database DBC DRXXX13 Database DBC T1 SMALLDBNAME Database dbnametest smalltbname SYSADMIN Database DBC FastLog HelpSyntax SYSLIB Database DBC SYSTEMFE Database DBC CleanupQCF CreateQCF opt_cost_table Opt_DBSCtl_ opt_ras_table Temp_ReconfigSpace SYSUDTLIB Database DBC TPMP_POINT_T_04dc_C tpmp_point_t_fromsql tpmp_point_t_ordering UDTINT_04de_C SYS_CALENDAR Database DBC CALDATES TDPUSER Database DBC THIRTYCHARDBNAMEWWWXXXXXYYYYYZ Database dbnametest thirtychartbnamewwwxxxxxyyyyyz TWENTYNINECHARDBNAMEXXXXYYYYY Database dbnametest twentyninechartbnamexxxxyyyyy Sample Query Option Output - Hierarchical View This output is generated by entering: tarajobquery -u administrator -p pword123 -j O hoy Job "bkjob3-dbc_all" :14:31 (ID ) Operation: ARCHIVE TDPID: JKW2K Streams: 1 Stream Client Size Time Exitcode Jkw2k 680,532,117 :00:00 0 Object Type Owner DBC Database DBC ARCBARPPI_CATU Database DBC ARCBARPPI_CATDB1 Database ARCBARPPI_CATU T1_PPI T2_PPI t3_ppi ARCBARPPI_CATDB2 Database ARCBARPPI_CATU T1_PPI T2_PPI 128 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

129 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery t3_ppi Dbase ARCUSER ARPTEST INDEXTABLE LOBTABLE PPITABLE BARP_FAOCPU BARP_FAOU BARP_FAOD BARP_PPI_SIBT006 BARP_PPI_SIBT008 BARP_PPIT001 BARP_PPIT002 BARP_PPIT003 BARP_PPIT004 BARP_PPIT005 BARP_PPIT006 BARP_PPIT007 BARP_PPIT008 BARP_PPI_TOO_LONG_TABLE_NAME editdistance_u editdistance_u_opt tokenize_u tokenize_u_opt BARP_FAO_ERRDB BARP_ERR_TBL CRASHDUMPS DBNAMETEST COPY29CHARDBNAMEWWWXXXXXYYYYY twentyninechartbnamexxxxyyyyy COPY30CHARDBNAMEWWWXXXXXYYYYYZ thirtychartbnamewwwxxxxxyyyyyz COPYSMALLDBNAME smalltbname SMALLDBNAME smalltbname THIRTYCHARDBNAMEWWWXXXXXYYYYYZ thirtychartbnamewwwxxxxxyyyyyz TWENTYNINECHARDBNAMEXXXXYYYYY twentyninechartbnamexxxxyyyyy DRXXX13 T1 SYSADMIN FastLog HelpSyntax SYSLIB SYSTEMFE CleanupQCF CreateQCF opt_cost_table Opt_DBSCtl_ opt_ras_table Temp_ReconfigSpace SYSUDTLIB TPMP_POINT_T_04dc_C tpmp_point_t_fromsql tpmp_point_t_ordering UDTINT_04de_C Database DBC Database ARCUSER Database DBC Database DBC Database BARP_FAOU Database DBC Database DBC Database DBC Database dbnametest Database dbnametest Database dbnametest Database dbnametest Database dbnametest Database dbnametest Database DBC Database DBC Database DBC Database DBC Database DBC Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

130 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM SYS_CALENDAR CALDATES TDPUSER AccessRights AccLogRuleTbl Accounts CollationTbl Dbase Hosts LogonRuleTbl Next OldPasswords Owners Parents Profiles RCConfiguration RCEvent RCMedia RepGroup RoleGrants Roles SysSecDefaults Translation UDTCast UDTInfo UDTTransform Database DBC Database DBC TARAJobRM To remove a TARA job file or a TARA script, use: TARAJobRM -u <username to logon to TARA server> -p <password to logon to TARA server> OR -e <path to encoded password file> -s <taraserver> -P <port> -S [<script_name> : -f <input_file] [-v 0:1:2:3] OR TARAJobRM -u <username to logon to TARA server> -p <password to logon to TARA server> OR -e <path to encoded password file> -s <taraserver> -P <port> -J [<jobfile_name> : -f <input_file] [-v 0:1:2:3] -F TARAJobRM allows the DBA to remove script files or job files from the TARA server repository, using one of the following job specifications: Example tarajobrm -u [ <username> ] -p [ <password> ] OR -e [ <path to encoded file> ] -S [ <script_name> -f <input_filename> ] 130 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

131 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM [ -s <TARAServer_name> ] [ -v ] [-P <Port>] Example 15: Parameters for TARAJobRM tarajobrm -J [ <jobfile_name> -f <input_filename> ] [ -s <TARAServer_name> ] [ -v ] [-F] Parameter Description Required Default -u <User Name> Specifies the User Name that the utility uses to connect to the TARA Server. Currently the user names allowed are administrator and user. The user just has the read-only privilege. Example TARAJobRM -u administrator -p <password> Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARAJobRM -u administrator -p xjmt94rs Yes Yes Not Applicable Not Applicable -P <port> Specifies the port number that the TARA server is running on. The default port is If the TARA Server port is changed to a different number, this option has to be specified with the correct TARA Server port number. Example TaraJobRM -u administrator -p xflu7pqr -j MyBackupJob -P No e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name. Example TARAJobRM -u administrator -e C:\Teradata\tara.pwd Note: The file containing the encoded password is created during the post-install of the TARA Server, and is located in the TARA server bin directory: \Teradata\TARA\server\bin). The name of the file is tara.pwd. If the utility is running on a machine different from the TARA server, tara.pwd can be copied to the machine, and the path to the file containing the encoded password can be specified. If you need to recreate a file with the encoded password, run the TARALogonGen executable located in the TARA server bin directory: \Teradata\TARA\server\bin. Enter the password and the tool creates a tara.pwd. This file contains the encoded password. Yes Not Applicable Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

132 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM 15: Parameters for TARAJobRM (continued) Parameter Description Required Default -S <script_name> Specifies a script name, or the name of a file that has a list of script names to delete. If specifying a single file, the name of the file must immediately follow -S. If specifying a file that has a list of script names, precede the file name with -f (see the -f <input_filename> parameter). In the file containing the list: Each script name must be the first field in the line. Specify only one script name on each line. Spaces delimit the fields in a line. -f <input_filename> Specifies the name of a file that has a list of script or job names to delete. -J <jobfile_name> Specifies a job name, or the name of a file that has a list of jobfile names to delete. If specifying a single file, the name of the file must immediately follow -J. If specifying a file that has a list of jobfile names, precede the file name with -f (see the -f <input_filename> parameter). In the file containing the list: Each jobfile name must be the first field in the line. Specify only one jobfile name on each line. Spaces delimit the fields in a line. Note: To obtain a list of all jobs in the TARA server repository, use tarajobquery -L. Then, copy those jobfiles to be deleted into a file for TARAJobRM. This parameter, or the -J <jobfile_name> parameter, is required. No This parameter, or the -S <script_name> parameter, is required. -s <TARAServer_name> This option is not required if the TARA server resides on the same BAR server where this utility is launched. Otherwise, the TARAServer_name value is the name of the BAR server running TARAServer. No -v Specifies the verbosity of the utility after parameter validation. The range is 0 to 3. -F For a TARA JobFile only. Forces removal of the JobFile even if there is a valid image in the Tivoli image catalog. No 1 No When a single job or script is deleted, the deletion occurs after parameter validation, without verification of the file to be deleted. In contrast, when multiple scripts or jobs are deleted, the user is prompted by the following line: X files will be deleted. Is this correct? (y,n) Notice: Verify that X is the correct number of jobs or scripts. After the jobs or scripts are deleted, they cannot be recovered. 16 lists TARAJobRM return codes. 132 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

133 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM 16: TARAJobRM Return Codes Return Code Description Return codes designate errors that can occur during a jobfile or script removal. 101 Unable to connect to the TARA server. 102 Network failure sending the file remove request to the TARA server. 103 Network failure receiving the file remove response from the TARA server. 104 Cannot open the Job list or Script list file. 105 Cannot read the Job list or Script list file. 106 The Job list or Script list file contains an unrecognizable line. 110 Cannot read the "y" or "n" response to the file verification message. 111 Job terminated. User answered "n" to the file verification message. Return codes designate parameter validation errors. 700 Incorrect number of parameters entered. 701 The parameter value is greater than the maximum size of 255 characters. 702 A parameter value is not preceded by a parameter key (-s, -S, -J, -f, or -v). 703 Unknown parameter key (not a -s, -S, -J, -f or -v). 705 The -J parameter key is specified twice. 706 The -J parameter key is specified, but no value or -f <filename> is specified. 707 The -J parameter key is specified with a value, but the value is not 16 characters in length. 709 The -s parameter key is specified twice. 710 The -s parameter key does not have a TARA server value following it. 711 The -s parameter key is specified with a value, but the value is greater than 100 characters in length. 713 The -S parameter key is specified twice. 714 The -S parameter key is specified, but no value or -f <filename> is specified. 715 The -S parameter key is specified with a value, but the value is greater than 255 characters in length. 738 The -f parameter key is specified twice. 739 The -f parameter key does not have a filename value following it. 740 The value associated with the -f parameter key is greater than 255 characters in length. 743 The -v parameter key is specified twice. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

134 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 16: TARAJobRM Return Codes (continued) Return Code Description 744 The -v parameter key must be followed by a value of 0, 1, 2 or Either the -S (script) or -J (Jobfile) parameter is required. 750 Both the -S and -J parameters are found. Only one can be specified. 751 The -f parameter is specified, but neither the -S or -J parameters, one of which is required, is found. 753 Invalid level specified for -v (0, 1, 2 or 3). TARALaunch TARALaunch is a stand-alone, command-line utility that allows you to run a TARA script without having to use the Teradata TARA GUI. You can also use TARALaunch as a commandline utility to send an abort request to the TARA server for an active TARA job. The launch option and the abort option are two separate uses of the utility and cannot be used in the same instance. Guidelines and Parameters for Launching Scripts The script that TARALaunch runs must already exist and be stored in the Script Repository (SR directory) on a TARA server host. Only one script can be launched for execution at a time. TARALaunch -u -p -j [-s -v -P -w] -j <jobname> - (required) -u <username> - (required) -p <password> - (required) OR -e <path to encoded password file> - (required) -s <TARA servername> - (optional) -P <port> - (optional) -v <verbose level: > - (optional) -w <seconds-to-wait> - (optional) If a seconds value is not specified, the job will wait indefinitely until the TARA job completes. If a value is specified, this job will wait until the TARA job completes or the specified number of seconds has elapsed. Parameters for Aborting Jobs TARALaunch -u -p -a [-b -s -v] -a <jobid> - (required) -b - (optional) -u <username> - (required) -p <password> - (required) OR -e <path to encoded password file> - (required) 134 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

135 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch -s <TARA servername> - (optional) -v <verbose level: > - (optional) TARALaunch Parameters 17 describes TARALaunch parameters, and indicates if the parameter is required. TARALaunch parameter indicators are case sensitive, therefore use the correct case when specifying parameters. Each parameter can only be specified once in the command-line. 17: Parameters for TARALaunch Parameter Description Required -a <jobid> Specifies the 16-character TARA job identification name. For this parameter, use the job ID that is generated when TARALaunch has launched a job or TARAJobQuery is used with the -L option. Yes (abort option only) -b Specifies batch mode, which suppresses interactive messages. No (optional for abort option only) -j <jobname> Specifies the Job Name of the job to be launched for execution. The jobname value must match the name of an existing job in the Script Repository on the specified TARA server host. When specifying the jobname value, do not include a path qualifier, spaces, or any of the following characters: < > ~ *,?. \ / Example -j MyBackupJob Note: Scripts that are created or modified manually are not checked to see if the name contains spaces or characters. If the job name contains embedded spaces, enclose the entire name in double quotes. Special characters, other than the characters listed above, are allowed. Example -j "My Backup Job" Yes (job launch option only) Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

136 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 17: Parameters for TARALaunch (continued) Parameter Description Required -u <User Name> Specifies the User Name that the utility uses to connect to the TARA Server. Currently the user names allowed are administrator and user. The user just has the read-only privilege. Example TARALaunch -u administrator -p <password> Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARALaunch -u administrator -p xjmt94rs Yes Yes -e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name. Example TARALaunch -u administrator -e C:\Teradata\tara.pwd Note: The file containing the encoded password is created during the postinstall of the TARA Server, and is located in the TARA server bin directory: \Teradata\TARA\server\bin). The name of the file is tara.pwd. If the utility is running on a machine different from the TARA server, tara.pwd can be copied to the machine, and the path to the file containing the encoded password can be specified. If you need to recreate a file with the encoded password, run the TARALogonGen executable located in the TARA server bin directory: \Teradata\TARA\server\bin. Enter the password and the tool creates a tara.pwd. This file contains the encoded password. Yes -P <port> Specifies the port number that the TARA server is running on. The default port is If the TARA Server port is changed to a different number, this option has to be specified with the correct TARA Server port number. Example TaraLaunch -u administrator -p xflu74rs -j MyBackupJob -P No 136 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

137 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 17: Parameters for TARALaunch (continued) Parameter Description Required -s <TARA servername> Specifies the TARA server host where the job to be launched is stored. The TARA servername value can be a host name (for example, taraserver1 or localhost) or an IP address of a host (for example, ). The launched job will be run on the specified TARA server host. Example -s taraserver1 Example -s localhost Example -s The default is localhost. No -v <verbose level: > Specifies the level of debug information to display. There are four valid debug levels (0, 1, 2, and 3), with higher values providing more extensive debug information. More extensive information is typically only useful for utility developers when gathering information about a reported problem. Level 0 suppresses most debug information, with the exception of some parameter validation errors. This is useful when TARALaunch is used in a batch file (Windows) or shell script (Linux). In this case, the batch file checks the %errorlevel% (Windows) or $? (Linux) to obtain the return code of TARALaunch. Refer to 18 on page 138 for these return values. Level 1 is the default level if the -v option is not specified. This level displays a successful launch message or any error message that prevented the job launch, plus any errors that occurred during monitoring (when the -w option is used). Level 2 provides more detail in launching the job. It can be very useful when using TARALaunch interactively with the -w option. In this case, the TARA ARC job States and their associated elapsed time in seconds are displayed until the TARA job ends or the maximum wait time is exceeded. Some States might not be displayed if they transition to another State within 30 seconds. Level 3 is typically only useful for utility developers when gathering information about a reported problem. Example -v 3 Specifying 3 results in the highest level of debug information. Example -v 2 Specifying 2 results in state process level information. If this parameter is not specified, level 1 is used. The default is level 1. No Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

138 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 17: Parameters for TARALaunch (continued) Parameter Description Required -w <seconds-to-wait> Enables the Wait-for-Completion option. If enabled, TARALaunch remains active until the TARA job it launched terminates. At that point, TARALaunch exits with the return value set to the severity code of the ARC job (0, 4, 8, 12, 16). If an external error occurs (for example, a network error), the return code represents the type of error. 18 documents all return codes. If the -w option is specified without a seconds-to-wait value, TARALaunch waits indefinitely for the TARA job to terminate. If a seconds-to-wait value is specified, TARALaunch waits for that period of time. If the seconds-to-wait value is exceeded, TARALaunch exits with a return code set to 126. The exit of TARALaunch in this situation does not affect the active TARA job. No (optional for launch option only) TARALaunch Return Codes 18 lists TARALaunch return codes. 18: TARALaunch Return Codes Code Number Description Return codes 0-16 indicate that the TARA job launched successfully and represent the severity code that is returned by the single-stream or multi-stream TARA job. 0 Successful ARC job termination 4 ARC job completed with warnings 8 ARC job completed with non-fatal errors 12 ARC job terminated with fatal errors 16 Internal ARC failure Return codes 100 through 119 are parameter validation errors. The TARA job is not launched in all cases. 101 Incorrect number of parameters given to TARALaunch. 102 Missing parameter (-j -s -v -w) and value is greater than 256 characters. 103 Parameters (-j -s -v -w) must begin with a hyphen. 104 The parameter value is more than one word. 105 The -j parameter is specified more than once. 106 The initial parameter is -j and is not followed by a value. 107 The -j value is longer than 255 characters. 108 The -j parameter is not followed by a value. 109 The -s parameter is specified more than once. 138 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

139 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 18: TARALaunch Return Codes (continued) Code Number Description 110 The initial parameter is -s and is not followed by a value. 111 The -s value is longer than 100 characters. 112 The -s parameter is not followed by a value. 113 The -v parameter is specified more than once. 114 The -v parameter is not followed by a value. 115 The -v value is too long. 116 The initial parameter is -v and is not followed by a value. 117 The -v value must be 1 character. 118 The -w value must be a non-zero decimal number. 119 The parameter is not -j, -s, -v or -w Return codes indicate that the TARA job was successfully launched with the Wait-for- Completion option, but TARALaunch could not continue monitoring the TARA job. 126 The seconds-to-wait time expired during the wait-for-job-completion monitoring. 127 Network error terminated the TARALaunch connection to the TARA server during the wait-for-job-completion monitoring. Return codes indicate that TARALaunch was unsuccessful in attempting to launch the TARA job. 201 TARALaunch could not make the initial connection to the TARA server. 202 Network error terminated the initial send to the TARA server. 203 Network error terminated the initial receive from the TARA server. 204 TARA server rejected the request. 205 Network error during job launch request transmission. 206 Network error waiting for response of job launch request. Sample Lines of Code taralaunch -u administrator -p fqn6t4rs -j MyBackupJob -s localhost -v 3 taralaunch -u administrator -p fqn6t4rs -j "My Backup Job" -s taralaunch -u administrator -p fqn6t4rs -j MyBackupJob Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

140 Chapter 6: Teradata TARA Command-Line Utilities taraping Output Unless the verbosity is increased by the "-v option", TARALaunch will only display two messages. The first message displays the TARA Job Identifier (JobID) assigned to the job. The second message displays the success or failure of the launch process. For example: C:\Documents and Settings\Administrator>taralaunch -j Inventory_weekly.arc -u administrator -e encrypted.pwd JobID 4b033b returned in launch Job 'Inventory_weekly.arc' was successfully launched on TARA Server ' ' C:\Documents and Settings\Administrator> A by-product of the launched job is the Job Information file that is stored in the Job Repository (JIR directory) on the TARA server host. To view the output from the launched job, use the Teradata TARA GUI or the TARAJobQuery command-line utility. taraping The taraping command line utility tests TARA server health by testing TARA server connectibility interactively or in a script. Testing is performed externally from the TARA clients. The taraping parameter indicators are case sensitive, therefore use the correct case when specifying parameters. Also, specify each parameter only once in the command-line: /opt/teradata/tara/tivbar/taraping [-s -p -v] -s <TARA servername> - [Optional] -p <port> - [Optional] -v <verbose level: 1 2 3> - [Optional] 19 describes taraping parameters. 140 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

141 Chapter 6: Teradata TARA Command-Line Utilities taraping 19: Taraping Parameters Parameter Description Required -s <TARA servername> Specifies the TARA server host. The TARA servername value can be a host name (for example, taraserver1 or localhost) or an IP address of a host (for example, ). No Example -s localhost Example -s TARA server name defaults are: localhost p <port> Specifies the port number that the TARA server is running on. If the TARA server port is changed to a different number, this option has to be specified with the correct TARA Server port number. No The default is v <verbose level: 1 2 3> Specifies the level of debug information to display. There are three valid debug levels (1, 2, and 3), with higher values providing more extensive debug information. More extensive information is typically only useful for utility developers when gathering information about a reported problem. No The verbose level default is 1, which generates no display unless the test fails. 20 describes taraping return codes. 20: taraping Return Codes Return Code Description 0 Successful 255 (-1) Failed Sample Lines of Code # /opt/teradata/tara/tivbar/bin/taraping Unable to connect to TARA server ' '. # echo $? 255 # # /opt/teradata/tara/tivbar/bin/taraping -p Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

142 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg # echo $? 0 # # /opt/teradata/tara/tivbar/bin/taraping -s bsrv20 -p v 2 Connecting to the socket on TARA Server 'bsrv20' Send to TARA Server. Close connection. Close returned 0. Test successful. # echo $? 0 # TARASetCfg The TARASetCfg utility allows the explicit request that a TARA server reset its configuration parameters by re-reading the defaults configuration file. Under normal conditions, a TARA server updates its configuration parameters only when it is first brought up, or restarted. However, there are scenarios when you might want to modify the configuration parameters in the TARA server's default configuration file, defaults, while the server is still running. TARASetCfg sends a message to the TARA server instructing it to immediately re-read the defaults configuration file and reset its configuration information. This avoids having to restart the TARA server. Run the TARASetCfg utility by using the following job specification. The command-line parameter indicators are case-sensitive, therefore use the correct case when specifying the individual parameters. Specify each parameter only once in the command line. TARASetCfg -u -p [-s -P -v] -u <username to logon to TARA server> - (required) -p <password to logon to TARA server> - (required) OR -e <path to encoded password file> - (required) -s <TARA servername> - [Optional] -P <port> - [Optional] -v <verbose level: 1 2 3> - [Optional] 21 describes TARASetCfg parameters, and indicates if the parameter is required. 142 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

143 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg 21: Parameters for TARASetCfg Parameter Description Required Default -u <User Name> Specifies the User Name that the utility uses to connect to the TARA Server. Currently the user names allowed are administrator and user. The user has the read-only privilege only. Example TARASetCfg -u administrator -p <password> Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARASetCfg -u adminstrator -p xjmt94rs Yes Yes Not Applicable Not Applicable -e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name. Yes Not Applicable Example TARASetCfg -u administrator -e C:\Teradata\tara.pwd Note: The file containing the encoded password is created during the post-install of the TARA Server, and is located in the TARA server bin directory: \Teradata\TARA\server\bin). The name of the file is tara.pwd. If the utility is running on a machine different from the TARA server, tara.pwd can be copied to the machine, and the path to the file containing the encoded password can be specified. If you need to recreate a file with the encoded password, run the TARALogonGen executable located in the TARA server bin directory: \Teradata\TARA\server\bin. Enter the password and the tool creates a tara.pwd. This file contains the encoded password. -s <TARA servername> Specifies the TARA server host whose configuration information you want to reset. The TARA servername value can be a host name (for example, taraserver1 or localhost) or an IP address of a host (for example, ). Example -s taraserver1 Example -s localhost Example -s No localhost Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

144 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg 21: Parameters for TARASetCfg (continued) Parameter Description Required Default -P <port> Specifies the port number that the TARA server is running on. The default port is If the TARA Server port is changed to a different number, this option has to be specified with the correct TARA Server port number. Example TaraSetCfg -u administrator -p xflu74rs -j MyBackupJob -P No v <verbose level: 1 2 3> Specifies the level of debug information to display. There are three valid debug levels: 1, 2, and 3. Higher values provides more extensive debug information. This information is typically only useful for utility developers when gathering information about a reported problem. Example -v 3 results in the highest level of debug information The parameters can be specified in any order. No If this parameter is not specified, debug information will not appear. Sample Lines of Code tarasetcfg -u administrator -p xjmt94rs tarasetcfg -u administrator -p xjmt94rs -s localhost tarasetcfg -u administrator -p xjmt94rs -s tarasetcfg -u administrator -p xjmt94rs -v 1 tarasetcfg -u administrator -p xjmt94rs -s localhost -v 2 tarasetcfg -u administrator -p xjmt94rs -s v 3 Output TARASetCfg does not produce any output other than a message that the operation was a success or failure. To verify that the configuration information has been updated, open the Teradata TARA GUI s TARA Server Configuration dialog box and view the information under the various tabs. 144 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

145 CHAPTER 7 Teradata TARA Troubleshooting The following topics describe the TARA troubleshooting utility and support information for Teradata Customer Support: Troubleshoot Utility Creating a Diagnostic Bundle for Support TARA Support Bundle The following topics discuss errors associated with Teradata Extension for Tivoli Storage Manager: Overview of Error Messages Teradata Extension for Tivoli Storage Manager Debug Log TARA Server Audit Log ARCMAIN Outlog TSM Log Messages Error Conditions and Recovery Data Connector Error Messages Vendor-Independent Error Messages TSM Error Messages Failure 8205 Error Message For troubleshooting information on Teradata TARA components, see: TARA Server Repositories Backup Client and Server System Health Backup Jobs with the Same Name TARA Server Stop and Restart Command Line for Obtaining Information Teradata TARA GUI on Java Runtime Extension States for Archive Jobs Job Stream Connection Failure Unresponsive TARA Server Recovery to a Different TARA Server Restoring Data for Disaster Recovery Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

146 Chapter 7: Teradata TARA Troubleshooting Troubleshoot Utility Troubleshoot Utility The troubleshoot utility provides problem and remedy details for any ARC or Teradata Extension for Tivoli Storage Manager errors for TARA jobs. To use the troubleshoot utility 1 From the Teradata Tiered Archive/Restore Architecture screen, click Help>Troubleshoot. The Troubleshoot screen appears. 2 Enter the Error Code. 146 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

147 Chapter 7: Teradata TARA Troubleshooting Creating a Diagnostic Bundle for Support 3 Click Search. The description, problem, and remedy appear. Note: The error code can be an ARC or Teradata Extension for Tivoli Storage Manager (BAM) error. For example, it can be ARC0001 or BAM0001. Creating a Diagnostic Bundle for Support For situations such as job failure, job hanging, or other issues that require an incident report, Teradata includes command-line, interactive scripts to collect necessary job and system information. The resulting diagnostic bundle is sent to Teradata Customer Support so they can provide optimum analysis and resolution. Customer support is available around-theclock, seven days a week through the Global Technical Support Center (GSC). To learn more, go to 1 Locate the script at /opt/teradata/tara/support/bin. 2 Run supportbundle.sh to create a diagnostic bundle on the TARA server. Result: After the script collects the data, a bundle named tarasupportbundle_$date.zip is created in /var/opt/teradata/supportbundle and submitted to Teradata Customer Support. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

148 Chapter 7: Teradata TARA Troubleshooting TARA Support Bundle 3 [Optional] Contact Teradata Customer Support to let them know the diagnostic bundle is ready for review. TARA Support Bundle The TARA Support Bundle gathers log files and server information for Teradata Customer Support troubleshooting purposes. The TARA Support Bundle script produces a.zip output file, which Teradata GSC personnel manually runs. Alternately, GSC instructs the customer to run the script, then forward the.zip output file to the GSC. The script gathers local information that is specific to each server. If there are multiple Teradata Managed Servers for BAR in the environment, GSC can request a.zip file from each server. Script, Log, and.zip File Names and Location 22: Script, Log, and.zip File Names and Location File Type Location Description Executable script /opt/teradata/tara/support/bin/supportbundle.sh Script that GSC runs to gather log files and server information. Log file /opt/teradata/tara/support/bin/logfile Log file that results when the executable script is run. Support bundle.zip file /var/opt/teradata/tara/ supportbundle_mm_dd_yyyy.zip Support bundle.zip file that results when the executable script is run. An example of the file name is supportbundle_04_02_2013.zip Support Bundle Information The following table lists TARA Support Bundle information, including log files, software package version numbers, and hardware information. 23: Support Bundle Information Destination /var/opt/teradata/tara/supportbundle/config /var/opt/teradata/tara/supportbundle/baruser /var/opt/teradata/tara/supportbundle/coredump /var/opt/teradata/tara/supportbundle/jir /var/opt/teradata/tara/supportbundle/sr Source /var/opt/teradata/tara/server/config /home/baruser Contains the last 7 days of all files, including modified.out files. Core dump files from /var/opt/teradata/core-name Only taraserver core dump files are included. /var/opt/teradata/tara/server/jir Contains files modified within the last 7 days. /var/opt/teradata/tara/server/sr 148 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

149 Chapter 7: Teradata TARA Troubleshooting Overview of Error Messages 23: Support Bundle Information (continued) Destination Source /var/opt/teradata/tara/supportbundle/logs /etc/opt/teradata/tara/defaults /var/log/messages output file /var/opt/teradata/tara/server/logs/logfile output file /var/opt/teradata/tara/supportbundle/os ifconfig output file The ifconfig file is the output file for server IP addresses. netstat port status output file lspci output file QLogic port status and HBA information output file isscsi output file /etc/hosts file output /var/opt/teradata/tara/supportbundle/versions /opt/teradata/tara/gui/bin/config (TARA version installed) /usr/openv/netbackup/bin/version (Tivoli Storage Manager version installed) /etc/suse-release (SLES version installed) TTU installed packages and versions of: bteq cliv2 piom sqlpp tdicu teradata_arc TeraGSS Overview of Error Messages If errors occur with Teradata Extension for Tivoli Storage Manager during a Teradata backup, the extension and TSM generate debug logs that can be used for troubleshooting. Error messages reported by Teradata Extension for Tivoli Storage Manager can originate from several software components. Determining the root cause of an error depends on the application that reports the problem. 24 lists different types of messages that can occur. 24: Types of Messages Type of Message Description Reference Information ARCnnnn messages BAMnnnn messages These messages are generated by ARCMAIN client code. These messages are generated by Teradata Extension for Tivoli Storage Manager. None Data Connector Error Messages on page 155 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

150 Chapter 7: Teradata TARA Troubleshooting Teradata Extension for Tivoli Storage Manager Debug Log 24: Types of Messages (continued) Type of Message Description Reference Information ANSnnnn messages These are TSM client messages. Refer to the version of IBM s Tivoli Storage Manager Messages that correlates to the version of TSM being used. ANRnnnn messages These are TSM server messages. Refer to the version of IBM s Tivoli Storage Manager Messages that correlates to the version of TSM being used. Messages with error numbers that range from - 50 to +50 Messages with error numbers that range from 1 to 50 Error messages in the form of "*** Failure nnnn:..." These error messages are associated with Teradata Extension for Tivoli Storage Manager or TSM. These ARCMAIN errors are associated with the Data Connector component. These are ARCMAIN errors that most likely originate with the Teradata Database. Refer to the version of IBM s Tivoli Storage Manager Messages that correlates to the version of TSM being used. Data Connector Error Messages on page 155 Messages Note: Some error codes have multiple error messages, which are listed in the bullet lists in the Error Message Text column. Teradata Extension for Tivoli Storage Manager Debug Log Teradata Extension for Tivoli Storage Manager automatically writes diagnostic tracing information to a debug log file. Control the name and location of this log file and the level of tracing using the environment variables BARAMLOG and BARAMLOGLEVEL.For more information on these variables, see Environment Variables on page 193. By default, the debug log file is called baram_log.txt and is located in the current working directory where ARCMAIN runs. Diagnostic tracing in the debug log is available at the levels shown in : Log File Levels Level Description 1 Defaults to 1 if a log level is not specified. Tracing at this level logs major events, such as opening/closing a file or shutdown. At shutdown, a summary report of I/O counts and number of bytes reads/writes from/to each file displayed. 2 Displays call trace information at the BAR_Session level for most functions, except the calls to read/write individual data blocks. 150 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

151 Chapter 7: Teradata TARA Troubleshooting TARA Server and TARA Client Log Files 25: Log File Levels Level Description 3 Logs TSM API function calls and includes more descriptive information about each read/write operation. 4 Includes information at trace level 3, in addition to memory buffer information. 5 Includes information at trace level 4, and Data Connector function codes and returns. TARA Server and TARA Client Log Files The TARA server log file location and name is /var/opt/teradata/tara/server/logs/logfile for Linux and <INSTALL_PATH>\Teradata\TARA\server\logs\logfile for Windows. Each TARA client has its own log file. The name of the file is TaraDLogFile.txt and the location is the BAR user home directory of each TARA client. When the TARA server is restarted, the existing logfile is renamed to logfile.prev before opening a new logfile. When a TARA client is restarted, the existing logfile is renamed TaraDLogFile.txt.prev before opening a new TaraDLogFile.txt. TARA Server Audit Log The TARA Server audit log tracks the following TARA Server configuration changes: Job file deletion Job script creation Job script deletion TARA job launch The following information is recorded for the tracked events: Date and time of the event Details of the event IP address of the workstation initiating the event The audit log is located at /var/opt/teradata/tara/server/logs/auditlog. To enable the audit log, check the audit log box in the Logging tab of theteradata Tiered Archive/Restore Architecture>Settings>Server Configuration dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

152 Chapter 7: Teradata TARA Troubleshooting ARCMAIN Outlog ARCMAIN Outlog Always evaluate ARCMAIN output to ensure that each job runs successfully; all error messages (including the error code and message text) are displayed in the ARCMAIN outlog. Teradata Extension for Tivoli Storage Manager returns an error code and message text for ARCMAIN to output to its various log files. The message text and any additional debug information is also written to the debug log of Teradata Extension for Tivoli Storage Manager. TSM Log Messages The error codes in the 1200 to 1299 range originate in TSM, which logs diagnostic information in these log files: TSM Server Activity Log TSM Client Log TSM Server Activity Log Teradata Extension for Tivoli Storage Manager generates Teradata-specific messages in the TSM server activity log every time it opens and closes a backup file. These messages are strings that include TDB0nnn, where nnn is the message ID. The next example includes a command, plus the report it generates, of Teradata Extension for Tivoli Storage Manager messages that are associated with opening a Teradata backup file in WRITE mode: Query actlog search=tdb0002 Date/Time 06/23/ :41:54 06/23/ :56:17 06/23/ :56:44 06/23/ :57:12 Message ANE4991I (Session: 4901, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata, DSN-DATA0001 Generation=3 in write mode ANE4991I (Session: 4903, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata, DSN-DATA0002 Generation=4 in write mode ANE 4991I (Session: 4905, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata, DSN=DATA0001\Long_Path$#.DATA Generation=1 in write mode ANE4991I (Session: 4906, Node: MERLOT) Teradata TDB0002 System merlot Opening Teradata backup NS=Teradata, DSN=DATA0001.DSN Generation=1 in write mode 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. 152 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

153 Chapter 7: Teradata TARA Troubleshooting Error Conditions and Recovery TSM Client Log 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. Errors and abnormal conditions on the TSM client node are written to a client log file, typically named DSIERROR.LOG. The location of this file is controlled at runtime by the DSMI_LOG environment variable or is written to the local directory. The TSM client log file always opens in APPEND mode, therefore verify activity by checking the date/time stamp on all messages. View these log files in any text editor, such as Notepad. Error Conditions and Recovery The error messages that are displayed during ARCMAIN operations can originate from various software components. The error conditions shown in 26 can occur while starting Teradata Extension for Tivoli Storage Manager or while backing up data. Use this information to ensure that the installation process is successfully completed and that all recovery options are considered. 26: Error Conditions and Recovery Options Error Condition An invalid option was found during option parsing ANSnnnn or ANRnnnn TSM errors Possible Recovery Option This is a dsmsetup error. The installation process attempted to read Windows registry settings to determine the paths to TSM. However, there was an invalid option found during option parsing, probably due to an invalid option specification in the TSM Client Options file. Refer to the DSIERROR.LOG file and determine which line of the options file is invalid. The path to this file is set with the DSMI_LOG environment variable or the path defaults to the local directory. For more information about TSM Client Options, refer to IBM s Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User s Guide. Teradata Extension for Tivoli Storage Manager attempts to gather as much information as it can about the root cause of errors. Query the TSM server activity log for device errors or other messages that did not get conveyed to the client process. For information on the TSM server activity log, refer to TSM Server Activity Log on page 152. Alternately, check for DSIERROR.LOG file error messages on the client. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

154 Chapter 7: Teradata TARA Troubleshooting Error Conditions and Recovery 26: Error Conditions and Recovery Options (continued) Error Condition dsminitex -- Session rejected Errors that include a traceback Possible Recovery Option This is an open session error from Teradata Extension for Tivoli Storage Manager, related to opening a TSM server connection. This is an authentication error, the most common source of open session errors. An invalid NODENAME or PASSWORD is defined in the TSM Client Options file. For more information about how settings need to match what is defined for the TSM server, see Configure TSM for Teradata Backups on page 47. Teradata Extension for Tivoli Storage Manager maintains an internal trace buffer that is dumped to stderr output when exceptional conditions occur, such as memory access or illegal instruction. This type of diagnostic output is a problem that can only be corrected by the Teradata Development organization, therefore: 1 Capture a complete output listing. For information about generating diagnostic traces, see Environment Variables on page 193 for details about the BARAMLOG and BARAMLOGLEVEL environment variables. These variables control the diagnostic tracing for Teradata Extension for Tivoli Storage Manager. 2 After collecting the trace information, contact Teradata Customer Support. File locking contention can occur when two jobs attempt to write to the same log file at the same time. Hung up on a tape mount Hung up on a Teradata Database lock Options file * not found The file cannot be found or is improperly formatted tivarc (tivadm) is not recognized as an internal or external command, operable program or batch file 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 152. Consult the Teradata QUERYSESSION and SHOWLOCKS console utilities for help. This is a dsmsetup error. The installation process attempted to read Windows registry settings to determine paths to TSM. However, the TSM Client Options file was not found. One or more of the DSMI environment variables are not properly set. Edit runarctiv.bat and: tarativadm.bat in Windows tarativadm.sh in Linux Locate the file and correct the format. The installation process should have created a TDBAR configuration file directory (which is usually C:\Program Files\Teradata\Teradata Client\TDBAR). The TIVARC.BAT file starts ARCMAIN with the sample ARCDFLT.TXT file as the ARCMAIN default command line option file. The %PATH% is wrong. The environment variable for %PATH% does not include the location of the TIVARC.BAT, ARCMAIN.EXE, and TIVBAR.DLL files. Usually this location is C:\Program Files\Teradata\Teradata Client\BIN. 154 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

155 Chapter 7: Teradata TARA Troubleshooting Data Connector Error Messages 26: Error Conditions and Recovery Options (continued) Error Condition Unable to see backups in storage using TDDSMC Possible Recovery Option If the ARCMAIN process seems to be error-free, but verifying that the storage object was created on the TSM server is not possible, check the following: Is the TCPSERVERADDRESS field of the TSM Client Options file indicating the correct IP address? In other words, is Teradata Extension for Tivoli Storage Manager connected to the proper TSM server? Are you querying the TSM server for the correct node name? To see what node name was used to create the backup, execute the following command from the TSM Server Administrative Console: query activitylog search=tdb0002 Is the DATASETNAME pattern correctly entered? (TSM is case-sensitive.) The QUERY TSM command from the taratddsmc utility might provide additional information. Data Connector Error Messages The error messages shown in 27 correspond to Data Connector error codes that range from 0 to : Data Connector Error Codes Error Code Error Message Text Description and Remedy BAM0011 Access Module called by < > when expecting < > Teradata Extension for Tivoli Storage Manager is being called by a program other than ARCMAIN, but the extension can only be used for Teradata backup and restore. Remedy: Correct the software configuration and rerun the job. To determine the correct software version for the environment, refer to the release letter documentation or contact Teradata Customer Support. BAM0013 Invalid open mode < > requested Teradata Extension for Tivoli Storage Manager is being asked to open a file in an invalid mode. This error might indicate a software version incompatibility between Teradata Extension for Tivoli Storage Manager and the Data Connector. More likely, the error is related to some type of software corruption. Remedy: Contact Teradata Customer Support. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

156 Chapter 7: Teradata TARA Troubleshooting Data Connector Error Messages 27: Data Connector Error Codes (continued) Error Code Error Message Text Description and Remedy BAM0018 Expected Data Connector Version (< > < >) but actually got (< > < >) The Data Connector version is incompatible with Teradata Extension for Tivoli Storage Manager. The Data Connector corresponds to the libpm.dll component on Windows and the libpm.so component on a UNIX system. Verify that the correct component is being loaded and the correct installation path is being used. Remedy: Correct the software configuration and rerun the job. To determine the correct software version for the environment, refer to the release letter documentation or contact Teradata Customer Support. 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 contains a syntax error. This error message can result from a number of causes, all related to the user-entered command syntax. Remedy: Correct the error and resubmit the job. BAM0024 Unsupported function code < > Teradata Extension for Tivoli Storage Manager is incompatible with the calling program. The extension can only be used for Teradata backup and restore. Your version of ARCMAIN software might be incompatible with the Teradata Extension for Tivoli Storage Manager software. Remedy: Correct the software configuration and rerun the job. To determine the correct software version for the environment, refer to the release letter documentation or contact Teradata Customer Support. 156 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

157 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 27: Data Connector Error Codes (continued) Error Code Error Message Text Description and Remedy BAM0033 < > Access Module currently does not support the < > file attribute < > Access Module currently does not support the < > function for < > file attribute Teradata Extension for Tivoli Storage Manager is incompatible with the calling program. Teradata Extension for Tivoli Storage Manager can only be used for Teradata backup and restore. This error suggests that a version of ARCMAIN software is being used that is not compatible with the extension s software level. Remedy: Correct the software configuration and rerun the job. To determine the correct software version for the environment, refer to the release letter documentation or contact Teradata Customer Support. Vendor-Independent Error Messages The error messages shown in 28 originate in the vendor-independent portions of Teradata Extension for Tivoli Storage Manager. These error codes range from 1000 to Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

158 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages Error Code Error Message Text Description and Remedy 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-ofdata Invalid length < > passed for allocating temporary buffer Invalid length was returned from a call to dsmgetnextqobject An internal software error is detected. These messages correspond to BAR internal error codes. They indicate a severe, unexpected, or exceptional condition that can only be corrected by the Teradata Development organization, therefore: 1 Capture a complete output listing and all supporting text. 2 Contact Teradata Customer Support. Remedy: Contact a field engineer or Teradata Customer Support. 158 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

159 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1001 NULL target buffer passed to esprintf routine Invalid message id < > passed to esprintf routine No message text stored for message id < > Call to esprintf routine exceeded < > number of inserts Invalid message id < > passed to escode routine The core error reporting routines cannot do their work. An internal software error/corruption is detected. Other error conditions might be hidden behind this error. Remedy: Contact a field engineer or Teradata Customer Support. BAM1002 BAM1003 BAM1005 BAM1006 The access module expects the Tivoli password access mode to be PASSWORD PROMPT Access Module currently does not support restarts in the WRITE mode Access Module cannot open more than < > files at same time Access Module detected multiple backups for NameSpace= < >, Path= < >, Segment= < > Teradata Extension for Tivoli Storage Manager only functions in PASSWORD PROMPT mode. Remedy: Specify the PASSWORD mode as PROMPT in dsm.opt. Teradata Extension for Tivoli Storage Manager does not support restart processing when a backup file is opened in WRITE mode, which means that the extension rolls back and deletes all data written to TSM up to this point. Remedy: Do one of the following: Resubmit the job from the beginning of the current ARCMAIN step. Instead of resubmitting the job, issue a RELEASE LOCK statement on the Teradata server to remove any database locks set. More FILE= clauses are specified on the ARCMAIN backup statement than are supported by Teradata Extension for Tivoli Storage Manager. Remedy: Correct the ARCMAIN statement and resubmit the job. TSM qualified multiple backups for the indicated Namespace, Pathname, and Segmentname pattern. This is an error because a backup and restore needs to work with only one high-level name per ARCMAIN statement. The most likely reason for this error is that the Namespace or Pathname fields contain a wildcard character that qualifies multiple backup files from the TSM catalog. Test this by using the native API query tool to see what backup file names come back, making sure that you are logged on as the same user ID to the TSM server. Wildcard characters are acceptable for a low-level segment name because Teradata Extension for Tivoli Storage Manager reserves those names for its own purposes. Remedy: Correct the indicated name by removing the wildcard characters, and resubmit the job. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

160 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1007 No backup file (s) found with NameSpace= < >, Path= < >, Segment= < >, Generation= < > BAM1008 Duplicate storage objects found with NameSpace= < >, Path= < >, Segment= < >, Generation= < > No backup file matched the indicated Namespace, Pathname, Segmentname pattern, and Backup File Generation number. The Namespace field defaults to Teradata. The Pathname is set by one of the following: The DATASETNAME field on the IOPARM string The external name of the FILEDEF parameter The value assigned on the FILE= clause of the ARCMAIN restore statement Segmentname is controlled only by Teradata Extension for Tivoli Storage Manager, but is shown in case you want to include it in an administrative query. The generation number is entered as an IOPARM field or defaults to zero. Relative numbers, such as -1 and -2, count backwards from the current active backup (gen=0). Remedy: Correct the indicated name and resubmit the restore job. Teradata Extension for Tivoli Storage Manager 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 Teradata Extension for Tivoli Storage Manager has a bug. The extension relies on the generation number to distinguish between separate runs of the same backup job, so all file segments that correspond to a single backup job execution need to have the same generation number. Remedy: Verify the heritage of the pertinent storage objects and, if necessary, delete the corrupt objects or update the Object Info metadata with distinct generation numbers. Ensure that the backups are not creating new objects when the metadata is updated. If the remedy does not work, contact a field engineer or Teradata Customer Support. 160 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

161 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1009 BAM1010 Access Module currently does not support repositioning when writing to backup files SetPos generation < > does not match current file generation of < > Teradata Extension for Tivoli Storage Manager 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 Teradata Extension for Tivoli Storage Manager 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. When Teradata Extension for Tivoli Storage Manager creates a new backup file, it stores a unique generation number in the Object Info field of the storage object. This error occurs when a reposition operation detects that the position being requested is for a backup file with a different generation number from the one that is currently open. Normally, this condition indicates a corrupted position field managed by ARCMAIN. However, when using the CATALOG feature of ARCMAIN to get fast repositioning on a restore, ARCMAIN can pick up a position that is inconsistent with the backup files in storage. This condition can happen under the following circumstances: 1 Regularly running the same backup job, saving position information to the CATALOG database. 2 Creating additional backups without using the CATALOG option, so there is no position information saved. 3 Running a restore using the most recent backup image from storage. In this case, the most recent image in storage might correspond to generation 103, when the most recent backup image in the CATALOG database corresponds to generation 102. Remedy: Examine ARCMAIN listings and the storage catalog, and do one of the following: If a user error occurred, make corrections and resubmit the job. If no user error occurred, consult a field engineer or Teradata Customer Support. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

162 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1011 SetPos file segment number < > not found in retrieved list of backup segments Teradata Extension for Tivoli Storage Manager cannot find the requested file segment number when a request was made to reposition the file within the backup set. Either the position information is corrupted, or a mismatch occurred between the backup set being requested and the position information. Remedy: Contact a field engineer or Teradata Customer Support. BAM1012 < > < > error < > < > Teradata Extension for Tivoli Storage Manager detects an unexpected error when starting a function of TSM. The nature of the error is indicated in the message by naming the TSM product, the API function being called, the error code, and the error message text. This type of error can be difficult to fix. Teradata Extension for Tivoli Storage Manager is customized to work with site-specific APIs, but configuration to work with TSM and ARCMAIN can be complex. Remedy: Correct the job or configuration settings. To run Teradata Extension for Tivoli Storage Manager 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. 162 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

163 Chapter 7: Teradata TARA Troubleshooting Vendor-Independent Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1014 Invalid Segment name for NameSpace= < >, Pathname= < >, Segment= < >, CopyId= < >. Skipping. BAM1015 Unable to open diagnostic file < > because < >. Logging disabled. BAM1017 Unable to open DEFAULT file < > because < > When querying the TSM storage catalog metadata, Teradata Extension for Tivoli Storage Manager found a storage object that qualified on the name pattern, but does not follow the proper naming convention. This is not a fatal error message, but the relevant object is omitted from processing because Teradata Extension for Tivoli Storage Manager cannot properly parse the segment name. Teradata Extension for Tivoli Storage Manager 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 Teradata Customer Support. Diagnostic logging is requested, but Teradata Extension for Tivoli Storage Manager is unable to open the file. This is a non-fatal error, but no diagnostic logging is captured. The cause of the file open error is indicated. Teradata Extension for Tivoli Storage Manager opens the log file in write-append mode. Periodic purging of this file is necessary. Remedy: Correct the problem, and resubmit the job. Teradata Extension for Tivoli Storage Manager is unable to open the command line DEFAULT file. The cause of the file open error is indicated. The DEFAULT file is specified with the BARAM_DEFAULT environment variable. Remedy: Specify a valid path to a DEFAULT file that is accessible to your user ID, then resubmit the job. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

164 Chapter 7: Teradata TARA Troubleshooting TSM Error Messages 28: Vendor Independent Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1018 Access Module is aborting the backup transaction Teradata Extension for Tivoli Storage Manager was called to close the backup file in an error condition. The write transaction is aborted and all storage objects created by this job are rolled back. This is an informational message rather than a report of the root cause of an error condition. ARCMAIN indicates the cause of the error or reports that the backup process is interrupted. Remedy: Correct the root cause of the error and resubmit the job. For further information, refer the output listing to Teradata Customer Support. BAM1019 Access Module is aborting due to Insufficient Memory This error occurs when Teradata Extension for Tivoli Storage Manager 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. TSM Error Messages Error messages that range from 1200 to 1299 (shown in 29) originate in the TSM portion of Teradata Extension for Tivoli Storage Manager. Note that some of the error codes have multiple error messages. 29: TSM Error Messages Error Code Error Message Text Description and Remedy BAM1200 Access Module needs Tivoli Version < > Release < > but client library is Version < > Release < > Teradata Extension for Tivoli Storage Manager detects an invalid software library release level. The path to the loaded extension is set with the IOMODULE command line parameter to ARCMAIN. Remedy: Correct the configuration issue and resubmit the job. 164 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

165 Chapter 7: Teradata TARA Troubleshooting TSM Error Messages 29: TSM Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1201 Tivoli dsmendtxn error < >, (reason < >): < > Teradata Extension for Tivoli Storage Manager detects an unexpected error when starting a TSM End Transaction function. The error code, reason code, and error message text indicate the nature of the error. Reason codes usually correspond to numbers 1 through 50 of the API return codes. For more information on the API return codes, see IBM s TSM Messages manual. If this error occurs when writing backup files to the TSM, Teradata Extension for Tivoli Storage Manager 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 Teradata Extension for Tivoli Storage Manager with an option that is not recognized on the IOPARM of the ARCMAIN job, configure the TSM runtime environment to set the option as a default configuration option. If you do not resubmit the job, issue a RELEASE LOCK statement on the Teradata Database to remove any database locks set, then clean up the Teradata server. BAM1202 Tivoli Backup Copy Group does not exist for object FileSpace= < >, HighLevel= < >, LowLevel= < > TSM is unable to assign a copy group for the backup object being created. This situation is the result of an API dsmbindmc call. The object name is listed as FileSpace, HighLevel name, and LowLevel name. Remedy: Consult the TSM administrator to determine the source of the problem. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

166 Chapter 7: Teradata TARA Troubleshooting TSM Error Messages 29: TSM Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1203 Tivoli Storage object FileSpace= < >, HighLevel= < >, LowLevel= < >, ID= < > is not recognized by Access Module. Skipping. Teradata Extension for Tivoli Storage Manager is unable to interpret the formatted metadata, which is usually stored with the storage object. The object is skipped and processing for the object stops, although processing continues for the balance of the job. This error is usually generated because a storage object exists in TSM that has a similar name to a Teradata backup created by Teradata Extension for Tivoli Storage Manager. The specified object name in the query is picking up more than it should. This warning message does not terminate processing because Teradata Extension for Tivoli Storage Manager cannot communicate a non-fatal warning condition to ARCMAIN. As a result, the return code indicator from ARCMAIN can be zero, even though this message is displayed. Remedy: Use the indicated diagnostic information to verify the status of the storage object. If the storage object is considered for Teradata backup and restore, contact the Teradata Global Support Center. If the object is being incorrectly qualified because the wildcard specification is too general, restate the query so it is correctly limited to the storage objects created by Teradata Extension for Tivoli Storage Manager. BAM1204 TDDSMC syntax error: < > The TDDSMC utility in Teradata Extension for Tivoli Storage Manager detects a syntax error in the command. The message indicates the source of the error. Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP command or refer to Taratddsmc Help Command. BAM1205 TDDSMC syntax error: < > field width cannot exceed < > The TDDSMC utility in Teradata Extension for Tivoli Storage Manager detects a syntax error on a FORMAT string. The field width override value for the indicated substitution variable is too long. Remedy: Correct the syntax and resubmit the job. For more details, issue the HELP FORMAT command or refer to Taratddsmc Help Command. 166 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

167 Chapter 7: Teradata TARA Troubleshooting TSM Error Messages 29: TSM Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1206 Tivoli server aborted transaction during < > call. Error < >, (reason < >): < > TSMserver aborted the client transaction for the noted reason code. For more information on the API return codes, see the TSM Messages manual. Reason codes usually correspond to numbers 1 through 50 of the API return codes. If this error occurs when writing backup files to the TSM, Teradata Extension for Tivoli Storage Manager rolls back and deletes file segments written to TSM up to this point, except file segment 0 (F000). If the text of the message indicates a zero value for the reason code, issue a QUERY ACTIVITYLOG command on the TSM server to determine the root cause of the abort. Remedy: For recommendations about correcting the cause of this error, refer to the TSM documentation. Do one of the following: To run Teradata Extension for Tivoli Storage Manager 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 BAM1208 TDDSMC syntax error: Expected quote string at >> ( ) << on command line TDDSMC syntax error: No matching and quote character on command line The TDDSMC utility in Teradata Extension for Tivoli Storage Manager detects a syntax error on the command line arguments used to start the utility. This error is the result of a quote string not being found at the specified position. Remedy: Correct the syntax and resubmit the job. For more details about command line syntax, issue the HELP command or refer to Taratddsmc Help Command. The TDDSMC utility in Teradata Extension for Tivoli Storage Manager detects a syntax error on the command line arguments used to start the utility. A quote string was detected, but no matching end-quote was found. The TDDSMC utility recognizes single- and double-quote characters, but sometimes the operating system strips quotes before passing the command line to the utility. After a quote character is detected, the utility will keep scanning the command line for a matching end-quote. Remedy: Correct the syntax and resubmit the job. For more details about command line syntax, issue the HELP command or refer to Taratddsmc Help Command. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

168 Chapter 7: Teradata TARA Troubleshooting Failure 8205 Error Message 29: TSM Error Messages (continued) Error Code Error Message Text Description and Remedy BAM1209 TDDSMC syntax error: Extraneous information follows < > command starting at: < > The TDDSMC utility in Teradata Extension for Tivoli Storage Manager detects a syntax error on the command line arguments used to start the utility. A valid command was parsed, but non-blank trailing characters were detected. This error can occur when an unquoted name pattern contains embedded blanks. There are optional fields after the name pattern. Therefore, the actual source of the syntax error might be prior to the position indicated. Remedy: Correct the syntax and resubmit the job. For more details about command line syntax, issue the HELP command or refer to Taratddsmc Help Command. 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 Extension for Tivoli Storage Manager does not back up more than 4080 object segments. The maximum size of one backup job cannot exceed approximately 8 TB. Remedy: Modify backup jobs to contain less data. Failure 8205 Error Message *** Failure 8205:LSN not found in the HUT controls segment. The Failure 8205 message appears in the master stream (stream 1) ARC log because one or more child streams incurred a Teradata Database control error that aborted the ARC sessions. The ARC process of the master stream is notified by Teradata Database before the child stream can notify the master stream through the TARA server. When this error occurs on stream 1, view the child streams to find the actual cause of the problem. For those child streams that did not incur the error, "Job aborted due to error on stream x" appears in their ARC logs. Go to stream x ARC log to view the cause of the error. TARA Server Repositories Backup Backing up TARA server repositories reduces downtime in recovery of the TARA server if the server fails. Use Tivoli Storage Manager to back up the following TARA server repositories to a BAR server: /home/baruser /home/teradata /var/opt/teradata/tara/server - versions prior to TARA 14.0 /etc/opt/teradata/tara/ - TARA 14.0 and later versions 168 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

169 Chapter 7: Teradata TARA Troubleshooting Client and Server System Health Client and Server System Health A heartbeat is sent between the TARA server and TARA clients to monitor the system health of each component, then system health information is logged in the server and client logs. Client Heartbeat The TARA server records receipt of the client heartbeat in /var/opt/teradata/tara/server/logs/ logfile when the ARC Server log level is set to 62 or greater. The first line in the following example is always displayed in the log. When the log level is set to 48 or greater, the second line is recorded and is contiguous to the first line. 2012/02/13 07:58: (19400: ) <32> main: Received request from host=[ ] port=[52543] 2012/02/13 07:58: (19400: ) <02> RunRecvThread:Connection request valid type = 4001 The TARA client sends a heartbeat to the TARA server once a minute. The time interval cannot be changed. Server Heartbeat Heartbeats are not logged in the TARA client log file unless the TARA server does not respond to the client heartbeat. If the TARA server does not respond: 1 The TARA client logs the following two lines in /home/baruser/taradlogfile.txt, regardless of the log-level setting. 2012/02/14 07:14: (18250: ) <32> TaraService: Error -2, receiving command from taraserver 2012/02/14 07:14: (18250: ) <32> TaraService: Connection to taraserver lost, TCS must restart 2 The TARA client terminates. 3 The TARA client is restarted automatically: For Linux, the automatic restart occurs within five minutes. For Windows, the automatic restart occurs in one minute. Note: The taraping command-line utility can also be used to monitor TARA server health Backup Jobs with the Same Name Do not run two backup jobs with the same name at the same time. Rerunning a failed backup can result in accidentally deleting a valid restore saveset, in which case data must be manually recovered. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

170 Chapter 7: Teradata TARA Troubleshooting TARA Server Stop and Restart TARA Server Stop and Restart You can use the command line to stop and restart the TARA server. To stop and restart the TARA server 1 Type: /etc/init.d/tdtaraserver stop Wait 60 seconds. If you attempt to start the tdtaraserver script immediately after stopping the service, the operation might fail. 2 Type: /etc/init.d/tdtaraserver start Command Line for Obtaining Information Use the command line to: Query current and prior jobs launched through Teradata TARA Obtain launch times Obtain script names Type: /opt/teradata/tara/gui/bin/tarajobquery -L The output is similar to the following: File Name/Job ID Job Name Date Stream Cnt 469d frank :47: d42ff frank :33: d42ff frank :49:06 1 Teradata TARA GUI on Java Runtime Extension On Windows, the TARA GUI setup.exe installs a.jar file that allows the GUI to run under the Java Runtime Extension (JRE). The taragui.jar file is located at \Program Files\Teradata\TARA\gui\bin. On Linux, the TARA GUI.rpm package installs the taragui.jar file in /opt/teradata/tara/gui/ bin. To run the GUI, download the file to a Windows or Linux machine with JRE and double-click the file. 170 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

171 Chapter 7: Teradata TARA Troubleshooting States for Archive Jobs States for Archive Jobs When a Teradata archive job is started through Teradata TARA, the state of each cluster stream changes during the job launch process. The State column of the Teradata Tiered Archive/ Restore Architecture dialog box displays the archive job states, which are shown in 30: 30: States for Archive Jobs State Step in Job Launch Description Connecting 1 Each backup stream must connect to the MultiARC server. Logon 2 After the streams receive instructions from the ARC server, they log in their sessions to the Teradata Database. Tape Mount 3 After the ARC sessions are logged into the Teradata Database, the request for media is sent through Tivoli. Archive 4 After the media is made available by Tivoli, the archive process begins moving data to the media. In the Bytes Processed column of the Teradata Tiered Archive/Restore Architecture dialog box, the number of bytes should start increasing. Waiting 5 In a waiting state, one of the following happens: a child stream is waiting for instructions from the master stream (Stream 1) the master stream is waiting for a child stream to complete the current instruction Logoff 6 The stream is in the process of closing its ARC sessions; the job ends. Job Stream Connection Failure Symptom The job stream fails: in the TARA GUI, the job stream is shown trying to connect for some time before it fails. This occurs because of a MultiARC server time-out, and suggests that a problem has occurred before the ARC streams have connected to the MultiARC server. This symptom normally occurs after a recent installation or reconfiguration of Teradata TARA or Teradata ARC. The first step in investigating the problem is Step 1: Verify that ARC Output Files are Being Created. Step 1: Verify that ARC Output Files are Being Created On each media server, ARC output (.out) files are located in the /home/baruser account. These files are required when Teradata TARA launches Teradata ARC. If an ARC.out file with a matching timestamp of the attempted launch exists, open the ARC log and examine possible errors provided by the client utility. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

172 Chapter 7: Teradata TARA Troubleshooting TARA Job Output Errors If no ARC.out file exists, or an.out file of 0 bytes exists, Teradata ARC is not being launched properly. This indicates that Teradata TARA cannot find the ARCMAIN binary or the permission on the script that launches Teradata ARC is not correct. Go to Step 2: Examine the Script that Launches Teradata ARC. Step 2: Examine the Script that Launches Teradata ARC The script that launches Teradata ARC is called runarctiv.bat and is located in /home/baruser. The baruser account must be the owner of this file or Teradata ARC will not launch. To examine the script 1 Verify that runarctiv.bat has the proper permissions and owners assigned to it: -rwxr-xr-x 1 baruser root 2274 Jul 17 15:26 runarctiv.bat 2 Determine if runarctiv.bat can properly locate the ARCMAIN binary. The runarctiv.bat script that launches ARC (in /home/baruser) uses a variable called $INSTALLPATH. The variable is defined by executing an rpm -q command to determine where the ARC package is installed: rpm -q --queryformat '%{INSTALLPREFIX}\n' arc If the result of this command produces two outputs: (none) (none) ARC might not launch. As a result, jobs in the Teradata TARA GUI could remain in the Connecting phase, and the ARC.out file could remain a zero-length file. Workaround: Edit the /home/baruser/runarctiv.bat script and verify the path to the ARCMAIN executable is hardcoded. TARA Job Output Errors Symptom In a LAN-free environment, a system error can occur when COMMTIMEOUT is set to the default value of 60 seconds or less in dsmsta.opt (Storage Agent). The two error messages that are displayed when this occurs are: ANR0481W (Session: 207, Origin: BSRV1-AGENT) Session 288 for node AJ-BAR (Teradata) terminated - client did not respond within 60 seconds. (SESSION: 207) *** Failure ARC0805:Access Module returned error code 34: Error BAM1012: Tivoli dsmgetdata error -72: ANS1235E (RC-72) An unknown system error has occurred from which TSM cannot recover. 172 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

173 Chapter 7: Teradata TARA Troubleshooting Unresponsive TARA Server Remedy Increase COMMTIMEOUT to a larger value. For more information, refer to 9 on page 49. Unresponsive TARA Server Symptom The TARA server is not responding to job requests, although jobs have previously run successfully in the current configuration. To test if the TARA server is unresponsive, at the command line, type: Step 1: Add ulimit /opt/teradata/tara/gui/bin/tarajobquery -L If the TARA server is not responding, there is no response to the command. A successful result returns a list of the current and previous jobs that have been launched through Teradata TARA. Verify that there is no filesize statement that exceeds 2GB in value. See Configure the Log File on page 63. Another area to investigate is to look at the core files. See Step 1: Add ulimit. If the TARA server is unresponsive, add ulimit -c to the /etc/init.d/tdtaraserver script to produce core files. Doing so kills the process ID to obtain the core file: case "$1" in start) echo -n 'Starting taraserver ' ulimit -c if [ $KTYPE -eq 0 ]; then Core files are located in /opt/teradata/tara/server/config: For example: lussdgsc-bar00:/opt/teradata/tara/server/config # ls -l total 1690 drwx taraserver root 176 Aug 28 11:24. drwxr-xr-x 7 root root 168 Aug 9 15:13.. -rw taraserver users Aug 28 11:01 core rwxr-xr-x 1 taraserver root 901 Aug 13 14:57 defaults -rwxr-xr-x 1 root root 430 Aug 10 15:16 defaults_original Note: For the core ulimit setting to take effect, restart the TARA server. If core files do not provide an answer, look at the TARA server log. See Step 2: Change Verbosity of TARA Server Log. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

174 Chapter 7: Teradata TARA Troubleshooting Recovery to a Different TARA Server Step 2: Change Verbosity of TARA Server Log Change the verbosity of the TARA server log, logfile, located at /opt/teradata/tara/server/logs with the next procedure. To change the verbosity of the TARA server log Note: The TARA server does not have to be restarted before performing this procedure. 1 Start the Teradata TARA GUI. 2 Click Settings>Server Configuration>Logging. 3 Check the Override Global Log Level box. 4 Adjust the level of logging for the specific processes. 5 Click Apply, then close the dialog box. For example, when troubleshooting jobs that are launching, change the: Arc Log Setting to 48 Gui Log Setting to 48 Launch Log Setting to 63 Temporary workaround: Stop, then restart the TARA server to get the backup jobs operational in the meantime. Recovery to a Different TARA Server Run an Analyze Job Running an Analyze job enables the TARA application to recognize the backup job. A restore job is created and the archived objects are listed in the restore window of the new TARA server. To run an Analyze job: 1 Record the IOPARM and the ARCHIVE FILEDEF information from the original backup. For example: IOPARM = SERVER=barlnx1 POLICY=TD_pol1 CLIENT=barlnx1 DK_gcperf_syscal_archive_DSTREAM0001_<generation_number> 2 Using the TARA GUI, create a generic backup job. 3 In the job script: a Specify the number of job streams. The example sets MULTISTREAM to 1. b c Create a STREAM line for each stream of the original backup. Indicate the server on which the stream will run. In the following example, the stream runs on bsrv3. Using the stream image name from the stream ARC log, create a STREAMNAME line following the STREAM line. 174 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

175 Chapter 7: Teradata TARA Troubleshooting Recovery to a Different TARA Server Note: If there are multiple streams, specify all STREAMNAME lines after the STREAM lines. For example: STREAM 1 STREAM 2 STREAM 3 STREAMNAME 1 STREAMNAME 2 STREAMNAME 3 d Change the script type from Archive to Analyze. e Replace the archive script with ANALYZE ALL, VALIDATE, DISPLAY LONG. JOB DK_analyze_to_create_restore_2 SESSIONS 12 MULTISTREAM 1 STREAM bsrv3 STREAMNAME DK_gcperf_syscal_archive_DSTREAM0001_<generation_number> COMMANDLINE CSNAME=ASCII CHECKSUM=2 TDPID gcperf USERID dbc OTB Tivoli MANAGEMENTCLASS TD_b3_pol1 SCRIPT Analyze LOGON $LOGON; ANALYZE ALL, VALIDATE, DISPLAY LONG, FILE=ARCHIVE; LOGOFF; ENDSCRIPT 4 In /home/baruser/runarctiv.bat, verify that the client name is the new client name (node). Comments at the top of the following runarctiv.bat file examples specify CLIENT as the new client. off Setlocal rem For analyze only- overriding client. Comment out for normal use set ARCENVX=IOPARM='SERVER=bsrv3 CLIENT=barlnx1' Linux #!/bin/bash # For analyze only- overriding client. Comment out for normal use export ARCENVX=IOPARM='SERVER=bsrv3 CLIENT=barlnx1' TARA Restore and Copy Procedure After the Analyze job completes, the image appears in the restore window of the new TARA server. The image uses the Analyze job name. To restore: 1 Create the restore script. For example: JOB DK_Copy_syscal_mm_barrm SESSIONS 8 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

176 Chapter 7: Teradata TARA Troubleshooting Restoring Data for Disaster Recovery MULTISTREAM 1 STREAM bsrv3 COMMANDLINE CSNAME=ASCII CHECKSUM=2 TDPID gcperf USERID dbc SOURCEUID 47d994c SCRIPT Restore LOGON $LOGON; COPY DATA TABLES (mm_barrm.caldates) (FROM (SYS_CALENDAR.CALDATES)), RELEASE LOCK, FILE=ARCHIVE; LOGOFF; ENDSCRIPT 2 After the restore or copy job completes, comment out the addition to the runarctiv.bat file. Otherwise, the IOPARM specified in the script might override your archives. Restoring Data for Disaster Recovery Disaster recovery can become necessary even when steps are taken to protect Teradata Database, applications, and BAR servers from data corruption. For example, the BAR Server that contains the TARA Server Job Information Repository (JIR) might become corrupted before its scheduled backup. This can happen when several Teradata Database backups have been completed since the last backup of the TARA JIR. TARA Server Directories for Disaster Recovery To recover a corrupted TARA server: Reinstall the TARA server software Restore the required TARA directories listed in 31 31: Required TARA Directories File Path <Install Path>/tara/server /jir <Install Path>/tara/server/sr <Install Path>/tara/server/config Directory Description Job Information Repository Scripts Repository TARA Server configuration Note: <Install Path> is usually /opt/teradata or /var/opt/teradata. Other directory backups (see 32) are optional but can be useful when recovering a corrupted TARA server. 176 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

177 Chapter 7: Teradata TARA Troubleshooting Restoring Data for Disaster Recovery 32: Optional Directories File Path <Install Path>/tara/server/logs The home directory is usually /home/baruser /opt/teradata/tara/tivbar/logs Directory Description TARA Server log files baruser home directory, which contains temporary Teradata Extension for TSM working files TSM Teradata Extension log files Recovering a Backup Dataset in the TSM Repository The following list summarizes the steps to recover a backup dataset that exists in the Tivoli Storage Manager (TSM) repository, but is not in the TARA repository. Click the links for procedure details: 1 To restore the TARA server with the last directory backup 2 To compare backup datasets between the TARA and TSM repositories 3 To regenerate a single-stream TARA image 4 To regenerate a multistream TARA image The procedures assume that the TARA server is backed up regularly. To restore the TARA server with the last directory backup 1 [Optional] Reinstall the TARA server. 2 Restore the last backup of the jir, config, and sr TARA server directories. Note: If a backup of the TARA jir, config, and sr server directories does not exist, regenerate a TARA server image from the TSM Repository. 3 Ensure that the owner and group in each restored directory match the owner and group setting from the original TARA server configuration. 4 [Optional] To reconfigure the owner or group setting if there was an owner or group change, type one of the following: tarasetcfg -u <user> -p <password> tarasetcfg -u <user> -e <password filename) To compare backup datasets between the TARA and TSM repositories To determine which TARA restore images to regenerate, compare backup datasets between the TARA and TSM repositories. 1 Display the backup datasets in the TARA repository by doing one of the following: a In the TARA GUI, click Teradata Tiered Archive/Restore Architecture>Task>Restore to display the RESTORE object selection dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

178 Chapter 7: Teradata TARA Troubleshooting Restoring Data for Disaster Recovery b Find information on all job files in the Job Information Repository by typing: tarajobquery -u <user name> - p <password> -s <TARA server name> -L For example, the last backup of the TARA server has images for three backups: 2 generations of "daily" datasets 1 generation of "weekly" datasets In the example, the last backup of the following datasets will be recovered: Daily datasets stored in the TSM repository Any new backups performed after the TARA server backup c Use taratddsmc to display the backup datasets in the TSM Repository. The taratddsmc utility lists: Three generations of "daily" datasets One generation of "weekly" datasets A new backup of "quarterly" datasets Differences between the TARA and TSM Repository require that the following images must be recovered in the TARA repository: Generation 3 of the "daily" dataset "Quarterly" dataset To regenerate a single-stream TARA image To recreate generation 3 of the "daily" backup dataset, create an Analyze script. 1 Create or edit a backup script similar to the following example: JOB daily-gen3 SESSIONS 12 MULTISTREAM 1 STREAMNAME daily_dstream0001_3 COMMANDLINE CSNAME=ASCII CHECKSUM=2 TDPID isis-td12 USERID admin OTB Tivoli TIVPOLICYGROUP client-group1 SCRIPT Analyze LOGON $LOGON; ANALYZE ALL, VALIDATE, DISPLAY LONG, FILE=ARCHIVE; LOGOFF; ENDSCRIPT 178 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

179 Chapter 7: Teradata TARA Troubleshooting Restoring Data for Disaster Recovery The lines that were modified or added are: The job name is daily-gen3 STREAMNAME line was added to indicate the name of the backup as listed in taratddsmc _3 was added to the STREAMNAME line to represent the generation Script Archive was changed to Script Analyze The ARCHIVE statement was changed to an ANALYZE statement 2 Launch the daily-gen3 Analyze script. After the Analyze script completes, an image is generated. In this example, the name is "daily-gen3". You can now restore the "daily-gen3" generated image. To regenerate a multistream TARA image To recreate the "quarterly" multistream backup dataset, create an Analyze script. 1 Create or edit a multi-stream backup script similar to the following example. JOB Recreate-quarterly SESSIONS 8 MULTISTREAM STREAMNAME quarterly_dstream0001_1 STREAMNAME quarterly_dstream0002_1 STREAMNAME quarterly_dstream0003_1 STREAMNAME quarterly_dstream0004_1 STREAMNAME quarterly_dstream0005_1 STREAMNAME quarterly_dstream0006_1 STREAMNAME quarterly_dstream0007_1 STREAMNAME quarterly_dstream0008_1 COMMANDLINE CSNAME=ASCII CHECKSUM=2 TDPID isis-td12 USERID admin OTB Tivoli TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 TIVPOLICY aj-edisonclass1 SCRIPT ANALYZE LOGON $LOGON; Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

180 Chapter 7: Teradata TARA Troubleshooting Restoring Data for Disaster Recovery ANALYZE ALL, VALIDATE, DISPLAY LONG, FILE=ARCHIVE; LOGOFF; ENDSCRIPT The lines that were modified or added are: The job name is Recreate-quarterly. The STREAMNAME lines were added to indicate the backup stream names as listed in taratddsmc _1 was added to each STREAMNAME line to represent the generation Analyze replaced Archive The ARCHIVE statement was replaced with an ANALYZE statement Note: STREAMNAME entries must follow the last STREAM entry. 2 Launch the Recreate-quarterly script. After the Analyze script completes, a TARA image is generated with the name "Recreate-quarterly". 3 You can now restore the generated image. 180 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

181 APPENDIX A Storage of Backup Data: Command Line Utility Topics include: Overview of Backup Data Storage Functional Restrictions IOPARM Parameters Security Overview of Backup Data Storage Object Names ARCMAIN stores Teradata backup data as a series of binary records in a single large file that spans one or more mainframe tapes. Most storage management products, however, store files and directories from a conventional file system. The Teradata Access Module for Tivoli maps the ARCMAIN backup file to a series of smaller storage objects no bigger than 2 GB. Although no direct correlation exists between Teradata Database/table objects that are stored on the backup and the file segments, the position information passed back to ARCMAIN for seek operations on the backup image indicates the file segment and physical byte offset within the segment. Though ARCMAIN is unaware of the particular storage medium that is used, ARCMAIN is able to reposition to different database objects on the backup image. Naming conventions used by the TSM storage catalog are the same as those used in a typical network: The Client Node Name is normally identified to the Storage Manager when the TSM server connection is first opened. The File Space or Object Name Space is Teradata. The full directory path to any storage object consists of two distinct components: a hierarchical string of directory names and the actual storage object file name. The left portion of the directory path is a hierarchical string, called the high level name in Tivoli terms. This portion of the path is user-defined, and can be up to 255 characters, including characters normally used to define conventional directory paths. For more Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

182 Appendix A: Storage of Backup Data: Command Line Utility Overview of Backup Data Storage information, see the description of the DATASETNAME field in Parameter Definitions on page 189. The right portion of the directory path is the storage object file name, or the low level name in Tivoli terms. This portion is a system-generated name for individual file segments in the form of Fnnnn, where nnnn is a four-digit integer with leading zeros. For example, a backup of 9 GB of data with the default segment size of 2 GB creates six storage objects with low-level names of F0000 through F0005. Note: Storage object name F0000 is reserved as a generation number placeholder by the Teradata Access Module for Tivoli. It contains no data. In general, there is no need to know specific naming conventions because the TDDSMC utility manages storage objects at the backup image level, and because most conventional TSM tools do not display the contents of the storage file spaces created to manage Teradata backups. However, some TSM commands, such as QUERY CONTENT, display individual storage object names. Therefore, some knowledge of these naming conventions is helpful. DataSetName in ARCMAIN Backups and Restores ARCMAIN scripts usually only use DATASETNAME when referring to particular backup images, but failure to specify this value in an IOPARM string does not cause a Teradata Access Module for Tivoli error. The Teradata Access Module for Tivoli uses these rules to determine a DATASETNAME. If the DATASETNAME field is: Specified in the IOPARM string, that name is used. Not specified, the Teradata Access Module for Tivoli uses the external name that is passed by ARCMAIN when the file opens. This external name is specified as follows: If the ARCMAIN FILEDEF command line option is used, the name indicated in FILEDEF is used. If no FILEDEF option is identified, the Teradata Access Module for Tivoli uses the name identified on the FILE= clause. This name is limited to eight alphanumeric characters. Names stored in the TSM server catalog are case-specific. Therefore, if a restore job or TDDSMC QUERY BACKUP command does not correctly capitalize the non-wildcard portions of a DATASETNAME, an error message results, stating that the backup image cannot be found. For example, FILE=DATA01 and FILE=Data01 can mean the same thing to ARCMAIN, but if FILE=DATA01 is an ARCMAIN backup job and FILE=Data01 is an ARCMAIN restore job, an error results. 33 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. 182 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

183 Appendix A: Storage of Backup Data: Command Line Utility Functional Restrictions 33: Specifying Backup Image Names Backup Image Name tivarc <arc.txt ioparm= datasetname=marketing\research.data tivarc <arc.txt filedef=(clust001, Marketing_Cluster_001) (arc.txt file contains an ARCHIVE DATA TABLES statement with the clause: FILE=CLUST001 ) tivarc <arc.txt (arc.txt file contains an ARCHIVE DATA TABLES statement with the clause: FILE=ARCHDATA ) Storage Objects Created Marketing\Research.data\F0000 Marketing\Research.data\F0001 Marketing\Research.data\F0002 Marketing_Cluster_001\F0000 Marketing_Cluster_001\F0001 Marketing_Cluster_001\F0002 ARCHDATA\F0000 ARCHDATA\F0001 ARCHDATA\F0002 Backup Generations Typically, backup options are defined once, then multiple backup jobs are run using the same options. To make identical backup jobs unique, the Teradata Access Module for Tivoli tags each storage object with a unique generation number that is assigned when ARCMAIN starts the File Open function. View these numbers by using the %gen% format field in TDDSMC QUERY BACKUP and QUERY OBJECT commands. By default, a request for a backup produces only the most recently created file generation (latest), or the active version in Tivoli terms. All other copies of a relevant object in storage are referred to by Tivoli as inactive versions. The generation parameter is not needed when requesting a restore of the latest (active) backup generation. However, when restoring an inactive backup, use the GENERATION field of the IOPARM string. Generation numbers are not part of the file name or the TSM naming convention. Instead, the Teradata Access Module for Tivoli stores the generation number inside the TSM object information. To ensure the creation of unique generation numbers for concurrent backups that use the same name, object segment zero (F0000) acts as a placeholder for the job-specific generation number. Object segment zero contains no data and is constructed and committed in its own TSM transaction. For more information on the GENERATION field, see the detailed description in Parameter Definitions on page 189. Functional Restrictions The following restrictions apply to ARCMAIN jobs that use the Teradata Access Module for Tivoli. No RESTART During Write ARCHIVE Statement Recommendation per Script Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

184 Appendix A: Storage of Backup Data: Command Line Utility Functional Restrictions No Dual Backup Support Interoperability Collocation 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 No Dual Backup Support Interoperability Create only one ARCHIVE statement per ARCMAIN script. ARCMAIN scripts that contain multiple ARCHIVE statements might create a valid backup even though the first statement fails. In other words, if a first statement fails when the second statement is valid, the second statement creates a backup. To consider both backups as a single logical set, manually edit the ARCMAIN job to only process the first ARCHIVE statement, then resubmit the job. To avoid having to manually edit and resubmit jobs due to multiple statements and generated errors, code only a single ARCHIVE statement in an ARCMAIN script. Dual backups are not supported, therefore do not create ARCMAIN backup scripts with more than one FILE= clause on the ARCHIVE statement. Including more than one File= clause causes an ARC0210: Too many archives have been specified error message. Backups cannot be restored across platforms. For example, an ARCMAIN backup job that is run on Windows 2000 must also be restored on Windows 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. 184 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

185 Appendix A: Storage of Backup Data: Command Line Utility Functional Restrictions Examples of Restrictions To minimize or prevent the storage of two ARCMAIN backups jobs on a single physical volume, do any of the following: Use the ARCMAIN options ALL and EXCLUDE on the ARCHIVE statement to collect many smaller database and table objects into a single Teradata backup job. Use the CATALOG option to selectively restore such objects with a minimal amount of tape scanning. Create different TSM management classes and storage pools. The following examples illustrate some of the restrictions discussed in this section. Each example assumes the configuration shown in : Configuration for Examples Parameter Assumption or Name Used Environment Windows 2000/2003 Environment Variables Location of Teradata Database Password Path Environment Variable TDPID Teradata User ID TIVARC.BAT file that comes with the samples sets variables, such as ARCDFLT, to contain standard command line options for ARCMAIN. Teradata server called EDW001 pwd 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 193. td1 dba1 To tailor these examples, refer to the Teradata Archive/Recovery Utility Reference. Example 1: Archive Script for Single-Node Backup This example creates ARCMAIN backups that originate from a single TSM node, NODE1, with a minimum command line. The minimum command line for ARCMAIN is to simply specify the ARCMAIN input file. The ARCDFLT.TXT sample file indicates the path to the TIVBAR.DLL executable with the IOMODULE parameter. In this case, DATASETNAME corresponds to the name indicated on the FILE= clause of the ARCMAIN ARCHIVE statement. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

186 Appendix A: Storage of Backup Data: Command Line Utility Functional Restrictions To create this type of backup: 1 Ensure that file pointed to by the ARCDFLT environment variable is Iomodule= tivbar.dll. 2 On the command line, type: tivarc <arcin.txt Output arcin ARC script Logon td1/dba1, pwd; Archive data tables (db1), release lock, file= db1_data; Logoff ; Backup Information in TSM Catalog Node = NODE1 Filespace = Teradata High Level = db1_data Low Level = F0000, F0001, F0002, and so on Example 2: Restore Script for Single Node Backup This example restores a backup that originates from a single TSM node, NODE1. To restore the latest generation of the first backup, change the ARCMAIN script to use a RESTORE or COPY statement. The command line stays the same. To create this type of backup: 1 Ensure that the file pointed to by ARCDFLT environment variable is Iomodule= tivbar.dll. 2 On the command line, type: tivarc <arcin.txt Output arcin ARC Script Logon td1/dba1, pwd; Restore data tables (db1), release lock, file= db1_data; Logoff ; Backup Information in the TSM Catalog Node = NODE1 Filespace = Teradata High Level = db1_data Low Level = F0000, 0001, F0002, and so on 186 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

187 Appendix A: Storage of Backup Data: Command Line Utility Functional Restrictions Other Considerations To restore the backup generation just before the latest backup, use this IOPARM value: tivarc <arcin.txt ioparm= generation=-1 For information about specifying relative and absolute generation numbers, see Parameter Definitions on page 189. Example 3: Archive Script for Multiple-Node Backup The next example performs a ARCMAIN backup that originates from multiple client nodes or multiple security domains with the default TSM administrator for the Tivoli EDW001 pseudo node. To create this type of backup: 1 Ensure that the file pointed to by ARCDFLT environment variable is dsm.opt. 2 On the command line, type: tivarc <arcin.txt Output arcin ARC Script Logon td1/dba1, pwd; Archive data tables (db1), release lock, file= db1_data; Logoff ; dsm.opt File TCPSERVERADDRESS PASSWORDACCESS PROMPT COMMMETHOD TCPIP NODENAME EDW001 PASSWORD EDW_PASSWORD Backup Information in the TSM Catalog Node = EDW001 Filespace = Teradata High Level = db1_data Low Level = F0000, F0001, F0002, and so on Other Considerations The considerations described above for archive also apply to restore. The TSM Administrator password is stored indsm.opt. Therefore, you might want to restrict who can read this special Options file, as explained in Security for Files that Contain Passwords on page 191. If password expiration is in effect for this TSM Administrator, regularly update dsm.opt on every node where an ARCMAIN job references it to reflect the new password or sets the password. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

188 Appendix A: Storage of Backup Data: Command Line Utility IOPARM Parameters Define TSM nodes for multiple Teradata servers (such as, when there is a production and a development server in the data center). In this case, the ARCMAIN command line is similar to the one shown above, but a different dsm.opt file that indicates the appropriate node name and password for that server can be pointed to. Therefore, use the correct Teradata logon in the ARCMAIN script. IOPARM Parameters Teradata Access Module for Tivoli specifies processing options in one of two places: Teradata Access Module for Tivoli checks the BARAM_DEFAULT environment variable for the path to a file that contain one or more of the parameters indicated in Parameter Definitions on page 189. BARAM_DEFAULT is described in Environment Variables on page 193. ARCMAIN passes a string to Teradata Access Module for Tivoli that contains a list of parameters that are user-defined with the IOPARM command line option. Specify the IOPARM string explicitly on the ARCMAIN command line, or include the string in the ARCMAIN default file, described in Default Files for ARCMAIN and the Access Module on page 192. Parameters are described in Parameter Definitions on page 189. The following sections define parameters that can be specified in either place. Syntax Rules The following syntax rules explain the criteria for acceptable parameters and how to properly assign values to parameters: Separate multiple parameter assignments by blanks or commas. Repeated blanks, tab characters, and other white space characters are ignored. Unless otherwise stated, each parameter assignment has this form: PARAMETERNAME = value Parameter names are case-insensitive. For example, config, CONFIG, and config are all acceptable. The equal sign (=) between the parameter name and the value can be replaced by one or more blanks. Blanks and a single comma can separate multiple parameter assignments on the IOPARM string. 188 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

189 Appendix A: Storage of Backup Data: Command Line Utility IOPARM Parameters The assigned value can be one of the following, depending upon the parameter semantics: Value Directory Path Value Integer Value Name Value Quote String Value Description Similar to a name token with the possible inclusion of forward slashes, backslashes, or periods within the overall name. In addition, directory paths can have a colon character (:) as the second character to separate the drive letter from the rest of the directory path. For example, C:\TIVBAR is a valid directory path. Directory paths can be up to 255 characters. Express embedded special characters not mentioned above (such as, blanks) as a quote string value. 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. Must be 30 or fewer alphanumeric characters that begin with a nonnumeric 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 caseinsensitive. Can be up to 255 characters and must be enclosed with either single-quote ( ) or double-quote ( ) characters. Note: Any valid ASCII character can be between the outermost quote characters, but a second occurrence of an opening quote will terminate the string. For example, a b and a b are valid quote strings, but a b would be interpreted as two different quote strings, because the two single-quote characters in the middle would be interpreted as ending the first and starting a second string. Parameter Definitions Parameters can be defined multiple times in a IOPARM string, but only the last assignment for the relevant parameter in the IOPARM string takes effect. Use this convention to override an entire set of parameter assignments. The following command line uses a second default file to override or merge with the normal settings established by the BARAM_DEFAULT environment variable: Tivarc <arcsamp.txt ioparm= default=c:\tdbar\mydefaults.txt The Teradata Access Module for Tivoli uses the IOPARM parameters shown in 35. In some cases, if a parameter is not specified, the default value in the description column is assigned as the parameter name. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

190 Appendix A: Storage of Backup Data: Command Line Utility IOPARM Parameters 35: Parameter Definitions Parameter Value Type Description CONFIG Directory Path Path to TSM client configuration file, dsm.opt. The DSMI_CONFIG environment variable typically establishes a basic environment context. Note: CONFIG, if indicated, is used for the actual TSM server connection. DATASETNAME Directory Path User-defined high-level name of backup file in storage. No default value exists, but if this parameter is not defined, the high-level name becomes the external name defined on the ARCMAIN FILEDEF parameter or the name on the FILE= clause. The FILE= clause is limited to eight alphanumeric values. DATASETNAME can also contain substitute variables that generate unique names for the backup. However, if either of these variables are used, specify DATASETNAME in a file of command line defaults: %time% is a substitution token replaced by the local date/time in the form: YYYYMMDD_HHMMSS where YYYY=Year, MM=Month, DD=Day, HH=Hour, MM=Minutes, and SS=seconds. %date% is a substitute token replaced by the local date in the form: YYYYMMDD where YYYY=Year, MM=Month, and DD=Day. DEFAULT Directory Path Path to the file of Teradata Access Module for Tivoli command line defaults. The parameter settings in this file are merged with parameter settings in the file indicated by the BARAM_DEFAULT environment variable and with any explicit command line parameters. Parameter assignments are expanded at the point where DEFAULT is indicated with the last specification in left-to-right order-taking precedence. For example, the following command line causes the TDDSMC utility to use the TSM Client Options file (indicated in myopts.txt) last: Tddsmc -config=mydsm.opt -default=myopts.txt DIRDELIM Single nonblank character Override TSM default directory path delimiters in storage object names. By default, this value is a backslash (\) on Windows platforms and a forward slash (/) on UNIX platforms. Note: Specify this parameter only in the DEFAULT file. FORMAT Quote string Default format string for Query Backup and Query Object command output of the TDDSMC utility. This parameter has no bearing on ARCMAIN processing. GENERATION Integer The backup file generation name to use for restore. The default value, 0 (zero), corresponds to the latest generation. A value that is: Positive indicates the specific generation number in storage (active or inactive). Negative indicates the relative generation number since the latest generation. For example, if the latest generation is 15, then Generation -2 is Generation 13. However, in this example, GENERATION=15 corresponds to the fifteenth backup that was ever performed, using the indicated DATASETNAME name. Not specifying GENERATION restores the latest backup. 190 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

191 Appendix A: Storage of Backup Data: Command Line Utility Security 35: Parameter Definitions (continued) Parameter Value Type Description MGMTCLASS Name The TSM management class for all storage objects created by a backup operation. This parameter overrides any INCLUDE list specified in the TSM Client Options file, dsm.opt. Before using the parameter, define a management class with this name and a valid backup copy group with the TSM server. For more information, see the Tivoli Storage Manager for Windows: Administrator s Guide. NOHEADER Not applicable A single keyword to suppress the display of column headers for Query Backup and Query Object commands of the TDDSMC utility. Use this parameter to pipe the output to the sort utility. This parameter has no bearing on ARCMAIN processing. Security When configuring a system, consider the security features listed in 36. For additional information about managing security for Teradata Archive and Recovery, TSM, and Windows, see Additional Information on page 5. 36: Security Features Component Teradata Database Windows Operating System Tivoli Storage Manager Security Teradata server user ID and password authenticate the authority of an ARCMAIN job to back up or restore specific data on the Teradata Database. Note: It is possible to grant a Teradata user DUMP, RESTORE, and CHECKPOINT privileges, but not the authority to select or modify particular database objects. Windows operating system user ID and password launch ARCMAIN. The TSM administrative user ID and password associate default storage management policies to a job and authenticate that a given job can restore particular data. Refer to the relevant Teradata and Tivoli documentation for administrative setup procedures that avoid storing passwords in the configuration files or scripts. For a list of those documents, see Additional Information on page 5. Security for Files that Contain Passwords To store passwords in configuration files, secure them by right-clicking the file or directory icon in Windows Explorer and selecting the Security tab of the Properties menu. Grant read authority only to the user IDs or groups that execute ARCMAIN backups or start the TDDSMC utility. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

192 Appendix A: Storage of Backup Data: Command Line Utility Security To secure access to the job execution directory (such as C:\TDBAR): 1 Use the LOGON Option in the ARCMAIN default file. Avoid specifying passwords in the ARCMAIN script or on the explicit ARCMAIN command line. 2 Use the PASSWORD Option in the TSM Client Options file and secure the file, using the method described above. Note: Do not specify secure passwords on the explicit command line to any tools because operating system diagnostic traces or screen printouts often disclose those items. For more information about default, refer to Default Files for ARCMAIN and the Access Module on page 192. Control of Access to Backup Images Stored in TSM It is critical to control access to backup images that are stored in TSM when running multiple Teradata backup jobs. Stored data often contains sensitive information (such as financial material) that requires restricted access. Limit access to particular subsets of Teradata backups by creating additional TSM client nodes that correspond to each security domain to be established. In the same way that defining pseudo nodes in the TSM catalog is recommended for all Teradata backups, pseudo nodes for each major security domain can also be created. Use these TSM server administration console commands, for example, to segregate financial data backups from other data warehouse backups: Register node EDW001 EDW_PASSWORD Register node EDW_FINANCE FINANCE_PASSWORD Choosing this option requires creating special copies of the Default and Client Options files to store the passwords in restricted files. Set these restrictions in Windows. Default Files for ARCMAIN and the Access Module The Teradata Access Module for Tivoli installation process creates a special directory for holding Default and Client Option files, which typically default to C:\Program Files\NCR\Teradata Client\TDBAR. TIVARC.BAT and TIVADM.BAT establish environment variables that point to the Default and Client Option files. (For a list of these variables, see Environment Variables on page 193.) Copy and customize the Client Options files to match site-specific requirements. Standardize the options used by the various components in the following ways, any of which can be overridden on the ARCMAIN command line, if necessary: The ARCDFLT.TXT configuration file holds the most common ARCMAIN command line options. For details about these options, see the Teradata Archive/Recovery Utility Reference. The DEFAULT option described in that manual explains the format of ARCDFLT.TXT (such as, comment lines). The TIVDFLT.TXT configuration file holds the most common options passed to the Teradata Access Module for Tivoli. This file uses the same format as the ARCMAIN default file. 192 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

193 Appendix A: Storage of Backup Data: Command Line Utility Security Environment Variables The Teradata Access Module for Tivoli does not provide a TSM Client Options file, but during the installation process the Teradata Access Module prompts for the location of the file that was created during the TSM installation process. 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. TIVARC.BAT and TIVADM.BAT establish environment variables that point to the location of sample Client Option files. Copy and customize the variables shown in 37 to match site requirements. 37: Environment Variables Variable ARCDFLT BARAM_DEFAULT BARAMLOG BARAMLOGLEVEL DSMI_CONFIG DSMI_DIR DSMI_LOG Description Path to ARCMAIN command line DEFAULT file. Note: Include the path name in quotes if there are embedded blanks in the string. This is necessary because of the way ARCMAIN processes this environment variable, but is not necessary for other environment variables. Path to command line defaults file for the Teradata Access Module for Tivoli. Override the fields defined in this file on the command line or specify an alternative default file on the command line. The format of this file is similar to the format of the ARCMAIN default file. For example, white space and blank lines outside of a quote strings is ignored, and two semi-colon characters in a row mark the rest of the line as a comment that is ignored. Path to diagnostic log file for the Teradata Access Module for Tivoli. If this path variable is not defined, it defaults to the current working directory with a log name of baram_log.txt. Note: Logging always appends to this file. Periodically purge this file to prevent it from growing indefinitely when jobs are rerun. Numeric indicator of diagnostic logging level used for the Teradata Access Module for Tivoli. Log levels are 1 through 5, with 1 as the default. If a log level is not specified, logging defaults to 1. Path to the TSM client configuration file, dsm.opt. If this variable is undefined or set to the null string, the TSM API software expects to see dsm.opt in the local directory that executes the ARCMAIN or TDDSMC. For more information, see the Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User s Guide. Directory path containing the TSM client API error messages file (dscameng.txt). Usually, this is in C:\ProgramFiles\Tivoli\TSM\baclient. Directory path for storing TSM client log messages (dsierror.log). If this variable is undefined or set to the null string, and if a log message is locally generated by TSM, dsierror.log is created in the local directory that executes the ARCMAIN or TDDSMC. For information about using this file in troubleshooting, refer to Chapter 5 taratddsmc Command- Line Utility on page 109. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

194 Appendix A: Storage of Backup Data: Command Line Utility Security For more information about creating ARCMAIN scripts and implementing Teradata backup and restore processes, refer to the Teradata Archive/Recovery Utility Reference. The usage notes apply specifically to BAR jobs that start the access module. 194 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

195 APPENDIX B Disabling Space Reclamation Teradata Corporation recommends that Teradata Extension for TSM users disable the TSM space reclamation feature to allow faster restore jobs. However, when space reclamation is disabled and an image expires on TSM, the corresponding image entry is removed from the TSM database or TSM catalog but not deleted from the tape. For efficient space usage, move data and return tapes to scratch. See Moving Data for information on how to do this. Overview of Space Reclamation Data is written to tape one block at a time until all data is written or the tape becomes full. As data or images of backup jobs expire, the tape becomes fragmented with a mix of active data and expired data that is deleted from the TSM catalog or TSM database. Therefore, tapes that are marked full often contain less than 100% data. The space reclamation feature frees space on tapes or sequential file volumes in sequential storage pools by moving all the data onto as few tapes as possible. However, because data from different streams from a parallel backup job might reside on one tape, multiple single-stream TARA jobs must run serially to complete the entire TARA restore job. This process degrades performance. Therefore, Teradata recommends disabling space reclamation. Disabling space reclamation, however, has a side effect. As generations of backup images expire based on retention policy, the data or images marked for deletion accumulate on the tape. As long as there are some valid or active backup images on the tape, the tape cannot be cleaned or moved to scratch. Moving Data To move data from one tape to another, use the TSM MOVE DATA command. Identify all the tapes that need to be cleaned and moved to scratch. Run the MOVE DATA command on each tape, setting the RECONStruct parameter to 'Yes'. Reconstruction removes empty space that accumulated during deletion of logical files from the tape. After you have successfully moved data from a primary tape to a new tape, mark the new tape as "unavailable" until you have completed the entire process of moving all data on all tapes. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

196 Appendix B: Disabling Space Reclamation Moving Data This makes sure that TSM does not move data or images from the new tapes to a single tape. After moving all data from primary tapes, clean the primary tapes and move to scratch. For future backup jobs, ensure that the management class for TARA backup jobs uses the correct set of tapes in the storage pool. Modify the TSM management class used for TARA to point to the new storage pool or repeat the process of using the MOVE DATA command to move images from the new storage pool tapes back to the original storage pool configured for the management class. 196 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

197 APPENDIX C TVI Events The Linux TARA server logs syslog events in /var/log/messages. Server Management generates alerts that can be viewed in SMWeb Alert Viewer. The Teradata Vital Infrastructure (TVI) escalates some alerts to Teradata, creating INCIDENTS with Teradata Services. In the TARA domain, TVI escalates the alert with messageid 12. Other alerts for the TARA domain are not escalated by TVI. Note: Event codes are supported in CMIC version unless otherwise specified. Note: TVI logging is not supported on the Windows TARA server. TVI logging is enabled by default. TVI Messages TVI messages for Teradata Extension for TSM have message ID numbers. Message 12 is automatically reported to Teradata. 12 TARA-SignalHandler Explanation: Severity: Probable Cause: Remedy: The TARA server crashed due to an access violation, causing the TARA server service to stop. If there is an existing job running, the job will fail. No TARA jobs can be run until the service is started. Critical Recent activity in TARA or the launched job caused the TARA server to crash. Contact the Global Support Center. Provide the stack that is stored as a text file in the TARA server's logs directory and the TARA server logfile in the TARA server's logs directory. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

198 Appendix C: TVI Events TARA-ServerService-Down Explanation: Severity: Probable Cause: Remedy: TARA server service was stopped. No TARA jobs can be run. Critical The TARA service can be stopped manually or during a shut down or reboot. The TARA server service should start automatically on reboot. If the TARA server crashed or hit a segmentation fault, the TARA server service will go down. This is generally accompanied by a TARA-SignalHandler alert. Check to see why the TARA server service went down. In the event of a segmentation fault, the stack is stored as a text file in the TARA server's logs directory. 22 TARA-ServerService-Up Explanation: Severity: Probable Cause: Remedy: The TARA server service was started. You can run TARA jobs. Information only The TARA server service was started. N/A 23 TARA-Config-Change Explanation: Severity: Probable Cause: Remedy: A user has updated the TARA server configuration. The updated information should be reflected in the defaults file. Information only The user updated the configuration. N/A 198 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

199 Appendix C: TVI Events TARA-Job-Warning Explanation: Severity: Probable Cause: Remedy: The TARA job completed with a warning return status from ARCMain. This might require the TARA user's attention. Warning ARCMain completed the job but had problems that were not severe enough for the job to fail completely. Refer to TARA logs for details. For more details, set the VB3 ARCMain parameter. 25 TARA-Job-Fail Explanation: Severity: Probable Cause: Remedy: The TARA job failed to complete. There might be a direct ARC error or other ARC dependant software errors, including DBS, CLI, TARA access module, or third-party application errors. Critical ARCMain encountered a severe problem and failed to complete the job. Refer to TARA logs for details. For more details, set the VB3 ARCMain parameter. 26 TARA-Job-Abort Explanation: Severity: Probable Cause: Remedy: The TARA job was aborted. The job did not complete. Information only The user might have aborted the TARA job. N/A Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

200 Appendix C: TVI Events TARA-JIRSync Explanation: Severity: Probable Cause: Remedy: A request from the TARA GUI or the command line utility was sent to the TARA server to synchronize the TARA repository with the Tivoli Storage Manager catalog. Information only The user ran a Synchronize on a dataset from the Restore Object Selection or used a TARA command line utility. N/A 28 TARA-JIRDelete Explanation: Severity: Probable Cause: Remedy: A request from the TARA GUI or the command line utility was sent to the TARA server to delete a specific job information file in the TARA repository. Information only The user ran a Delete on a specific job information file from the Restore Object Selection or used a TARA command line utility. N/A 29 SupportBundleTriggerRule Explanation: Severity: Probable Cause: Remedy: Created diagnostic files to be sent to customer support. Information only A problem in TARA required more details and a file was created for diagnostic purposes. Investigate other TARA alerts and send Teradata Customer Support the tara_ddb to diagnose the problem. Note: This is a support bundle that is generated and sent to Customer Support through Server Management. To trigger this process, the user must manually run supportbundle.sh, which 200 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

201 Appendix C: TVI Events 29 creates a support bundle file, copies it over to /var/opt/teradata/supportbundle, and logs the event to /var/log/messages. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

202 Appendix C: TVI Events Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

203 Glossary A AMP Access Module Processor, which is a virtual processor that receives steps from a parsing engine (PE) and performs database functions to retrieve or update data. Each AMP is associated with one virtual disk, where the data is stored. An AMP manages only its own virtual disk and not the virtual disk of any other AMP. API Application programming interface. ARCMAIN ARC executable that extracts (or inserts) database headers and data rows from the HUT (Host Utility) archive interface. B BAR Backup and restore; a software and hardware product set. Also referred to as Backup/ Archive/Restore. Backup Application Software A product set of backup and restore products designed to be used with Teradata Database. The products include Teradata access modules to backup and restore products by Symantec Veritas, BakBone, and IBM. The prior term for Backup Application Software was Open Teradata Backup (OTB). C CLI Teradata Call Level Interface API (application programming interface); allows an application or utility program to communicate to a Teradata system through standard TCP/IP protocol. CLI2 Call-Level Interface Version 2, also called CLI for Windows CLIv2so Call-Level Interface Version 2 Shared Object (CLIv2so); this program installs the CLI libraries required by other utilities. When the CLIv2so program submits a request to a Teradata Database, CLI Library components transform the request into Teradata Database formats. The CLI Library sends requests to, and receives responses from, the Teradata Database over a network. Cluster Logical, table-level archive whereby only those rows residing on specific AMPs, and which are members of the specified cluster, are archived onto a single tape dataset. This allows multiple jobs to be applied for backup of large tables, to reduce the backup window. This method is used to affect a parallel archive/restore operation through a divide and conquer backup strategy. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

204 Glossary D DBA Database Administrator. F FIFO First In First Out queue. G GB Gigabyte. L LAN Local Area Network. M MB Megabyte. MP-RAS UNIX system-based operating system installed to run many Teradata installations. MPP Massively Parallel Processing. N NIC Network Interface Card. NO REWIND A tape device definition that prevents a rewind operation at file open or file close. NO REWIND allows a program to access multiple files on a tape by leaving the tape positioned at the end of the current file at close, thus allowing the subsequent file to be easily accessed by the next open. O ODBC OTB Open Database Connectivity. Open Teradata Backup. This term has been replaced by Backup Application Software. P PE Parsing Engine. R RDBMS Relational Database Management System. S SAN Storage Area Network. 204 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

205 Glossary SSO Single Sign-On. T TB Terabyte. TDDSMC Teradata Database System Management Console that allows users to view and perform maintenance activities on ARCMAIN backups that are stored in Tivoli Storage Management. TDP In a Teradata context, TDP refers to Teradata Director Program. TDP In an IBM TSM context, TDP refers to Tivoli Data Protection, which is an extension product written to the TSM API that manages backup and restore of specific types of application data. Examples include TDP for Lotus Domino and TDP for Oracle. For details about Teradata TDP, see TDPID. TDPID Name in the Teradata connection string used to identify a specific host alias that corresponds to the Teradata server of interest when using the native CLI interface software. For example, if User1 wants to open a Teradata connection, User1 might use a logon string in the form of name1/user1, password where name1 is the TDPID. For the TDP to be valid, there must be a corresponding host alias entry that maps name1cop1 to a valid IP address for the specific Teradata server of interest. TIVBAR Teradata Access Module for Tivoli. TSM Tivoli Storage Management; IBM s storage management solution. TVS Teradata Virtual Storage is optional storage subsystem software that optimizes data placement on the disks to speed access to the most frequently used (hot) data. TVS monitors how frequently each cylinder is accessed and determines which data is hot, warm, or cold. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

206 Glossary 206 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

207 Index Symbols.jar file 170.out files 171 %gen% 183 A administrative user ID 191 ALL option 184 ARC output files 171 arcdflt variable 193 arcdflt.txt 192 archive jobs states 171 ARCHIVE object selection dialog box 67 archive script example of multiple-node 187 example of single-node 185 ARCHIVE statements 184 ARCMAIN datasetname 182 error log 152 overview 21 restrictions 183, 184 scripts 182 audit log 151 Auto Generate feature 73 B backups configuration of TSM 47 controlling access 192 created storage objects 183 generations 183 object names 181 overview 181 BAM#### BARAM_DEFAULT variable 193 BARAMLOG variable 193 BARAMLOGLEVEL variable 193 block compression selecting 84 build ARC script 81 C CATALOG option 184 character set 72, 85 client heartbeat 169 client options 49 Client Options file configuration 49 collocation 184 command line utility TARAJobQuery 119 TARASetCfg 142 COMMTIMEOUT server option 49 configuration ARC options 61 client groups 57 client options 49 client systems 55 files for command line utility 192 of TSM 47 Teradata Database system 54 TSM policy objects 47 TSM server options 48 configuration changes TARA server audit log 151 core files 173 cross-platform restrictions 184 D Data Connector error messages 155 DataSetName 182 debug log 150 default timeout 49 default files 192 dialog box ARCHIVE object selection 67 RESTORE object selection 78 Script Options (for archive operations) 69 dsm.opt file 193 DSMI_CONFIG variable 193 DSMI_DIR variable 193 DSMI_LOG variable 193 dual backup support 184 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

208 Index E environment variables 193 error logs access module 150 ARCMAIN 152 TSM client log 153 TSM errors 152 TSM Server Activity log 152 error messages to to to BAM#### 155 Data Connector 155 TSM 164 vendor independent 157 EXCLUDE option 184 export job data in HTML format 104 F failure 8205 message 168 file size indicator 49 G generations backups 183 Graphic User Interface Configuration dialog box Teradata TARA 51 GUI Teradata TARA 66 H HTML format exporting job data in 104 I IDLETIMEOUT server option 49 installation default files 192 inter-operability 184 IOPARM datasetname field 182 J Java Runtime Extension running under 170 job history 104 job IDs 88 K keywords 95 L launch times using the command line to obtain 170 log level 169 logfile 174 logon security 191 logs access module debug log 150 M management classes configuring 72 maximum files restored 49 multiple jobs controlling access 192 naming conventions 183 on a single volume 184 N naming conventions objects 181 parameters 188 nodes pseudo nodes 192 NoSync option 71 O object names naming conventions 181 online archive 71 operating systems restriction 184 outlog 152 overview 21 P password 191 security 191 permissions for Windows environment 27 platform restrictions 184 positioning data 62, 72, 84 product overview 21 product version numbers 4 pseudo nodes Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00

209 Index Q query banding 71, 83 query banding options 84 R RESOURCETIMEOUT server option 49 RESTART during rewrite 184 restore database object 77 latest backup image 82 restore file maximum number indicator 49 RESTORE object selection dialog box 78 restrictions ARCHIVE statements 184 ARCMAIN 183 collocation 184 dual backup support 184 inter-operability 184 multiple-node 187 no RESTART during write 184 single-node 185 RETEXTRA field 48 RETONLY field 48 runarctiv.bat file 172 running backup jobs with the same name 169 S script names using the command line to obtain 170 scripts edit 72, 85 security 191 controlling access to backups 192 files containing passwords 191 logon 191 pseudo nodes 192 TSM 191 Server Activity log 152 server configuration 47 server options 48 sessions per stream 84 software releases supported 3 starting the TARA server 170 state conditions build phase 73 dictionary 73 table data 73 stopping the TARA server 170 storage objects created at backup 183 storage pools 184 storing backup data 181 syntax rules 188 system health 169 system management security 191 T TARA server audit log 151 TARA Server Configuration dialog box ARC Options tab 61 Client Groups tab 57 Clients tab 55 Teradata tab 54 Tivoli tab 58 TARA server log change verbosity 174 TARA server response to client heartbeat 169 taragui.jar file 170 TARAJobQuery command line utility 119 TARALaunch command line utility 134 TDPID 70, 82 Teradata Tiered Archive/Restore Architecture 66 timeout 49 TIVADM.BAT 192 TIVARC.BAT 192 tivdflt.txt 192 troubleshooting 149 TSM client error log 153 configuration 47 error logs 152 policy object fields 48 policy objects 47 security 191 Server Activity log 152 server configuration 47 TSM client options 49 TVS temperature 84 TXNGROUPMAX server option 49 U updating job IDs 88 user IDs 191 user name 70, 82 V variables 193 VERDELETED field 48 VEREXISTS field 48 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

210 Index verify checksum 72 version numbers 4 view job history 104 X xinetd process Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 15.00