Teradata Extension for Tivoli Storage Manager Administrator Guide

Transcription

1 What would you do if you knew? Teradata Extension for Tivoli Storage Manager Administrator Guide Release B K May 2017

2 The product or products described in this book are licensed products of Teradata Corporation or its affiliates. Teradata, Applications-Within, Aster, BYNET, Claraview, DecisionCast, Gridscale, QueryGrid, 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. Amazon Web Services, AWS, Amazon Elastic Compute Cloud, Amazon EC2, Amazon Simple Storage Service, Amazon S3, AWS CloudFormation, and AWS Marketplace are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries. AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc. Apache, Apache Avro, Apache Hadoop, Apache Hive, 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. CENTOS is a trademark of Red Hat, Inc., registered in the U.S. and other countries. Cloudera and CDH are trademarks or registered trademarks of Cloudera Inc. in the United States, and in jurisdictions throughout the world. Data Domain, EMC, PowerPath, SRDF, and Symmetrix are either registered trademarks or trademarks of EMC Corporation in the United States and/or other countries. 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 of Quest Software, Inc. 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. SAP is the trademark or registered trademark of SAP AG in Germany and in several other countries. SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc. Simba, the Simba logo, SimbaEngine, SimbaEngine C/S, SimbaExpress and SimbaLib are registered trademarks of Simba Technologies Inc. SPARC is a registered trademark of SPARC International, Inc. 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. Veritas, the Veritas Logo and NetBackup are trademarks or registered trademarks of Veritas Technologies LLC or its affiliates in the U.S. 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 noninfringement. 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 teradata-books@lists.teradata.com 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.

3 of Contents Preface Purpose...15 Audience...15 Prerequisites...15 Supported Releases Revision History...16 Additional Information...16 Product Safety Information Chapter 1: Introduction...19 Overview...19 Component Overview Migration from Legacy Product...20 Older Version of Teradata Extension Discontinued...20 Encryption...20 UTF-8 Support Chapter 2: Teradata TARA Installation and Uninstallation System Requirements Linux Operating System Non-Teradata Software Teradata Tools and Utilities Software for 64-Bit Linux...23 Windows Operating System Non-Teradata Software Teradata Tools and Utilities Software for 64-Bit Windows...24 User Account Requirements Linux Windows Teradata TARA Installation Overview of Installation Packages Installation Location...26 Installation Order...26 Estimating the Size for the TARA Server Repositories...26 JobFile Repository (jir) Script Repository (sr)...26 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

4 of Contents Logs Repository (logs) TARA Component Upgrade Installation of Teradata TARA Components on Linux...27 Installing the TARA Server...27 After Installation Installing the Teradata TARA GUI Installing the Tivoli Access Module Verifying the Taraserver Process is Active Installation of Teradata TARA Components on Windows Installing the TARA Server...29 Installing the Tivoli Access Module Installing the Teradata TARA GUI The xinetd Process on Linux Installed Components TARA Server Package...35 Teradata TARA GUI Package Tivoli Access Module Package Uninstallation on Windows Uninstallation on Linux Rolling Back to a Prior Release Rollback Considerations Chapter 3: TSM and Teradata TARA Configuration...41 Overview...41 Configuring TSM for Teradata Backups TSM Server Configuration...41 TSM Policy Objects...41 TSM Client Node TSM Server Options TSM Client Options...43 The Linux Client System File Configuring the TARA Server GUI...44 TARA Server Port Changing the Port Number Increasing the Java Heap Size...46 Configuring the TARA Server...47 Step 1 - Configuring the Teradata Database System...47 Step 2 - Configuring the Client Systems Step 3 - Configuring the Client Groups...50 Step 4 - Configuring Tivoli Information Step 5 - Configuring ARC Options...55 Step 6 - Configuring Logging Configuring the Log File Chapter 4: Backup and Restore Using the GUI Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

5 of Contents Starting the Teradata TARA GUI...59 Displaying Help...60 Archiving a Database Object Logging on to Teradata Database Archiving a Database Object Using Auto Generate to Archive Databases...66 Creating a Dictionary-Only Archive Job TSM Parameters Overwrite at Runtime Using TSM Options...68 Selecting Individual Objects to Archive or Restore Restoring a Database Object...70 Restoring a Database Dictionary Only Restore Analyzing Using the Script Options Dialog Box Analyzing Using the Restore DBC Dialog Box...79 Running an Analyze Job when Restoring DBC Database Restoring the Latest Backup Job Restoring a Multistream Archive Using Fewer Streams...80 Manually Restoring a Multistream Archive Using Fewer Streams...81 Restoring the DBC Database Backup Job Reinitializing the System...84 Restoring the DBC Database Backup Job Use a DBC (ALL) Backup Dataset for Analyze or Copy Jobs...86 Creating the Analyze or Copy Job Valid Keywords Validating Edited Job Scripts...89 Keywords...90 No Spaces Permitted Characters...90 Stream Values CopyScript Options Accessing CopyScript Options...91 Checking or Clearing the Selection of Database Objects Renaming and Copying Database Objects into the Same Database Copying into a New Database Excluding s in a Job Script Viewing a Job History Exporting Job Data in HTML Format Deleting Failed Jobs in a Job History Aborting Jobs...99 Searching for Strings in Job Logs...99 Extensions for Job Files Renaming a Job Deleting Temporary Files in the baruser Directory Chapter 5: taratddsmc Command-Line Utility Overview Overview of taratddsmc Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

6 of Contents Installation Running taratddsmc Command Line Parameters Syntax Conventions Format Specifiers Examples 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 Chapter 6: Teradata TARA Command-Line Utilities Overview TARAJobQuery Sample Lines of Code Sample List Option Output Sample Query Option Output - Traditional View Sample Query Option Output - Hierarchical View TARAJobRM Example Connect to TARA Server Example Delete TARA Job File or TARA Script TARAJobRM Parameters TARAJobRM Return Codes 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 Overview Using the Troubleshoot Utility Creating a Diagnostic Bundle for Support TARA Support Bundle Script, Log, and.zip File Names and Location Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

7 of Contents Support Bundle Information Overview of Error Messages Teradata Extension for Tivoli Storage Manager Debug Log TARA Server, Client, and GUI Log Files TARA Server Log File TARA Client Log File TARA GUI Log File TARA Server Audit Log TARA Server Post-Installation Log Example Linux Taraserver Post-Installation Log TIVBAR Post-Installation Log Example TIVBAR Post-Installation Log ARCMAIN Outlog TSM Log Messages TSM Server Activity Log TSM Client Log Error Conditions and Recovery 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 Stopping and Restarting the TARA Server 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 the Verbosity of the TARA Server Log Recovery to a Different TARA Server Running an Analyze Job Restoring and Copying the TARA server Restoring Data for Disaster Recovery TARA Server Directories for Disaster Recovery Recovering a Backup Dataset in the TSM Repository Restoring the TARA Server with the Last Directory Backup Comparing Backup Datasets Between the TARA and TSM Repositories Regenerating a Single-Stream TARA Image Regenerating a Multistream TARA Image Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

8 of Contents 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 ARCHIVE Statement Recommendation per Script No Dual Backup Support Interoperability Collocation Examples of Restrictions Example 1: Archive Script for Single-Node Backup Example 2: Restore Script for Single Node Backup Example 3: Archive Script for Multiple-Node Backup 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 Overview of Space Reclamation Moving Data Appendix C: TVI Events Overview TVI Messages Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

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

10 of Contents 10 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

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

12 List of Figures 12 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

13 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 : Parameters for taraping : 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 : Specifying Backup Image Names : Configuration for Examples : Parameter Definitions : Security Features : Environment Variables Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

14 List of s 14 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

15 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 has 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 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: Administrator s Guide Tivoli Storage Manager for Windows: Administrator s Guide Tivoli Storage Manager for Windows Backup-Archive Clients Version 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 Supported Releases This book supports the following releases: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

16 Preface Revision History IBM Tivoli Storage Manager 6.3, 6.4, 7.1, and 8.1 (for TSM clients only) Teradata Database 14.0, 14.10, 15.0, 15.10, 16.0, Teradata Extension for Teradata Tools and Utilities or later Note: To display the Teradata Extension for Tivoli Storage Manager version number: 1. Open Teradata Extension for Tivoli Storage Manager s GUI. 2. Click Teradata Tiered Archive/Restore Architecture > Help > About. Revision History The following changes were made to this book in support of the current release. For a complete list of changes to the product, see the release definition associated with this release. Date and Release May Description Changed instances of to for components. Updated Java Runtime Environment from 1.6 to 1.8. Additional Information Related Links URL Description Use Teradata At Your Service to access Orange Books, technical alerts, and knowledge repositories, view and join forums, and download software packages. External site for product, service, resource, support, and other customer information. Related Documents Documents are located at Title Publication ID Teradata Archive/Recovery Utility Reference B Teradata Tools and Utilities Installation Guide for Microsoft Windows B Teradata Tools and Utilities Installation Guide for Unix and Linux B Customer Education Teradata Customer Education delivers training for your global workforce, including scheduled public courses, customized on-site training, and web-based training. For information about the classes, schedules, and the Teradata Certification Program, go to 16 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

17 Customer Support Preface Product Safety Information Customer support is available around-the-clock, seven days a week through the Global Technical Support Center (GSC). To learn more, go to 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 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

18 Preface Product Safety Information 18 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

19 CHAPTER 1 Introduction Overview 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. The following figure illustrates the 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

20 Chapter 1: Introduction Migration from Legacy Product Figure 1: Overview of a Teradata Extension for Tivoli Storage Manager Backup 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. 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 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. 20 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

21 UTF-8 Support TARA and later supports UTF-8 database objects. Chapter 1: Introduction UTF-8 Support Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

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

23 CHAPTER 2 Teradata TARA Installation and Uninstallation System Requirements 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 (B ). Linux 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.8 or later. Teradata Tools and Utilities Software for 64-Bit Linux For TARA 16.10, 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 (TeraGSS) Note: Backup images that were created using TARA and TTU or earlier can be restored in a TARA and TTU BAR server environment, or later. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

24 Chapter 2: Teradata TARA Installation and Uninstallation User Account Requirements See the Teradata BAR Backup Application Software Release Definition (B ) for specific TARA and TTU software compatibility. Windows Operating System Windows Server bit Windows Server bit 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.8 or later. Teradata Tools and Utilities Software for 64-Bit Windows For TARA 16.10, 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 See the Teradata BAR Backup Application Software Release Definition (B ) 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 baruser 755 Group Read/Execute Other Read/Execute 24 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

25 Windows Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 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 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) The following table lists installation package locations on the Teradata Extension for Tivoli Storage Manager CD. 3: CD Installation Packages and Locations OS Linux 64- bit Windows 64-bit TARA Server Package and Location Linux/taraserver/x8664/ taraserver-<version>- <release>.x86_64.rpm Windows \x8664\taraserver.setup. exe TARA GUI Package and Location Linux/taragui/x8664/ taragui-<version>- <release>.x86_64.rpm Windows\x8664\taragui \setup.exe Tivoli Access Module Package and Location Linux/tivbar/x8664/ tivbar-<version>release.x86_64.rpm Windows\x8664\tivbar \setup.exe 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, which 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

26 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation Installation Location Install all three packages on a single server, each package on a different server, or any combination in between. Base the decision about where the TARA components are installed on the availability of servers and the anticipated usage and load on those servers. 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 TARA configuration. Install the Teradata TARA GUI on either or both of the sets of components that will be used as the administration interface to TARA: BAR servers Workstations Installation Order There are restrictions on the order of installation: Install the TARA server before the Tivoli access module. Install any product dependencies before installing the required TARA package (dependencies are noted in the next sections). 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 26 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

27 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation Logs Repository (logs) The default maximum taraserver log file size is 2,147,483,648 (2GB). The taraserver retains the currentlyactive 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. See Configuring the Log File. TARA Component Upgrade When you are upgrading a TARA component from a prior release, remove the existing package before installing the new package: Linux use rpm - e <TARA_component_name>. Windows use Control Panel > Add/Remove Programs. Installation of Teradata TARA Components on Linux Installing 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: 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 pressing Enter. 5. Enter the user home directory. The default is /home/taraserver, which can be selected by clicking Enter. Note: If you have a BAR server that is not supplied by Teradata Corporation and has a small file system where /home resides, you can create the baruser account home directory in a location other than / home. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

28 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation After Installation After the post-installation script completes, a message points to the /var/opt/teradata/tara/server/ logs/postinstall_xxxxx.log file that tracks installer responses and actions. See Configuring the Log File for an example. Note: A dependency clause is included in the Teradata TARA GUI's rpm file to check for the existence of the teradata-jre8 package version or greater. If that package is not installed, the installation of Teradata TARA GUI package fails due to a dependency error. To correct this error, install the missing package with the rpm utility before retrying the installation. After a taraserver is installed or upgraded, the TARA directories are: # ls -l /opt/teradata/tara total 0 # ls -l /etc/opt/teradata/tara/server total 0 # ls -l /var/opt/teradata/tara/server total 19 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 Installing 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: 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. Installing 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: rpm -ih tivbar x86_64.rpm 3. Run the post-installation script by typing one of the following: 28 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

29 /opt/teradata/tara/tivbar/bin/tivbar_postinstall.sh cd /opt/teradata/tara/tivbar/bin./tivbar_postinstall.sh Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation The post-installation script, tivbar_postinstall.sh, is 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. After the script completes, a message points to the /opt/teradata/tara/tivbar/ postinstall_xxxxx.log file that tracks the process of setting up the Linux TARA client daemon. Refer to TIVBAR Post-Installation Log for more information. Verifying the Taraserver Process is Active Verify the taraserver process is active in its designated BAR server, then: 1. Press Enter. 2. At the prompt, enter the machine name where the taraserver process is running. The default is localhost, which can be selected by pressing Enter. 3. Enter the client name for this BAR server. The default is uname -n, which can be selected by pressing 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 follows: 1. TARA server 2. Tivoli access module and Teradata TARA GUI, in any order (installation instructions are given for the Tivoli access module first) Installing the TARA Server 1. Do one of the following: Download the TARA server (taraserver ) from the Teradata Software Server at: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

30 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation Save the file to your system. On the Teradata Extension for Tivoli Storage Manager CD, go to: Windows\x8664\taraserver \setup.exe 2. Double-click setup.exe. If the Backup Application is not installed, and 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 an upgrade, select Remove in the Welcome dialog box. 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. The TARA Server - InstallShield Wizard dialog box appears. 6. Click Next. The license agreement appears. 7. To accept the agreement and install the TARA server, click Yes. The Choose Destination Location dialog box appears. For an installation location different than what is shown in Destination Folder, click Browseand select an alternate location. 8. Click Next. The Start Copying Files dialog box appears. 9. Click Next if the destination folder is correct. The Setup Status dialog box displays installation status, then displays that installation is complete. 10. Click Finish. 11. At the command-line prompt, type t to install Tivoli, then press Enter. 30 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

31 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 12. 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 Teradata TARA Command-Line Utilities. 13. Press any key to continue. Installing 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 an upgrade, select Remove in the Program Maintenance dialog box. 3. Click OK. InstallShield Wizard Completed verifies the removal of TARA TIVBAR. Go to step 14. The TARA TIVBAR welcome screen appears. 4. Click Next. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

32 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation A license agreement appears. 5. If you agree with the terms of the license, select the radio button indicating consent, then click Next. The Destination Folder screen appears. 6. Accept the default destination, or click Change to browse for another folder. 7. Click Next. The Ready to Install the Program screen appears. 8. Click Install. The status of the installation is displayed. When installation is complete, a dialog appears indicating completed installation. 9. Click Finish. A command-line interface opens. 32 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

33 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation 10. Choose the path for the baruser home directory, following these rules: Choose a folder that already exists. Include a drive letter, followed by a colon (:) at the beginning of the path. Include a backslash (\) at the end of the path. The script automatically appends the name baruser to the path. If no path is entered, the default path, C:\Documents and Settings is created. 11. Press Enter. The baruser directory is created. 12. At the prompt for the name of the TARA server host, enter the name of the BAR server where the TARA server is running, then press Enter. The default is localhost. 13. Press Enter to complete the postinstall script. A connection is made to the TARA server host. 14. Press any key to continue. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

34 Chapter 2: Teradata TARA Installation and Uninstallation Teradata TARA Installation The InstallShield Wizard Completed message appears. 15. Click Finish. The Teradata Extension for Tivoli Storage Manager has been successfully installed. Installing the Teradata TARA GUI 1. From the Teradata Extension for Tivoli Storage Manager CD, double-click 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. The TARA GUI InstallShield Wizard welcome screen appears. 2. Click Next. The license agreement appears. 3. To accept the agreement and install the Teradata TARA GUI, click Yes. The Choose Destination Location dialog box appears. 4. For an installation location different than what is shown in Destination Folder, click Browse and select an alternate location. Otherwise, click Next. The Start Copying Files dialog is displayed with the specified destination. 5. Click Next if the destination folder is correct. The setup status is shown, then a message appears when installation is complete. 6. To create a shortcut icon on the desktop, select that option, then click Finish. 34 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

35 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. Chapter 2: Teradata TARA Installation and Uninstallation Installed Components 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 The install path is referenced by install_path. There are three TARA-related install packages: TARA server install package Teradata TARA GUI install package <<product name>> install package TARA Server Package The Windows install package and Linux taraserver_postinstall.sh script take the actions described in the following table upon installation of the TARA server package. 4: Actions Taken when TARA Server Package Installed Action Creates a new login account. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

36 Chapter 2: Teradata TARA Installation and Uninstallation Installed Components Action Sets up the TARA server to run as a service on the TARA server host. Creates the TARA server install_path directory, /var/opt/teradata/ tara/server. Details None Under this directory, the taraserver_postinstall.sh script creates the jir, sr, logs, and config folders,which are described in the following table. 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 textreadable, 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. /jir /sr /logs /config 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 36 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

37 Under this directory, the bin subdirectory is created. This subdirectory contains the files described in the following table. 6: Files in bin Subdirectory Chapter 2: Teradata TARA Installation and Uninstallation Installed Components 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. The command-line utilities are useful for field personnel who do not have access to the Teradata TARA GUI. 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 directory of baruser. (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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

38 Chapter 2: Teradata TARA Installation and Uninstallation Uninstallation on Windows Create a new login account. The user cannot modify the account name but can modify the home directory. The login account is baruser, and the home directory is /home/baruser or the home directory provided by the user. 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. 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. The following table 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 gui Registry Entry Created During Installation HKEY_LOCAL_MACHINE\TERADATA\TARA Gui Manual Deletion During Uninstallation 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. 38 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

39 Folder Created During Installation server Registry Entry Created During Installation HKEY_LOCAL_MACHINE\TERADATA\TARA Server Chapter 2: Teradata TARA Installation and Uninstallation Uninstallation on Linux Manual Deletion During Uninstallation 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 include the following: The home directory of baruser The defaults file in \config 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: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

40 Chapter 2: Teradata TARA Installation and Uninstallation Rolling Back to a Prior Release config /etc/opt/teradata/tara jir logs sr the defaults file in /etc/opt/teradata/tara home directory of baruser Rolling Back to a Prior Release TARA packages do not automatically revert to a prior minor- or major-point release. A major-point release number is specified by XX.YY.00.00, where XX and YY designate a major release. A minor-point release number is specified by??.??.xx.yy, where??.?? will be the same numbers in the current version and the version to which the package is being rolled back. To roll back to a previous minor- or major-point release: Uninstall the current version of the TARA packages. Install the prior version of the TARA packages. Rollback Considerations There are no special considerations when reverting to a prior minor-point release. When reverting to a major-point release: You cannot revert the package to TARA or earlier. You must: Revert the teradata_arc, CLIv2, PIOM, tdicu, and TeraGSS packages to the same version as the TARA packages that will be installed. Verify that your Teradata Database version is equal to or less than the TARA packages that will be installed. 40 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

41 CHAPTER 3 TSM and Teradata TARA Configuration Overview Configure TSM before configuring Teradata TARA: Configuring TSM for Teradata Backups Configuring the TARA Server Configuring the TARA Server GUI To configure the size of the log file, add an entry in the defaults file. See Configuring the Log File. Configuring TSM for Teradata Backups A Teradata backup can be a backup of an entire Teradata Database, a selected database, or a selected table. To perform a Teradata backup, configure the TSM server first, the TSM client second, then set options for TSM. TSM Server Configuration Before performing any Teradata backups, ensure that the TSM policy objects and TSM client nodes are properly configured in the TSM server. TSM Policy Objects TSM policy objects manage how data is stored, where client data is stored, the number of maintained versions, and the length of time those versions are stored. TSM allows a variety of configurations using TSM policy objects, but regardless of the configuration, 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. The following table 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. 8: Fields to Consider for the Backup Copy Group Field Description Default Versions Data Deleted (VERDELETED) Number of inactive versions, if active versions do not exist. 1 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

42 Chapter 3: TSM and Teradata TARA Configuration Configuring TSM for Teradata Backups Field Description Default Versions Data Exist (VEREXISTS) 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. 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. The following table describes these options. 9: TSM Server Options TSM Server Option COMMTIMEOUT IDLETIMEOUT 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. RESOURCETIMEOUT Specifies the maximum number of minutes that a storage agent waits for a resource on the server. The default value is 60 minutes. The minimum value is 1 minute. 42 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

43 Chapter 3: TSM and Teradata TARA Configuration Configuring TSM for Teradata Backups TSM Server Option TXNGROUPMAX Description 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. 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. TSM Client Options Every time an archive or restore job is run, Teradata TARA creates an options file and sets DSMI_CONFIG to point to this file. Options provided through the Tivoli tab of the TARA Server Configuration dialog box (see Step 4 - Configuring Tivoli Information) creates the <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 in Archiving a Database Object ). The Management Class Selection dialog box appears, in which the node name, password, and user parameters can be changed. The following table describes client user and client system options files. 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 Windows <job_id>.opt Specifies client user options. <job_id>.opt The home directory of baruser 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 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

44 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server GUI 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. Configuring 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. 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 Click Settings > Graphical User Interface Configuration. The Graphic User Interface Configuration dialog box appears. 2. The localhost name is the default and appears in the TARA Server box when the GUI is first run. Enter another TARA server name if the server on which the Teradata TARA GUI is installed changes. 3. The TCP port on which the TARA server listens for GUI and ARC connections appears in the TARA Server Port Number box. 44 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

45 The default is and appears when the GUI is first run. 4. Click Apply to apply changes. Chapter 3: TSM and Teradata TARA Configuration TARA Server Port TARA Server Port 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. 3. Enter the new TARA Server Port Number, and click OK. 4. From the Teradata Tiered Archive/Restore Architecture screen, select Settings > Graphical User Interface Configuration. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

46 Chapter 3: TSM and Teradata TARA Configuration TARA Server Port 5. Enter the new Tara Server Port Number, and click OK. 6. Close all the existing TARA User Interface (UI) windows. 7. Restart the TARA Server and the TARA Client services. 8. Double-click or click Start > All Programs > Teradata Client > TARA GUI. 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 monitors 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 might 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. 46 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

47 Configuring the TARA Server Use the Teradata TARA GUI for this procedure. Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 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 (see Step 1 - Configuring the Teradata Database System) 2. Clients system (see Step 2 - Configuring the Client Systems) 3. Client Groups (see Step 3 - Configuring the Client Groups) 4. Tivoli information (see Step 4 - Configuring Tivoli Information) Click Refresh to populate the Client-Management Class Association and Available Management Classes columns. Note: Do not click Apply until you have completed these four steps. Applying these changes before defining the Tivoli information results in an external query failure. Step 1 - Configuring 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. See Step 4 - Configuring Tivoli Information 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. 1. Click Teradata Tiered Archive/Restore Architecture > Settings > Server Configuration. The TARA Server Configuration dialog box appears with the Teradata tab selected by default. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

48 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 2. 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. To add a Teradata Database system name, click New. To remove a name, select the name, then click Remove. 3. 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. 4. In Teradata TDPID, type the Teradata Database machine name. Usually, the display name and the Teradata TDPID name are the same. 5. 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. 6. 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. 7. Click Single stream or Multi stream. 48 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

49 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 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. 8. 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 (B ) for more detail. 9. Select the Clients tab of the TARA Server Configuration dialog box, then go to Step 2 - Configuring the Client Systems. Step 2 - Configuring 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 Step 4 - Configuring Tivoli Information 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. 1. Select the Clients tab of the TARA Server Configuration dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

50 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 2. 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. 3. 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. 4. Enter the system name of the client node in Client Machine Name. 5. 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. 6. Select the Client Groups tab of the TARA Server Configuration dialog box, then go to Step 3 - Configuring the Client Groups. Step 3 - Configuring 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 Step 2 - Configuring the Client Systems 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. 1. Select the Client Groups tab of the TARA Server Configuration dialog box. 50 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

51 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 2. 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. 3. 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. 4. 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. 5. 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. 6. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

52 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 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. 7. Select the Tivoli tab of the TARA Server Configuration dialog box, then go to Step 4 - Configuring Tivoli Information. Step 4 - Configuring 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 Configuring 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. 1. 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. 52 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

53 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 2. Do one of the following: a. Click ConfigureLANFree for LAN-free mode, which is recommended for TSM. The LAN Free dialog box appears. b. Proceed to step 2. OR a. Clear the Enable LAN Free button for LAN mode. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

54 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server b. Proceed to step 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. 4. Depending on the communication method selected, make the following entries, then click OK. In TCPPort, enter the TCP port to be used for communication between a client and the storage agent In SHMPort, enter the Shared Memory port to be used for processing between a client and the SAN-attached storage device In NamedPipeName, enter the name of the named pipe to be used for communication between the client and the storage agent 5. 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. 6. In TCPServer Address, the address of the TSM server is displayed. Or, enter another address. 7. 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. 8. 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. Note: The Node Name field cannot be blank or null. 9. Enter the password assigned to the TSM client node in Password. Ensure that the password field is not blank. 10. [Optional] In User Parameters, enter any other TSM client options. For example tcpwindowsize 63 or diskbuffsize 64. Refer to TSM Client Options and Tivoli documentation for other client options. 11. In the Client Group drop-down list, the client group that was configured using the Client Groups tab appears. To refresh the list of available clients under Client-Management Class Association, select another group from the drop-down list and click Refresh. Click Default to set the client group displayed in the Client Group drop-down list as the default. 12. The Enter Management Class Name drop-down list contains management classes listed in Available Management Classes. To add a management class to the Available Management Classes list: a. Enter the name. 54 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

55 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server b. Click. To delete a management class from the Available Management Classes list: a. Select it from Enter Management Class Name. b. Click. 13. Client-Management Class Association lists the management classes that have been added to a client node. To view the management class, expand the tree next to the client name. 14. To add or delete a management class, do one of the following. To add a management class to the client node: a. Highlight the client in Client-Management Class Association. b. Highlight the management class in Available Management Classes. c. Click Add. To delete a management class from the client: Highlight the management class listed under the client in Client-Management Class Association, and click Remove. 15. [Optional] To change the order in which a management class is used for a backup or restore job, do one of the following. To move a management class up: Highlight the management class in the Client-Management Class Association list, and 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 the management class in the Client-Management Class Association list, and click Move Down. 16. Click Apply to apply the changes. 17. Select the ARC Options tab of the TARA Server Configuration dialog box, then go to Step 5 - Configuring ARC Options. Step 5 - Configuring 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 Step 3 - Configuring the Client Groups. If this is not a new installation of Teradata TARA, there is no required order of configuration. 1. Select the ARC Options tab in the TARA Server Configuration dialog box. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

56 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 2. [Optional] Select Use Catalog to specify positioning data, so that when an object is restored, Tivoli can locate it without searching the entire tape. 3. [Optional] Select Use Checksum Verification to verify that what it is archiving or restoring is valid data. 4. [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 (B ) for details on valid ARCMAIN command-line options. 5. [Optional] In Extra ARC Options, enter any ARCMAIN command-line options that are not part of the GUI ARC build flow. Step 6 - Configuring Logging If this is a new installation of Teradata TARA, configure logging only after you have completed the first four steps described in TSM Server Configuration. If this is not a new installation of Teradata TARA, there is no required order of configuration. 56 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

57 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 1. [Optional] Check Enable Audit Log to track TARA Server configuration changes. See TARA Server Audit Log 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. Configuring the Log File The default size of the Linux TARA server's logfileis 2GB. When this limit is reached, the TARA server saves the existing log as logfile.prev, then creates a new logfile before writing more log entries. Do not set the value greater than 2GB. Doing so can cause the TARA server to become unresponsive. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

58 Chapter 3: TSM and Teradata TARA Configuration Configuring the TARA Server 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 16.10

59 CHAPTER 4 Backup and Restore Using the GUI Starting the Teradata TARA GUI 1. To check the status of the TARA server service, type: /etc/init.d/tdtaraserver status 2. To start the TARA server service, type: /etc/init.d/tdtaraserver start 3. To start the Teradata TARA GUI: For Linux, type one of the following: /opt/teradata/tara/gui/bin/taragui & cd /opt/teradata/tara/gui/bin./taragui & For Windows, do one of the following: Double-click on if you installed the TARA GUI icon on your desktop. Click Start > All Programs > Teradata Client > TARA GUI. The Logon to TARA Server dialog box appears. 4. Enter the previously configured password. The Teradata Tiered Archive/Restore Architecture dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

60 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object 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. 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. 60 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

61 Logging 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. Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Archiving a Database Object 1. In the left and right panes of the ARCHIVE object selection dialog box are database objects. To archive a database, highlight or select the box next to the database in the left pane. The tables of the database to be archived appear in the right pane. 2. Right-click on a table in the right pane. A dialog box for Partitioned Primary Index (PPI) options appears for that table. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

62 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object 3. Under Partition selection, click on one of the following radio buttons: Full table (default), archives the entire table All Partitions 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. After the database objects are selected, the Selectiondialog box appears. 5. Click OK. The Script Options dialog box appears. 6. Select options: Note: When you create a job in which there is more than one stream per client, you must manually assign each stream a Policy management class, using the Multi stream, Assign Clients, and Management Class options. Option Job Name Description Entries in Job Name are case-sensitive. A job name must not contain any spaces, or these characters: < > 62 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

63 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option Description TDPID User Name Password Single stream or Multi stream Default Group Assign Clients Configure Protegrity Encryption Description ~ " *,? \ / 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. 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. To run more than one stream in a TARA client using the same management class, you must manually configure the Assign Clients and Management Class options. 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. Each stream is defaulted to All clients. Click Assign Clients to assign a specific client (or a specific client group) to each stream. To run more than one stream in a TARA client using the same management class, select a client name from the Client Group/Node drop-down list. The Assign Clients dialog box will have the same number of stream entries as the MultiStream option specified. This option is no longer valid. The Crypto Key Management System (KMS) replaces Protegrity encryption. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

64 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option QueryBanding Online Backup Description [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] 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. 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 (B ) for more information on online archive. Sessions (per stream) The default for the selected database is set in the Teradata tab of the TARA Server Configuration dialog box. A general rule is to have one session per amp being archived in the stream. An adequate number of parallel ARC sessions per stream are necessary to keep data moving. Too few sessions cause ARCMAIN to be the bottleneck during archival. Too many sessions waste resources because some of the sessions remain idle. Refer to Teradata Archive/Recovery Utility Reference (B ) for more detail. Extra Options Backup Application Full Backup or Dictionary Only Use Catalog Verify Checksum [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. [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. 64 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

65 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Option Force online logging off Description [Optional] To stop online logging: a. Check the Online Backup box. b. 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. Character set Management Class Other Buttons Save Launch Preview Close 7. Click Save, then Launch. 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 from one of the following: A group from Configuration from Group A management class for a stream after selecting Manual Selection To run more than one stream in a TARA client using the same management class, click the Manual Selection option in the Management Class Selection screen. Manually assign the management class to each stream in the list. 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. The Teradata Tiered Archive/Restore Architecture dialog box displays the launched job and job streams. Conditions for each stream appear in the State column. (B): Build phase (only for restore operations) (D): Dictionary (for archive and restore operations) (T): Data (for archive and restore operations) Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

66 Chapter 4: Backup and Restore Using the GUI Archiving a Database Object Using 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. 66 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

67 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. Job status can be tracked in the State column of the Teradata Tiered Archive/Restore Architecture dialog box. Creating 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

68 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. Using 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. 68 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

69 Chapter 4: Backup and Restore Using the GUI Selecting Individual Objects to Archive or Restore The following table lists the icons that represent the objects. 11: Object Icons Icon Object Database Function Index Join Index Journal Macro Procedure SQL-H Trigger User Installed File View Schema Object Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

70 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Restoring a Database Object Restoring a Database Use the next procedure to run a restore operation. 1. Click Teradata Tiered Archive/Restore Architecture > Task > Restore. The RESTORE object selection dialog box appears. 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. If the database has a hierarchical view, go to step 3. If the database does not have a hierarchical view, skip to step 4. Double-click on the icon to the left of the object name to expand the tree and show the specific tables to be restored. The following example shows a database example without a hierarchical view. 70 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

71 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object 3. The following example 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

72 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. 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. 5. On the PPI options tab, under Partition selection, click on the radio button for one of these three options: 72 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

73 Full table (default) restores the entire table All Partitions restores all partitions Selected Partitions restores the specified partitions Chapter 4: Backup and Restore Using the GUI Restoring a Database Object 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. 6. Click RESTORE object selection > File > Build ARC script. After the database objects are selected, the Selection dialog box appears. 7. 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 DBCdialog box appears instead of the Script Options dialog box. 8. Select options as described in the following table: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

74 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Job Name 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. Always restore latest [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. 74 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

75 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Default Group Assign Clients Configure RestoreScript CopyScript Analyze QueryBanding QB Options 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. 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 QueryBandingQueryBanding box, specify one or more pairs of names with associated values to identify the source of a query. This allows setting different priorities for different requests, and the ability to make better use of system resources. For example, enter name and value pairs, ending with a semi-colon: aaa=bbb;ccc=ddd; Selecting QueryBanding enables the QB Options button. [Optional] Click QB Options. In 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: Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

76 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Description 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. Sessions (per stream) Extra Options Use Catalog Verify CheckSum 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 (B ) 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. [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. Skip Build Steps Character Set Options Extra Buttons Save Launch [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. 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. 76 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

77 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Option Preview Close Description [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. 9. In the Script Options dialog box, click Save, then Launch. The restore job status appears in the Teradata Tiered Archive/Restore Architecture dialog box. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

78 Chapter 4: Backup and Restore Using the GUI Restoring a Database Object Analyzing Using the 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 (B ). 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. 78 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

79 Chapter 4: Backup and Restore Using the GUI Restoring the Latest Backup Job Analyzing Using the Restore DBC Dialog Box Running 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 Click Done in step Click Generate in step 3. Restoring the 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. 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 Tivoli Storage Manager Administrator Guide, Release

80 Chapter 4: Backup and Restore Using the GUI Restoring a Multistream Archive Using Fewer Streams 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) Click Edit > Update Latest Job Ids. All job IDs are updated in the latestjobs file on the server. b) 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 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. 80 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

81 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: Chapter 4: Backup and Restore Using the GUI Manually Restoring a Multistream Archive Using Fewer Streams a) Double-click the job or stream in the Teradata Tiered Archive/Restore Architecture dialog box. A dialog box appears with the job name. b) Select a stream to display its information in the bottom pane of the dialog box. Manually Restoring a Multistream Archive 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. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

82 Chapter 4: Backup and Restore Using the GUI Manually Restoring a Multistream Archive Using Fewer Streams 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: a. Double-click the job or stream. A dialog box appears. b. Select a stream to display its information in the bottom pane of the dialog box. 10. To 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. 82 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

83 Chapter 4: Backup and Restore Using the GUI Manually Restoring a 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

84 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. Reinitializing the System Before you restore all data from the backup job, delete the DBC database. 1. Run sysinit to reinitialize the system. Refer to Utilities (B ). 2. [Optional] If necessary, reconfigure the system to the desired configuration. 84 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

85 3. Run the DBC Initialization Procedure (DIP) to initialize system views, macros, users, and error message tables. Refer to Utilities (B ). Chapter 4: Backup and Restore Using the GUI Restoring the DBC Database Backup Job Restoring 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 appears. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

86 Chapter 4: Backup and Restore Using the GUI Use a DBC (ALL) Backup Dataset for Analyze or Copy Jobs 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. 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. Use a DBC (ALL) Backup Dataset for Analyze or Copy Jobs If you created a job in which you backed up all of the DBC database, you can use the backup dataset for an analyze or copy job. Analyzing that dataset instance or copying a database or table from that dataset instance requires that you skip the Teradata Database system initialization steps in the DBC (ALL) restore job. Creating the Analyze or Copy 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 performed the DBC (ALL) backup. 3. Click File > Build ARC script. The Restore DBC dialog box opens. 86 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

87 Chapter 4: Backup and Restore Using the GUI Use a DBC (ALL) Backup Dataset for Analyze or Copy Jobs 4. In Step 1, check the Skip Step 1 box. This enables the Done button in Step Click Done. This enables the Generate button in step Click Generate in step 3. The Script Options dialog box appears. 7. Enter a job name. 8. [Optional] If you are creating an analyze job, click Analyze. A warning message appears that restoring database DBC will delete all existing system data. Click OKto dismiss the warning message. 9. [Optional] If you are creating a copy job, click Copy. 10. Click OK on the Script Options dialog box to save the job. 11. Click Launch to launch the job. 12. Click Restore DBC dialog box, click Close. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

88 Chapter 4: Backup and Restore Using the GUI Valid Keywords Valid Keywords The KeyWords for Job Scripts 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. 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 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. 88 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

89 Keyword Required for Backup Required for Restore Rules Description does not appear in the RESTORE object selection dialog box. 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. Chapter 4: Backup and Restore Using the GUI Validating Edited Job Scripts USERID is the Teradata user database logon account that Teradata ARC uses. Validating Edited Job Scripts You should validate any edited job script. Job script errors can result in the TARA server failing. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

90 Chapter 4: Backup and Restore Using the GUI CopyScript Options Keywords 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. No Spaces With the exception of the COMMANDLINE line, there must be no spaces at the end of a line of code. Permitted Characters 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. Stream Values Ensure the number of: STREAM lines matches the MULTISTREAM value STREAMNAME lines (if present) matches the MULTISTREAM value TIVPOLICY lines matches the MULTISTREAM value 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 90 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

91 Accessing CopyScript Options 1. From the Teradata Tiered Archive/Restore Architecturescreen, select Task > Restore. The Restore object selection dialog box appears. 2. From the left pane, select a database to display database objects in the right pane. Chapter 4: Backup and Restore Using the GUI CopyScript Options 3. From the right pane, select two or more consecutive database objects: a) Left-click on the first database object you want to select. b) 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. c) [Optional] To add another object to your list of objects, select the object by pressing Ctrl and leftclick. In the next screen, customer is added to the list of selected objects. 4. In the right pane, right-click. CopyScript options appear. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

92 Chapter 4: Backup and Restore Using the GUI CopyScript Options 5. Go to one of the following sections for instructions on CopyScript options: Checking or Clearing the Selection of Database Objects Renaming and Copying Database Objects into the Same Database Copying into a New Database Checking or Clearing the Selection of Database Objects From CopyScript options, select Check/Uncheck Selection to toggle the checkmarks of highlighted database objects on or off. 92 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

93 Chapter 4: Backup and Restore Using the GUI CopyScript Options Renaming and Copying Database Objects into the Same Database 1. From CopyScript options, select Rename and Copy into Same Database. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

94 Chapter 4: Backup and Restore Using the GUI CopyScript Options The Rename and Copy into Same Database dialog box appears. 2. Enter a new name for each database object, and click OK. 94 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

95 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. Copying into a New Database 1. From CopyScript options, select Copy into New Database. The Copy Into New Database dialog box appears. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

96 Chapter 4: Backup and Restore Using the GUI CopyScript Options 2. Enter the new database name, and click OK. 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 Optionsscreen appears. 5. Enter the job name in the Job Name field. 6. Click Preview. The Script Editorscreen appears displaying the database objects that will be copied into the new database. 96 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

97 Chapter 4: Backup and Restore Using the GUI Excluding s in a Job Script 7. Save the job by clicking Save when the Save Script dialog box appears. Leave the script type as not available. 8. Launch the job. Excluding s in a 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 a Job History To viewa 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

98 Chapter 4: Backup and Restore Using the GUI Deleting Failed Jobs in a Job History Exporting 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. 3. Save the HTML file in any location. Deleting Failed Jobs in a Job History 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. 98 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

99 Aborting Jobs To abort a job, click Abort in the Teradata Tiered Archive/Restore Architecture dialog box. 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 Chapter 4: Backup and Restore Using the GUI Aborting Jobs Searching for Strings in Job Logs You can search for a specific string in a job log instead of logging onto the node and searching for the.out file in the home directory of 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

100 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. Renaming 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: 100 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

101 .arc (archive).res (restore) not available Chapter 4: Backup and Restore Using the GUI Deleting Temporary Files in the baruser Directory Select not available when there is no file extension. 4. Click Save. Deleting Temporary Files in the baruser Directory In Linux, the baruser cron job that monitors the TARA client process automatically cleans up temporary files from the home directory of 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 the home directory of baruser manually, change the first variable in the tcsmon.bat script located in the home directory of baruser from CLEANUP=1 to CLEANUP=0. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

102 Chapter 4: Backup and Restore Using the GUI Deleting Temporary Files in the baruser Directory 102 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

103 CHAPTER 5 taratddsmc Command-Line Utility Overview 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 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. For details, see Syntax Conventions. 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. 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. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

104 Chapter 5: taratddsmc Command-Line Utility Command Line Parameters Running 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. 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 Syntax Conventions, 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 * 104 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

105 Syntax Conventions The taratddsmc utility uses these commands: DELete Backup <pathname> [generation] DELete OBJect <pathname> <generation> <segname> FORMAT <formatstring> HELP <command-type> INActivate BAckup <pathname> INActivate OBJect <pathname> <segname> PROMPT [ ON OFF ] QueRY BAckup <pathname> [generation] [formatstring] QueRY OBJect <pathname> [generation] [segname] [formatstring] QueRY TSM QUIT The commands follow the rules described in Syntax Rules, 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 ] Chapter 5: taratddsmc Command-Line Utility Syntax Conventions 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 leftjustified. The following table lists metadata fields, plus default widths, headings, and format specifiers. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

106 Chapter 5: taratddsmc Command-Line Utility 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% 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 Format Specifiers 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 106 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

107 taratddsmc Help Command The Help command causes taratddsmc to display syntax information for the defined command type. If no command is entered or an invalid command is entered, it is equivalent to HELP HELP. To access taratddsmc help, do one of the following: Start taratddsmc with a question mark character (?). On the command line, type: taratddsmc? When taratddsmc help is started with a question mark (?), the utility does not attempt to open a session with the TSM server. In interactive mode, type: 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. Chapter 5: taratddsmc Command-Line Utility taratddsmc Help Command Query TSM Command QUERY TSM displays information about the current session configuration settings. This is the same information that is written to the log file when diagnostic tracing is enabled. Sample output from the command is shown in the following report. DSMI_DIR DSMI_CONFIG - C:\Program Files\Tivoli\TSM\api - C:\Program Files\Tivoli\TSM\baclient\dsm.opt servername commmethod Note: This path can vary according to the value set in tarativadm. - SERVER1 - TCP/IP serveraddress nodename compress - 0 compressalways - 1 passwordaccess Server name - NODE1 - PROMPT - SERVER1 Server Host Server port Server type - Windows Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

108 Chapter 5: taratddsmc Command-Line Utility Prompt Off Command Servr Date/Time :22:08 Servr Release Client node type Client filespace delimiter - : Client h1 and 11 delimiter - \ Client delete backup obj? - Teradata - No Maximum objects in txn Client Node Name Session Owner - API Config file - Policy Domain Management Class Backup retention grace period - PINOT - STANDARD - STANDARD - 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. 108 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

109 Chapter 5: taratddsmc Command-Line Utility Delete Backup and Delete Object Commands Note: QUERY OBJECTshows one record per storage object whereas the QUERY BACKUP command aggregates totals to have one record per Teradata backup generation. QueRY BAckup namepattern [ gen ][ formatstring ] QueRY OBJect namepattern [ gen ][ segnamepattern ][ formatstring ] The node name context is established at session logon. Tivoli API limitations cause case-sensitive matching on the name patterns. The optional gen field filters output to specific backup file generations. The default value of zero for the gen field restricts output to only the most recent generation of a backup. An asterisk (*) character in the gen field qualifies for all versions of the qualified backups. Relative generation numbers, such as -1 for the second-tolast 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. 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 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

110 Chapter 5: taratddsmc Command-Line Utility Inactivate Backup and Inactivate Object Commands 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. Notice: If the TSM server policy limits the number of inactive versions of a storage object, the oldest version might expire. For more details about the TSM storage management policies, refer to the Tivoli Storage Manager for Windows: Administrator s Guide. 110 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

111 CHAPTER 6 Teradata TARA Command-Line Utilities Overview 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 TARALaunch 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 rereading 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 standalone, 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

112 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 or -j is required. -L - (required) -- display summary list -s <TARA servername> - (optional) -P <port> - (optional) -f <output file name> - (optional) -v <verbose level: 1 2 3> - (optional) full_name - (optional) The full_name option prints the entire job name. If you do not use the full_name option, only the first 30 characters are displayed. 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 ARC 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] The following table describes TARAJobQuery parameters, and indicates if the parameter is required. 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 Yes Not Applicable 112 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

113 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Parameter Description Required Default administrator and user. The user just has the read-only privilege. Example TARAJobQuery -u administrator -p <password> Specifies the password for the user name the utility uses to connect to the TARA Server. Example TARAJobQuery -u administrator -p xjmt94rs -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. -L 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 run 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 Yes Yes Not Applicable Not Applicable Not Applicable full_name Modifies the -L option only. Prints the entire name of the job. If you do not use the full_name option, only the first 30 characters of the job are No Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

114 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Parameter Description Required Default displayed. (The JobId (-j) option always displays the entire TARA job name.) -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. Yes Not Applicable -s <TARAServer_nam e> 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. The default is 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 xflu7k3m - j MyBackupJob -P The default is 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 No localhost No No cest 114 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

115 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Parameter Description Required Default 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. The default is cest. -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: No sty 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. The default is sty. -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: No Not Applicable Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

116 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Parameter Description Required Default <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. -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 No If this parameter is not specified, the ARC output that the TARA 116 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

117 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Parameter Description Required Default -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. If this parameter is not specified, the ARC output that the TARA job generates will not be stored in a user-specified file. 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. 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. If this parameter is not specified, debug information will not display. No If this parameter is not specified debug information will not display 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 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 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

118 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Sample List Option Output This 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 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_SIBT Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

119 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 DBNAMETEST Database DBC DRXXX13 Database DBC T1 SMALLDBNAME Database dbnametest smalltbname SYSADMIN Database DBC FastLog HelpSyntax SYSLIB Database DBC SYSTEMFE Database DBC CleanupQCF Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

120 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 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 t3_ppi Dbase ARCUSER Database DBC ARPTEST Database ARCUSER INDEXTABLE LOBTABLE PPITABLE BARP_FAOCPU Database DBC BARP_FAOU Database DBC BARP_FAOD Database BARP_FAOU 120 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

121 Chapter 6: Teradata TARA Command-Line Utilities TARAJobQuery 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 Database DBC BARP_ERR_TBL CRASHDUMPS Database DBC DBNAMETEST Database DBC COPY29CHARDBNAMEWWWXXXXXYYYYY Database dbnametest twentyninechartbnamexxxxyyyyy COPY30CHARDBNAMEWWWXXXXXYYYYYZ Database dbnametest thirtychartbnamewwwxxxxxyyyyyz COPYSMALLDBNAME Database dbnametest smalltbname SMALLDBNAME Database dbnametest smalltbname THIRTYCHARDBNAMEWWWXXXXXYYYYYZ Database dbnametest thirtychartbnamewwwxxxxxyyyyyz TWENTYNINECHARDBNAMEXXXXYYYYY Database dbnametest twentyninechartbnamexxxxyyyyy DRXXX13 Database DBC T1 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 AccessRights AccLogRuleTbl Accounts CollationTbl Dbase Hosts Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

122 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM LogonRuleTbl Next OldPasswords Owners Parents Profiles RCConfiguration RCEvent RCMedia RepGroup RoleGrants Roles SysSecDefaults Translation UDTCast UDTInfo UDTTransform 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 OR -e <path to encoded password file> -s <taraserver> -P <port> -S [<script_name> : -f <input_file] [-v 0:1:2:3] 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 in the Example sections. Example Connect to TARA Server tarajobrm -u [ <username> ] -p [ <password> ] OR -e [ <path to encoded file> ] -S [ <script_name> -f <input_filename> ] 122 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

123 [ -s <TARAServer_name> ] [ -v ] [ -P <Port> ] Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM Example Delete TARA Job File or TARA Script tarajobrm -J [ <jobfile_name> -f <input_filename> ] [ -s <TARAServer_name> ] [ -v ] [-F] TARAJobRM Parameters 15: Parameters for TARAJobRM 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 -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 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 Yes Yes Not Applicable Not Applicable No Yes Not Applicable Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

124 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM Parameter Description Required Default 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 <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. This parameter, or the -J <jobfile_name > parameter, is required. -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. No This parameter, or the -S <script_name> parameter, is required. 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. 124 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

125 Chapter 6: Teradata TARA Command-Line Utilities TARAJobRM Parameter Description Required Default -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. -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 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. TARAJobRM Return Codes The following table lists TARAJobRM return codes. 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). Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

126 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch Return Code Description 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. 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 command-line 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) 126 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

127 -u <username> - (required) -p <password> - (required) Chapter 6: Teradata TARA Command-Line Utilities TARALaunch 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) -s <TARA servername> - (optional) -v <verbose level: > - (optional) TARALaunch Parameters The following table 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: < > Yes (job launch option only) Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

128 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch Parameter Description Required ~ *,? \ / 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" -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 -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 Yes Yes Yes 128 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

129 Parameter Description Required 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. Chapter 6: Teradata TARA Command-Line Utilities TARALaunch -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 s <TARA servername> -v <verbose level: > 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. 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. See the TARAJob Launch Return Codes table for these return values. No No No Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

130 Chapter 6: Teradata TARA Command-Line Utilities TARALaunch Parameter Description Required 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. -w <seconds-towait> 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. The TARAJob Launch Return Codes table 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 The following table 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 130 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

131 Code Number Description 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. 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. Chapter 6: Teradata TARA Command-Line Utilities TARALaunch Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

132 Chapter 6: Teradata TARA Command-Line Utilities taraping Code Number Description 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 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] The following table describes taraping parameters. 132 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

133 19: Parameters for taraping Chapter 6: Teradata TARA Command-Line Utilities taraping 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, ). Example -s localhost Example -s TARA server name defaults are: localhost No -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. The default is 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), 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. The verbose level default is 1, which generates no display unless the test fails. No The following table 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 # echo $? 0 # Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

134 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg # /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] The following table describes TARASetCfg parameters, and indicates if the parameter is required. 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 Yes Yes Not Applicable Not Applicable 134 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

135 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg Parameter Description Required Default TARASetCfg -u adminstrator -p xjmt94rs -e <path to encoded password file> Specifies the path to the file that contains the encoded password to the User Name. Example TARASetCfg -u administrator -e C:\Teradata\tara.pwd Yes Not Applicable 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 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 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 No localhost No No If this parameter is Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

136 Chapter 6: Teradata TARA Command-Line Utilities TARASetCfg Parameter Description Required Default 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. 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. 136 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

137 CHAPTER 7 Teradata TARA Troubleshooting Overview This chapter describes the TARA troubleshooting utility and support information for Teradata Customer Support, and discusses errors associated with Teradata Extension for Tivoli Storage Manager. Troubleshooting information on Teradata TARA components is also provided. Using the Troubleshoot Utility The troubleshoot utility provides problem and remedy details for any ARC or Teradata Extension for Tivoli Storage Manager errors for TARA jobs. 1. From the Teradata Tiered Archive/Restore Architecture screen, click Help > Troubleshoot. Teradata Extension for Tivoli Storage Manager Administrator Guide, Release

138 Chapter 7: Teradata TARA Troubleshooting Using the Troubleshoot Utility The Troubleshoot screen appears. 2. Enter the Error Code. 138 Teradata Extension for Tivoli Storage Manager Administrator Guide, Release 16.10

139 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-the-clock, seven days a week through the Global Technical Support Center (GSC). 1. Locate the script at /opt/teradata/tara/support/bin. 2. Run supportbundle.sh to create a diagnostic bundle on the TARA server. 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