NetVault Backup Teradata Plugin Users Guide English

Download as pdf or txt
Download as pdf or txt
You are on page 1of 110

NetVault: Backup

Teradata Plugin
version 12.2
Version: 12.2Product Number: TRG-101-12.2-EN-01

Users Guide

TRG-101-12.2-EN-01 10/08/10

Copyrights
NetVault: Backup Teradata Plugin Users Guide
Software Copyright 2010 BakBone Software
Documentation Copyright 2010 BakBone Software
This software product is copyrighted and all rights are reserved. The distribution and sale of this
product are intended for the use of the original purchaser only per the terms of the License
Agreement. All other product trademarks are the property of their respective owners.
The NetVault: Backup Teradata Plugin Users Guide documentation is copyrighted and all rights
are reserved.
This document may not, in whole or part, be copied, photocopied, reproduced, translated,
reduced or transferred to any electronic medium or machine-readable form without prior consent
in writing from BakBone Software.

Teradata, ARCmain, BTEQ and BYNET are registered trademarks of the Teradata
Corporation. All references made within this documentation used with permission from
Teradata Corp.
THIS PUBLICATION IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT.
THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED INTO NEW EDITIONS OF THE PUBLICATION.
BAKBONE SOFTWARE MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE
PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS PUBLICATION AT ANY
TIME.
1999-2010 BakBone, BakBone Software, NetVault, Application Plugin Module, BakBone
logo, Integrated Data Protection, SmartDisk, Asempra, and FASTRecover are all
trademarks or registered trademarks of BakBone Software, Inc., in the United States and/or in
other countries. All other brands, products or service names are or may be trademarks,
registered trademarks or service marks of, and used to identify, products or services of their
respective owners.

BakBone Software
9540 Towne Centre Drive, Suite 100 San Diego, California 92121 866.484.2663

Table of Contents
Preface

About this Document ....................................................................................................... 7


Target Audience ................................................................................................................ 7
Organization ...................................................................................................................... 7
Recommended Additional Reading ................................................................................ 8
Technical Support ............................................................................................................ 8

Chapter 1: Introducing NetVault: Backup Teradata Plugin

11

NetVault: Backup Teradata Plugin At a Glance ......................................................... 11


Feature Summary ........................................................................................................... 11

Chapter 2: Installing Teradata Plugin

13

Setting Up the Teradata Backup System ...................................................................... 13


- Traditional Architecture .................................................................................................................. 13
- BAR Framework ............................................................................................................................. 14

Prerequisites ................................................................................................................... 15
Installing Teradata Plugin .............................................................................................. 16
Installing the License Key .............................................................................................. 16
Removing Teradata Plugin ............................................................................................. 17

Chapter 3: Configuring Teradata Plugin

19

Configuring the Default Settings ................................................................................... 19


- Using Remote Configurator to Configure the Default Settings ...................................................... 27
- Using NetVault: Backup Configurator to Configure the Default Settings ....................................... 27

Adding Teradata DBS ..................................................................................................... 27


- Reconfiguring the Cluster Count .................................................................................................... 28
- Removing a DBS ........................................................................................................................... 28

Adding BAR Servers ...................................................................................................... 29


Enabling Communication Between the Teradata Master Plugin and BAR Servers .. 30
Configuring a Default Login Account ........................................................................... 30

Table of Contents

Creating or Upgrading the Catalog Database ...............................................................31


Creating User Accounts for Parallel Restores .............................................................32
- Creating Restore Accounts ............................................................................................................ 33
- Granting Privileges to the Accounts ............................................................................................... 34

Defining Encryption Algorithms ....................................................................................35

Chapter 4: Backing up Data with Teradata Plugin

37

Available Backup Methods .............................................................................................38


-

Full Backup .................................................................................................................................... 39


Full On-line Backup ........................................................................................................................ 39
Full Clustered Backup .................................................................................................................... 39
Full Clustered On-line Backup ....................................................................................................... 40
Full Multi-stream Backup ............................................................................................................... 40
Full Multi-stream On-line Backup ................................................................................................... 41
Incremental Backup ....................................................................................................................... 41
Data Dictionary Backup ................................................................................................................. 42
User-defined Backup Scripts ......................................................................................................... 42

Performing Full and Full On-line Backups ....................................................................42


-

Selecting Data for a Backup .......................................................................................................... 42


Choosing the Backup Method ........................................................................................................ 45
Configuring the Backup Options .................................................................................................... 45
Choosing the BAR Server to Run Backup ..................................................................................... 48
Finalizing and Submitting a Job ..................................................................................................... 48

Performing Full Clustered and Full Clustered On-line Backups ................................49


Performing Full Multi-stream and Full Multi-stream On-line Backups .......................50
Archiving Selected Partitions of PPI Tables .................................................................52
-

Considerations While Archiving Partitions ..................................................................................... 52


Procedure for Backing up PPI Partitions ........................................................................................ 52
Modifying the PPI Filter Expression ............................................................................................... 54
De-selecting PPI Partitions ............................................................................................................ 54

Performing Incremental Backup ....................................................................................54


Backing up Only Data Dictionary ...................................................................................55
Resuming a Job From Last Checkpoint ........................................................................55
Generating ARC Scripts Only ........................................................................................56
Backing up Data with User Scripts ................................................................................57
Managing the Catalog Database ....................................................................................57
- Performing Catalog Database Maintenance from the Plugin GUI ................................................. 58
- Performing Catalog Database Maintenance from the CLI ............................................................. 58

NetVault: Backup Teradata Plugin


Users Guide

Using Selection Sets ...................................................................................................... 59


- Creating a Selection Set ................................................................................................................ 60
- Loading a Selection Set ................................................................................................................. 60

Additional Notes ............................................................................................................. 60

Chapter 5: Restoring Data with Teradata Plugin

63

Available Restore Methods ............................................................................................ 64


-

Restore .......................................................................................................................................... 64
Copy ............................................................................................................................................... 65
Analyze .......................................................................................................................................... 65
User-defined Restore Scripts ......................................................................................................... 65

Restoring or Copying All-AMPs Archives .................................................................... 66


-

Selecting Data for a Restore .......................................................................................................... 66


Connecting to the Target DBS ....................................................................................................... 67
Choosing the Restore Method ....................................................................................................... 67
Configuring the Restore Options .................................................................................................... 67
Recovering Tables and Databases ................................................................................................ 69
Choosing the BAR Server to Run the Job ..................................................................................... 70
Finalizing and Submitting a Job ..................................................................................................... 70

Restoring or Copying Cluster Backups ........................................................................ 70


Restoring or Copying Multi-stream Archives .............................................................. 72
Restoring or Copying Selected Partitions .................................................................... 74
Restoring Incremental Backups .................................................................................... 75
Restoring Dictionary Archives ...................................................................................... 76
Renaming Objects During Restore ............................................................................... 76
Copying Data to an Alternate Database ........................................................................ 78
Analyzing Archive Media ............................................................................................... 79
Generating ARC Script Only .......................................................................................... 80
Restoring Data with User Scripts .................................................................................. 80
- Restoring Data from User Script Backups ..................................................................................... 81
- Restoring Data from Plugin Backups with User Scripts ................................................................. 81
- Dumping Restore Map ................................................................................................................... 83

Additional Features Available on the Selections Tab .................................................. 83


Additional Notes ............................................................................................................. 84

Chapter 6: Viewing Logs and Job Progress

87

Monitoring Job Progress ............................................................................................... 87

Table of Contents

- Viewing Job Progress Information for All-AMPs Jobs .................................................................... 88


- Viewing Job Progress Information for Cluster Jobs ....................................................................... 89
- Viewing Job Progress Information for Multi-stream Jobs ............................................................... 90

Accessing Job Logs .......................................................................................................92

Appendix
Appendix A: Glossary

97

Appendix B: Migrating the NetVault: Backup Server

99

Prerequisites ....................................................................................................................99
Procedure for Migrating the Server ...............................................................................99

Appendix C: Creating User Scripts

103

Guidelines for Creating User Scripts ..........................................................................103


- Logon String ................................................................................................................................. 103
- Backup Scripts ............................................................................................................................. 103
- Restore Scripts ............................................................................................................................ 104

Appendix D: NetVault: Backup CLI Considerations

105

NetVault: Backup CLI and the Teradata Plugin ...........................................................105


- Supported CLI Commands .......................................................................................................... 105
- CLI Commands Providing Limited or No Functionality ................................................................ 106

Appendix E: Troubleshooting

109

Common Errors .............................................................................................................109

NetVault: Backup Teradata Plugin


Users Guide

PREFACE
About this Document
This guide describes how to install, configure, and use the NetVault: Backup
Teradata Plugin to protect your data.

Target Audience
This guide is intended for system administrators, database administrators, and
other technical personnel who are responsible for the backup and recovery of
Teradata database. An understanding of Teradata database administration and the
operating system under which you are running the database is assumed.

Organization
The User's Guide is organized as follows:

Chapter 1: Introducing NetVault: Backup Teradata Plugin provides an


overview of the plugin.

Chapter 2: Installing Teradata Plugin describes the pre-installation


requirements, and the procedures for installing and removing the plugin.

Chapter 3: Configuring Teradata Plugin describes how to configure the


default settings for the plugin.

Chapter 4: Backing up Data with Teradata Plugin how to use the plugin to
perform backups.

Chapter 5: Restoring Data with Teradata Plugin describes how to use the
plugin to restore and recover data.

Chapter 6: Viewing Logs and Job Progress describes how to obtain the job
progress information and access the job logs.

Appendix A: Glossary

Appendix B: Migrating the NetVault: Backup Server describes how to migrate


the NetVault: Backup Server from an MP-RAS UNIX platform to a Windows or
Linux platform.

Appendix C: Creating User Scripts provides general guidelines for writing


archive and restore scripts that can be run using the plugin.

Appendix D: NetVault: Backup CLI Considerations provides additional


information on using the NetVault: Backup CLI Utility with the plugin.

Appendix E: Troubleshooting provides troubleshooting information for some


commonly encountered errors.

Preface

Recommended Additional Reading

NetVault: Backup Documentation

NetVault : Backup Installation Guide This guide provides complete


details on installing the NetVault: Backup Server and Client software.

NetVault: Backup Administrators Guide This guide describes how to


use NetVault: Backup and provides comprehensive information on all
NetVault: Backup features and functionality.

NetVault: Backup Configuration Guide This guide explains how to


change the preferences and default settings for NetVault: Backup.

You can download these guides from the BakBone website at the following
address:
http://www.bakbone.com/documentation

Teradata Archive/Recovery Utility Reference Guide This guide explains


how to use Teradata Archive/Recovery Utility (Teradata ARC) to archive,
restore and recover Teradata database, and provides a detailed description
of the ARC commands.
http://www.info.teradata.com/DataWarehouse/eTeradataBrowseBy.cfm?page=Teradata%20Tools%20and%20Utilities

Teradata Database Administration Guide This guide provides information


on database administration tasks and tools, and explains how to create and
manage Teradata database objects.
http://www.info.teradata.com/DataWarehouse/eTeradataBrowseBy.cfm?page=Teradata%20Database

Technical Support

Teradata Telephone Support The support information for the NetVault:


Backup Teradata Plugin customers having a technical support contract with
Teradata is given below:

U.S. Customers Call 1 - 877 698 3282

Outside U.S.A Contact your local area representative. The relevant


telephone number may be found in your localized documentation.

BakBone Software Technical Support The customers having direct


technical support contract with BakBone Software, Inc. can obtain worldwide
technical support by telephone, via the web form or by e-mail. For complete
details, refer to BakBones corporate web site:
http://www.bakbone.com/support/support.asp

Teradata Service and Support Links Customer support is available


around-the-clock, seven days a week. Trained professionals at Remote

NetVault: Backup Teradata Plugin


Users Guide

Services Centers (RSC) are available to assist you. To learn more about
Teradata Customer Services, go to Teradata @ Your Service at
http://www.Teradata.com/TeradataAtYourService
RSCs were formerly called MSCs (Managed Service Centers).
If you have purchased an ESS (Enterprise System Support) contract, a
customized support plan was created for you. Refer to your support plan for
contact information. In addition, a unique PIN (Personal Identification
Number) was given to your site. If you are an ESS customer, you must
contact the regional RSC to request support, and you must use your PIN.
PINs are not published; if you misplace your PIN contact your account
representative.

Teradata Information Links

Information Products Web Site The Information Products site provides


Technical Documentation at URL:

Teradata Web Site Provides the latest news, upcoming events, analyst
reports, benchmark publications, and customer stories all tailored to
your industry, your business and your needs at URL:

http://www.info.teradata.com

http://www.teradata.com

Teradata Resource Center Web Site The latest Teradata Product and
Solution brochures, Industry Solution brochures, as well as customer
success stories and third party analyst reports at URL:
http://www.teradatalibrary.com
Data Storage products are listed at:
http://www.teradatalibrary.com/datastorage.htm

BakBone Software Information and Downloads

Corporate Web Site Information on general BakBone Software


products can be obtained from our corporate web site, URL:
http://www.bakbone.com

NetVault Teradata FTP Site The latest information, technical manuals


and NetVault software CERTIFIED for use with Teradata BAR Solutions is
provided in an FTP site, URL:
ftp://ftp.bakbone.com/public/teradata
Downloads may be carried out via a web browser (recommended), or by
using an FTP client with login anonymous and password <your email
address>.

10

Preface

NetVault: Backup Teradata Plugin


Users Guide

11

Chapter 1:

INTRODUCING NETVAULT:
BACKUP TERADATA PLUGIN
This chapter provides an overview of the NetVault: Backup Teradata Plugin. The
information in this chapter is organized into the following topics:

1.1.0

NetVault: Backup Teradata Plugin At a Glance

Feature Summary

NetVault: Backup Teradata Plugin At a Glance


The NetVault: Backup Teradata Plugin (Teradata Plugin) makes backup and
recovery of Teradata database easy to perform and manage, allowing you to
implement your backup policies from a point-and-click GUI without any complex
scripting. Utilizing Teradata Archive and Recovery Utility (ARC), the plugin
automatically generates ARC scripts for the backup and recovery of selected
databases, tables, PPI partitions and other database objects. You can choose the
All-AMPs method, or take advantage of parallelism provided by the Cluster and
Multi-stream methods for increased throughput and fault tolerance while designing
your backup strategy. Support for granular restores reduces downtime and allows
you to resume normal operations quickly in the unfortunate event of failure.

1.2.0

Feature Summary

All-AMPs, Cluster and Multi-stream methods for backing up and restoring


data

Full, Full On-line, Full Clustered, Full Clustered On-line, Full Multi-stream and
Full Multi-stream On-line backup types

Incremental backups of after-change journal images

Backup and restore entire database, or selected tables and database objects

Data Dictionary backup type

Parallel jobs for better performance and fault tolerance

Backup encryption on Linux and Windows

Checkpoint restarts

Roll forward with after-change journal images

Restore data to alternate Teradata DBS configuration

Generate ARC scripts without actually running the jobs

12

Chapter 1
Introducing NetVault: Backup Teradata Plugin

Analyze archive media

Run user-defined ARC scripts

Single point progress monitoring for parallel jobs

Job scheduling

Integration with a wide range of backup devices

Intuitive point-and-click GUI

NetVault: Backup Teradata Plugin


Users Guide

13

Chapter 2:

INSTALLING TERADATA PLUGIN


This chapter describes the pre-installation requirements, and the procedures for
installing and removing the Teradata Plugin. The information in this chapter is
organized into the following topics:

2.1.0

Setting Up the Teradata Backup System

Prerequisites

Installing Teradata Plugin

Installing the License Key

Removing Teradata Plugin

Setting Up the Teradata Backup System


The Teradata backup system can be viewed as two possible architecture:

2.1.1

Traditional Architecture

BAR Framework

Traditional Architecture
The traditional approach is the direct-attached architecture in which the tape
drives and libraries are connected directly to the Teradata nodes. The Teradata
Plugin runs on the DBS nodes, which initiate the backup and restore jobs.

Figure 2-1:
An example of
legacy directattached
configuration

14

Chapter 2
Installing Teradata Plugin
Teradata has moved away from this architecture and does not recommend it to the
new customers. However, support will continue to protect the investment of the
existing customers. The direct-attached configuration is only available on MP-RAS
UNIX. It is not supported on Windows or Linux.

2.1.2

BAR Framework
The recent and the recommended approach for all platforms is the BAR
framework. In this architecture, backups and restores are managed by dedicated
BAR Servers that are connected to the Teradata DBS nodes via Gigabit Ethernet
LAN. This approach off loads the BAR work from Teradata nodes and offers better
scalability. Additionally, this approach supports disk backups and sharing of
devices. These features are not available in the direct-attached architecture.

Figure 2-2:
An example of
BAR
framework

Teradata System
Node
1

Node
2

Node
3

Node
4

Node
5

Node
6

Node
7

Node
8

Gbit Switch

BAR
Server

BAR
Server

BAR
Server

BAR
Server

BAR
Server

Teradata
Master
Plugin

Teradata
Slave
Plugin

Teradata
Slave
Plugin

Teradata
Slave
Plugin

Teradata
Slave
Plugin

NetVault
Server

NetVault
Client

NetVault
Client

NetVault
Client

NetVault
Client

Robotic Control
Path
Tape Library
541A012

You can also install multiple Teradata systems at a single site, which can be
configured within a single or multiple NetVault: Backup Domains. When setting up
multiple NetVault: Backup Domains, ensure that each Teradata system has
access to separate backup devices. To understand the different ways to configure
the BAR Servers, consult the Teradata Global Support Center, or the BakBone
Software Teradata OEM Group, in San Diego, California, USA.

15

NetVault: Backup Teradata Plugin


Users Guide
Figure 2-3:
An example of
two Teradata
systems at a
single site

Shared
Library
Teradata
Production
System
(4 nodes)

BAR
Server
NVServer

Robotics
9200

Shared Library
w/Shared
Tape Drives

BAR
Server

Teradata
Production
System

NVClient

(4 nodes)

Robotics

BAR
Server
NVServer

9200

BAR
Server
NVClient

BAR
Server

BAR
Server

NVClient

NVClient

Teradata
Development
System

BAR
Server

Teradata
Development
System

BAR
Server

(2 nodes)

NVClient

(2 nodes)

NVClient

Fibre
Channel
Switch

541A013

2.2.0

Prerequisites
Before starting the plugin installation, refer to the following notes and complete the
required tasks:

Install the NetVault: Backup Server software on the designated machine. This
machine can be a BAR Server or any other machine outside the Teradata
DBS system. The Server machine can run any supported operating system
regardless of the DBS operating system.
The NetVault: Backup Server is the core software that provides backup
management services and controls all the operations and devices (including
the logical control of robotics). For instructions on installing the NetVault:
Backup Server software, refer to the NetVault: Backup Installation Guide.

Select the Teradata Master Plugin node. The NetVault: Backup Server
configured as the Teradata Master Plugin is suitable in most cases. However,
you can also choose one of the BAR Servers or any other machine on the
network to serve as the Teradata Master Plugin node.

Install the NetVault: Backup Client software on the BAR Servers and the
Teradata Master Plugin node (if this machine is not configured as the
NetVault: Backup Server). For instructions on installing the NetVault: Backup
Client software, refer to the NetVault: Backup Installation Guide.

Install Teradata Tools and Utilities (TTU) on the Teradata Master Plugin node
and the BAR Servers. The Teradata Plugin v12.x requires TTU 13.0 or later.

For multi-stream backups and restores, set up a Teradata ARC Server (TARA
Server). This Server facilitates communication between the ARC processes.

16

Chapter 2
Installing Teradata Plugin

2.3.0

Install Protegrity Defiance BAR Encryption Module on the BAR Servers on


which you want to run encrypted backups. The encryption feature is only
supported on Linux and Windows.

Add NetVault: Backup Clients to the NetVault: Backup Server. For


instructions, refer to the NetVault: Backup Administrators Guide.

Add the backup devices to the NetVault: Backup Server. For instructions,
refer to the NetVault: Backup Administrators Guide.

Installing Teradata Plugin


To install the Teradata Plugin, perform the following steps.
Note: In order to upgrade the Teradata Plugin, you must first remove the existing
version of the plugin. For details on removing the plugin, refer to Removing
Teradata Plugin on page 17.
1. Open the Client Management window on NetVault: Backup Server. (Click
Client Management on the toolbar or Large Buttons panel. Alternatively, on
the Administration menu, click Client Management.)
2. Under Clients, locate the Teradata Master Plugin node/BAR Server.
Right-click this node, and select Install Software.
3. In the browse window, navigate to the location of the .npk installation file for
Teradata Plugin (on the installation CD or the directory to which the file was
downloaded from BakBone Software's web site). Depending on the operating
system, the file path for this software may vary on the installation CD.
4. Select the file named tera-x-x-x-x.npk (where x-x-x-x represents the
platform and version number), and click Open to begin the plugin installation.
Upon completion, a message will be displayed.

2.4.0

Installing the License Key


BakBone recommends that you install the permanent license keys for NetVault:
Backup and Teradata Plugin before the 45-day evaluation period expires. The
permanent license keys can be requested at http://licenses.bakbone.com. To
install the permanent license keys for the software, perform the following steps:
1. Open the Client Management window.
2. Under Clients, locate the Teradata Master Plugin node/BAR Servers.
3. Right-click this node, and select Install License Key to open the License
Key Installation window.

NetVault: Backup Teradata Plugin


Users Guide

17

Figure 2-4:
License Key
Installation
window

4. Enter (or copy/paste) the license key in the Enter Key String box.
5. Click OK.

2.5.0

Removing Teradata Plugin


To remove the Teradata Plugin, perform the following steps:
1. Open the Client Management window.
2. Under Clients, locate the BAR Server on which the Teradata Plugin is
installed. Right-click this node, and select Remove Software.
3. In the Remove Software window, select Teradata in the list of plugins and
click Remove.
4. In the confirmation dialog, click OK.

18

Chapter 2
Installing Teradata Plugin

NetVault: Backup Teradata Plugin


Users Guide

19

Chapter 3:

CONFIGURING TERADATA
PLUGIN
This chapter describes how to configure the default settings for the Teradata
Plugin. The information in this chapter is organized into the following topics:

Configuring the Default Settings

Using Remote Configurator to Configure the Default Settings

Using NetVault: Backup Configurator to Configure the Default Settings

Adding Teradata DBS

Reconfiguring the Cluster Count

Removing a DBS

Adding BAR Servers

Enabling Communication Between the Teradata Master Plugin and BAR


Servers

Configuring a Default Login Account

Creating or Upgrading the Catalog Database

Creating User Accounts for Parallel Restores

Creating Restore Accounts

Granting Privileges to the Accounts

3.1.0

Revoking Privileges from the Accounts

Defining Encryption Algorithms

Configuring the Default Settings


After installing the plugin, configure the default settings for the plugin. Start with
the Teradata Master Plugin as the plugin cannot be accessed on any other node
until this node is set up. Then, repeat the procedure on each BAR Server on which
the plugin is installed. You cannot use the plugin for backups and restores until this
procedure is completed. To configure the default settings for the plugin, perform
the following steps:
1. Open the Backup window on the NetVault: Backup Server. (Click Backup on
the toolbar or Large Buttons panel. Alternatively, on the Operations menu,
click Backup.)
2. On the Selections tab, locate the Teradata Master Plugin Node/BAR Server.
Double-click this node, or right-click and select Open.

20

Chapter 3
Configuring Teradata Plugin
3. Locate Teradata in the list of plugins. Right-click this node, and select
Configure.
You can also access the Configure window using the methods described in
the following sections:

Using Remote Configurator to Configure the Default Settings

Using NetVault: Backup Configurator to Configure the Default Settings

4. Configure the following parameters:


Figure 3-1:
Configure
window for
Teradata
Plugin

NetVault: Backup Teradata Plugin


Users Guide

21

Node is the Teradata Master Plugin Select Node is the Teradata


Master Plugin check box on the machine that is serving as the Teradata
Master Plugin node. The Teradata Master Plugin controls the Teradata
DBS backups and restores. You can browse the DBS system, and
schedule jobs only from the Teradata Master Plugin node. On the other
BAR Servers, this check box must remain clear.

Path to ARCMAIN Utility Enter the file path for the ARCMAIN utility.

Additional ARCMAIN Command Line Enter the additional run-time


parameters that you want to pass with the ARC jobs. For example,
CHECKSUM=1 for data integrity verification during restore, or
CHECKSUM=2 for data integrity verification during all backups and
restores.
In order to pass multiple parameters, separate them using commas or
white spaces as delimiter. If a value contains comma or white space,
enclose it within single or double quotes. Refer to the Teradata Archive/
Recovery Utility Reference Guide for more information on run-time
parameters.

Path for Teradata Plugin and ARC Working Files The working
directory path must be relative to the NetVault: Backup installation
directory, regardless of whether NetVault: Backup is installed on the
default installation directory or a custom directory. By default, the working
directory is set to the following relative path:

MP-RAS teradata

Linux teradata

Windows Teradata

Access Module Block Size (kilobytes) This parameter specifies the


size of the data block Teradata sends to NetVault: Backup and is intended
for use in a future release. Do not change this parameter.

Allow Use of Network Attached Devices Select this option to enable


use of network devices for backups and restores. This setting applies to
all backup and restore jobs. You can override the settings on a per-job
basis via the Backup Options and Restore Options tabs.

Use ARC Catalog To store the backup information in a catalog, select


the Use ARC Catalog check box. A catalog allows direct tape positioning
during restore and copy operations, resulting in quicker data retrieval. In
addition to selecting this check box, you must also configure the catalog
database name in the ARC Catalog Database box to use catalog for
backups performed using the Teradata Plugin.

22

Chapter 3
Configuring Teradata Plugin

ARC Catalog Database By default, the catalog database is named


$NETVAULT_CATALOG, which can be changed to any valid database
name in Teradata. Before you begin using the plugin for backups, you
must create the catalog database. For details, refer to Creating or
Upgrading the Catalog Database on page 31. If you are running more
than one Teradata DBS, create a catalog with the same name on each
DBS.

Number of Restore Accounts for Parallel Restores For restoring


cluster archives in parallel, the Teradata Plugin requires multiple user
accounts to spawn concurrent jobs on the BAR Servers. Teradata ARC
does not allow concurrent restore operations by the same user.
In the Number of Restore Accounts for Parallel Restores box, enter
the total number of user accounts that can be used for parallel restores.
The number of restore accounts can be determined by the total number of
drives available to the BAR Servers. In addition to setting this parameter,
you must configure the Restore Account Base Name as described
below.

Restore Account Base Name The Teradata Plugin requires you to


create multiple restore accounts with the same base name and a serial
number appended to it. The default base name for the user accounts is
NETVAULT, which can be changed to any valid user name in Teradata.
Before initiating a parallel restore operation, make sure that the required
number of restore accounts are created on the DBS. For example, if you
set the Number of Restore Accounts for Parallel Restores to 2, then
with the base name NETVAULT you must create two user accounts with
the names NETVAULT1 and NETVAULT2 for parallel restores. If you are
running more than one Teradata DBS, create these restore accounts on
each DBS. For details on creating restore accounts, refer to Creating User
Accounts for Parallel Restores on page 32.

Send Script to Editor Application If you intend to edit the plugin


generated ARC script before execution, select Send Script to Editor
Application check box and provide the Editor Application name as
described below.

Editor Application This parameter can be configured to edit the script


in an interactive mode (Windows only) or batch mode (all supported O/S).
The edits performed via the Interactive or the Batch Mode apply only to
the current instance of the backup or restore job. The ARC script is not
modified permanently.

NetVault: Backup Teradata Plugin


Users Guide

23

Interactive Mode This feature is only available on Windows. To use


this feature, enable the Allow Service to Interact with Desktop
option for the NetVault Process Manager service as described below:

From the Services panel, open the Properties window for the
NetVault Process Manager.

Select the Allow Service to Interact with Desktop check box on


the Log On tab.

Then, enter the application path for the Text Editor in this box. Make
sure that the application is accessible to the Teradata Master Plugin.
When a job starts (as determined by the job schedule), the Teradata
Plugin will automatically start the editor application and open the script
file. After making the changes when you close the editor, the plugin will
transfer the updated script to the BAR Server on which it is to be
executed, and run the job. The Administrator must be present when
the job is scheduled in order to edit the script. Otherwise, the job will
remain in an idle state with an open editor window.

Batch Mode The Batch Mode script editing feature utilizes scripts
that automatically make the necessary edits to the ARC scripts without
any manual input. Exercise caution when using the Batch Mode editing
feature and thoroughly test the script before using it as this script will
be executed for every job.
To use the batch editing mode, you must do the following:

First, write a script that will automate script editing.

Then, enter the file path for the script in the Editor Application
box.

When a job starts, the Teradata Plugin passes the generated ARC
script as an argument to the script file, which will modify the ARC
script. When finished, the Teradata Plugin will run the updated script.
When entering the script file name in the Editor Application box,
consider the following:

On MP-RAS UNIX and Linux platforms, use the following format:


/bin/sh <full path to shell script>

On Windows, use the following format for a batch (.bat) file:


<full path to batch file>
The file path must not contain any spaces.

On Windows, use the following format for a PERL script:


perl <full path to PERL script>

24

Chapter 3
Configuring Teradata Plugin

Teradata Database Version On the Teradata Master Plugin node, click


the appropriate DBS version in the Teradata Database Version list. The
supported database versions include the following:

Teradata Database 13.0 and Later

Teradata Database 12.0

Teradata V2R6.x Database

The backups might fail if you select an incorrect version. The features
specific to a Teradata DBS release are briefly described below:
Teradata Database 13.0 and Later

On Teradata Database 13.0 and later, you can do selective backups


and restores of database objects such as views, triggers, stored
procedures and others. On Teradata Database 12.0 and prior
versions, only the entire database, or individual tables and PPI
partitions can be backed up or restored.

Teradata Database 12.0 and Later

On Teradata Database 12.0 and later, online backups can be


performed without permanent journaling. Logging is automatically
started when an online backup is requested. This improves
performance of the DBS as only the change images during backup are
recorded in the journal table. On V2R6, permanent journaling must be
enabled for online backups.

Allow ARC Script Journaling Select the Allow ARC Script


Journaling check box to enable archiving of Permanent Journals for the
following backup types:

Full On-line and Full Clustered On-line Backups On V2R6, the


Full On-line and Full Clustered On-line backups make use of
Permanent Journals. To perform these backups on V2R6, you must
activate permanent journaling in Teradata DBS, and select the Allow
ARC Script Journaling check box in the Configure window. The
on-line backups will fail otherwise. On DBS 12.0 and later, the on-line
backups make use of automatic logging mechanisms and do not
require permanent journaling.

Incremental Backups For very large databases, backing up the full


database each time may not be practical. To solve this problem, the
Teradata Plugin provides the Incremental backup type, which can be
used to archive the after-change journals. In the unfortunate event of
failure, the full backup along with the journal backup can be used to
restore and recover the database. To perform Incremental backups,
you must activate permanent journaling (on all supported Teradata
database releases), and select the Allow ARC Script Journaling
check box in the Configure window.

NetVault: Backup Teradata Plugin


Users Guide

25

ARCMAIN Backup Connect-Back Timeout (Minutes) Enter the


timeout interval for the ARC to connect back to Teradata Plugin during
cluster backups. The job will be aborted if the connect-back does not take
place within the specified interval. The timeout applies to all cluster
backup jobs. The default setting for this parameter is 10 minutes.

ARCMAIN Restore Connect-Back Timeout (Minutes) Enter the


timeout interval for the ARC to connect back to the Teradata Plugin during
cluster restores. The job will be aborted if the connect-back does not take
place within the specified interval. The timeout applies to all cluster restore
jobs. The default setting for this parameter is 10 minutes.

Progress Statistics Update Interval (Seconds) Enter the refresh rate


for data transfer statistics on the Job Monitor window. By default, this
information is updated every 10 seconds. You can set it to any value
between 0 and 600 seconds. When set to zero, the plugin refreshes the
Job Monitor window after completing the backup of each table or
database object. Setting the refresh interval to a very low value might
have a negative impact on performance.

Change ARC Priority This parameter is only available on MP-RAS


UNIX platform. It allows you to set the scheduling priority for the
ARCMAIN and nvdevmgr (NetVault Device Manager) process for better
throughput. The priority can be set to High or Highest, or reset back to
Normal. Note the following:

Setting the priority level to High or Highest does not have any
negative impact on the other processes when the ARCMAIN
processes are not running. The plugin raises the scheduling priority
only when a job is running.

It is also possible to change the setting while a job is in progress.

This parameter can be configured only from the Selections tab on the
NVBU Backup window. Setting the priority level via the NetVault:
Backup Configurator or Remote Configurator will not work.

Restore Media Request (Timeout) Enter the timeout interval for the
availability of media during restore. The job will be aborted if the backup
media is not available within the specified interval. When set to zero, the
job waits indefinitely for the media. Therefore, BakBone recommends that
you change this default value and set an appropriate timeout period to exit
gracefully.

26

Chapter 3
Configuring Teradata Plugin

Media Availability Check Timeout By default, the Teradata Plugin


does not check for the availability of suitable drives/media on a BAR
Server before spawning a backup job. The plugin chooses a BAR Server
depending on its current load and gives priority to those with no active
jobs. This can result in the selection of a BAR Server that does not have
any online drives or suitable media. Consequently, the job continues to
wait while the other available resources remain un-utilized.
To avoid this problem, set a timeout interval for drive/media availability on
a BAR Server. This allows the Teradata Plugin to exclude BAR Servers on
which required resources are not detected within the specified interval,
and choose BAR Servers that have at least one online drive with suitable
media. The recommended timeout interval is two minutes.
The default value for this parameter is zero. Retain the default value if you
do not want to use this feature.

TARA Server Machine Address This parameter is required to use the


multi-stream backup and restore methods that are available with Teradata
Plugin v12.0 and later versions. For multi-stream backups and restores,
set up a TARA Server, and enter the Server name or IP Address in the
TARA Server Machine Address box.

Note: The Full Multi-stream and Full Multi-stream On-line methods cannot be
used without configuring the TARA Server name/address.

TARA Server Port This parameter is set to the default listener port for
the TARA Server, which is 54323. Change the port number if the TARA
Server is configured to listen on a different port in your setup.

ARCMAIN Log Line Wrap Width On TTU 13.0 and later, this
parameter can be used to set a value for the ARCMAIN LINEWRAP
parameter. ARCMAIN uses this setting while displaying the log messages.
By default, the messages are wrapped at 80 characters. To change the
LINEWRAP settings, enter the number of characters at which you want
ARCMAIN to wrap the message. You can specify any value in the range
0-255. The line wrap setting works as follows:

0 No wrapping

1-79 Line wrapped at 80 characters

80-255 Line wrapped at the specified value

> 255 Line wrapped at 80 characters

5. Click OK to save the settings.

NetVault: Backup Teradata Plugin


Users Guide

3.1.1

27

Using Remote Configurator to Configure the Default


Settings
To open the Configure window from Remote Configurator, perform the following
steps:
1. Open the Client Management window on the NetVault: Backup Server.
(Click Client Management on the toolbar or Large Buttons panel.
Alternatively, on the Administration menu, click Client Management.)
2. Under Clients, locate the Teradata Master Plugin Node/BAR Server.
Right-click this node, and select Configure to start the Remote Configurator.
3. On the Remote Configurator, click the Plugin Options tab. Then, click the
Teradata Plugin tab.
4. Continue from step 4 of the section Configuring the Default Settings on page
19.

3.1.2

Using NetVault: Backup Configurator to Configure the


Default Settings
To open the Configure window from the NetVault: Backup Configurator, perform
the following steps:
1. Open NetVault: Backup Configurator.
2. Click the Plugin Options tab.
3. Next, click the Teradata Plugin tab.
4. Continue from step 4 of the section Configuring the Default Settings on page
19.

3.2.0

Adding Teradata DBS


After configuring the default settings, add the target DBS to the Teradata Plugin.
The plugin cannot be used for backups and restores until this procedure is
completed. This procedure must be repeated for each target DBS that is to be
protected using the Teradata Plugin. To add a Teradata DBS, perform the following
steps:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
3. Locate Teradata in the list of plugins. Right-click the node, and select Add
DBS.
4. In the Enter Name of Teradata RDBMS window, configure the following
parameters:

28

Chapter 3
Configuring Teradata Plugin

Figure 3-2:
Enter Name of
Teradata
RDBMS
window

DBS Name Enter the name of the target DBS. Ensure that this machine
has a corresponding COP1 mapping in the /etc/hosts file of each BAR
Server. For example, if the Teradata DBS is called TeraDB, then the
/etc/hosts file on each BAR Server must have an alias mapping for the
DBS name as TeraDBcop1.

Cluster Count Enter the total number of clusters contained in the DBS.
The cluster count is required to determine the number of parallel jobs for
cluster archiving.

5. Click OK. The DBS will be added to the plugin and displayed under the
Teradata node.

3.2.1

Reconfiguring the Cluster Count


To reconfigure the DBS cluster count when a cluster is added or removed, perform
the following steps:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
3. Locate Teradata in the list of plugins, and open this node.
4. Right-click the Teradata DBS node, and select Change Cluster Count.
5. Reconfigure the parameters as described below:

DBS Name The DBS name is displayed in this box. It cannot be


changed.

Cluster Count Update the number of clusters according to the current


DBS settings.

6. Click OK to save the new settings.

3.2.2

Removing a DBS
To remove a Teradata DBS, perform the following steps:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).

NetVault: Backup Teradata Plugin


Users Guide

29

3. Locate Teradata in the list of plugins, and open this node.


4. Right-click the target DBS node, and select Remove DBS.
5. In the confirmation dialog, click Yes.

3.3.0

Adding BAR Servers


After adding the Teradata DBS to the plugin, perform the following steps to add the
BAR Servers:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
3. Locate Teradata in the list of plugins, and open this node.
4. Right-click the Teradata DBS node, and select Define Clients for DBS.
5. Configure the following parameters:

Figure 3-3:
Define Clients
for Teradata
DBS window

Client The Teradata Plugin will display all the NetVault: Backup Clients
listed under Clients in the NVBU Client Management window. Select
only the BAR Servers that will participate in the backup and restore
operations.

Number of Drives Corresponding to the selected BAR Servers, enter


the number of drives available on each. The drive count helps in
determining the number for parallel data streams that can be generated
for the cluster and multi-stream backups and restores.

6. Click OK.
Note: Follow the same procedure to add or remove BAR Servers, or to
reconfigure the drives available to a BAR Server.

30

Chapter 3
Configuring Teradata Plugin

3.4.0

Enabling Communication Between the


Teradata Master Plugin and BAR Servers
If the Teradata Master Plugin is configured on a NetVault: Backup Client, perform
the following steps to enable communication between the Teradata Master Plugin
node and the BAR Servers:
1. Open a terminal session on the Teradata Master Plugin node and navigate to
the .../netvault/util directory (where ... represents the NetVault: Backup
installation directory).
2. Issue the following command:
nvclientaccess -tdclients <DBSname>
3. For password-protected Clients, enter the NetVault: Backup password when
the prompt appears. The Verified Password for Client <Client Name>
message confirms access to the Client nodes.
4. Next, open a terminal session on the BAR Server and navigate to the
.../netvault/util directory (where ... represents the NetVault: Backup
installation directory).
5. Issue the following command:
nvclientaccess -client <NetVault: Backup name of the
Teradata Master Plugin node>
6. When the prompt appears, enter the NetVault: Backup password for the
machine. The Verified Password for Client <Client Name> message
confirms the access to the Teradata Master Plugin node.
7. Perform steps 46 on the remaining BAR Servers.

3.5.0

Configuring a Default Login Account


The Teradata Plugin requires a DBS user account that has sufficient privileges to
connect to the Server for backups and restores. Configuring a default login
account eliminates the need to enter the authentication details each time a
connection to the Teradata Database is required. The plugin establishes a
connection automatically using the default account. When a default account is
configured, the existing job definitions are not affected by any changes in the user
account or password. If you do not configure a default account, the job definitions
must be changed each time the user account or password is changed.
To configure a default login account for the plugin, perform the following steps:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node and select Open).
3. Locate Teradata in the list of plugins and open this node.

NetVault: Backup Teradata Plugin


Users Guide

31

4. Right-click the Teradata DBS node and select Set Default Logon.
5. Configure the following parameters:
Figure 3-4:
Set Default
Login window

Default Account Enter a Teradata DBS user name with sufficient


privileges to run backup and restore jobs.

Password Enter the password associated with the configured user.

Use Default Login Select this option to connect to the database


automatically without waiting for user input.

6. Click OK to save the authentication details.


Important: If the password for the configured user is changed in the Teradata
DBS, you must also update the default logon details for the Teradata Plugin.

3.6.0

Creating or Upgrading the Catalog Database


A catalog database stores information about backups. It enables direct tape
positioning during restore and copy operations which expedites the process. Use
the procedure described below to create or upgrade a catalog database from the
plugin GUI. Before proceeding ensure that you have configured the Use ARC
Catalog and ARC Catalog Database options. For details, refer to Configuring the
Default Settings on page 19. Note the following:

If you have created a catalog using a previous version of the plugin, it is


necessary to upgrade the database to create tables that store the additional
information required for this function.

The Teradata Plugin includes a Catalog Database Maintenance feature,


which can be used to remove unnecessary records related to savesets that
have been retired, blanked or removed from the NVDB. For details on
managing the catalog database, refer to Managing the Catalog Database on
page 57.

To create or upgrade a catalog database, perform the following steps:


1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node and select Open).
3. Locate Teradata in the list of plugins, and open this node.

32

Chapter 3
Configuring Teradata Plugin
4. Right-click the Teradata DBS node, and select Create/Upgrade Catalog
Database.
5. Configure the following parameters:

Figure 3-5:
Create
Catalog
Database
window

Enter Password for DBC Account Enter the password for the DBC
user account.

Catalog Database Name This box displays the Catalog database name
specified in the Configure window. It should not be changed. Any change
must be made in the Configure window.

Permanent Storage Space By default, 100000000 bytes are allocated


to the permanent storage space. For details on optimum storage space for
the Catalog database, refer to the relevant Teradata Documentation.

6. Click OK to initiate catalog creation.


If you have added more than one DBS to the Teradata Plugin, repeat this
procedure for each added DBS.

3.7.0

Creating User Accounts for Parallel Restores


Teradata ARC does not allow concurrent restore operations by the same user. As
a result, the Teradata Plugin requires multiple user accounts to run parallel jobs for
restoring cluster archives. Note the following:

If the restore accounts are not created, the cluster restore jobs will fail and the
message User Identification is Not Authorized will be logged.

If sufficient restore accounts are not created, the job will not fail. However, the
message Parallelism is Lost will be displayed.

If necessary privileges are not granted, the restore jobs will fail and the
message User does not have RESTORE Access to Database xxx will be
logged.

The procedure for creating restore accounts can be divided into the following
steps:

Creating Restore Accounts

Granting Privileges to the Accounts

NetVault: Backup Teradata Plugin


Users Guide

33

These steps are described in the following sections. Before proceeding make sure
that you have configured the Number of Restore Accounts for Parallel
Restores and the Restore Account Base Name parameters in the Configure
window. For details, refer to Configuring the Default Settings on page 19.
Note: You can also use the BTEQ commands to create the restore accounts. For
details on using BTEQ, refer to the relevant Teradata Documentation.

3.7.1

Creating Restore Accounts


To create the restore accounts, perform the following steps:
1. Open the Backup window.
2. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
3. Locate Teradata in the list of plugins, and open this node.
4. Right-click the Teradata DBS node, and select Create Restore Accounts.
5. Configure the following parameters:

Figure 3-6:
Create
Restore
Account(s)
window

Enter Password for DBC Account Enter the password for the DBC
user account.

Restore Account Base Name This box displays the base name for the
restore account specified in the Configure window. It should not be
changed. Any change must be made in the Configure window.

Number of Account to Create This box displays the number of restore


accounts specified in the Configure window. It should not be changed.
Any change must be made in the Configure window.

Password for New Accounts - Enter a password for the restore


accounts. The same password is set for all restore accounts.

6. Click OK to start creating the accounts.


If you have added more than one DBS to the Teradata Plugin, repeat this
procedure for each added DBS.

34

Chapter 3
Configuring Teradata Plugin

3.7.2

Granting Privileges to the Accounts


To grant the necessary privileges to the restore accounts, perform the following
steps:
Note: You can also use the BTEQ commands to grant user privileges. For details
on using BTEQ, refer to the relevant Teradata Documentation.
1. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
2. Locate Teradata in the list of plugins, and open this node.
3. Open the Teradata DBS node.
4. Right-click the database node, and select Change Restore Privileges.
5. Configure the following parameters:

Figure 3-7:
Change
RESTORE
Privileges
window

Account Name Enter the user name with DBC account privileges.

Password Enter the password associated with the configured user.

Restore Account Base Name This box displays the base name for the
restore account, and should not be changed.

Number of Restore Accounts This box displays the number of restore


accounts configured. Do not change this value unless you want to grant
permissions only to specific number of restore accounts.

Operation Click Grant to grant the restore privilege on the database.

6. Click OK to complete the procedure.

3.7.2.a

Revoking Privileges from the Accounts


To revoke the privileges, perform the following steps:
1. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
2. Locate Teradata in the list of plugins, and open this node.
3. Open the Teradata DBS node.
4. Right-click the database node, and select Change Restore Privileges.

NetVault: Backup Teradata Plugin


Users Guide

35

5. Configure the following parameters:

Account Name Enter the user name with DBC account privileges.

Password Enter the password associated with the configured user.

Restore Account Base Name This box displays the base name for the
restore account, and should not be changed.

Number of Restore Accounts This box displays the number of restore


accounts configured. Do not change this value unless you want to revoke
permissions only from specific number of user accounts.

Operation Click Revoke to revoke the granted privileges.

6. Click OK to complete the procedure.

3.8.0

Defining Encryption Algorithms


Using the Protegrity Defiance BAR Encryption solution, the Teradata Plugin allows
you to encrypt your backups with any of the supported ciphers. This feature is only
supported on Windows 2003 R2 and Linux. It is not available on MP-RAS UNIX.
The Defiance module must be installed on each BAR Server on which you intend
to run the encrypted backups. Currently, the Defiance module supports AES128,
AES256, and PANAMA ciphers. To update the cipher list, perform the following
steps:
1. On the Selections tab, open the Teradata Master Plugin node (double-click
the node, or right-click the node, and select Open).
2. Locate Teradata in the list of plugins, and open this node.
3. Right-click the Teradata DBS node, and select Define Encryption
Algorithms.
4. Update the cipher list as described below:

Figure 3-8:
Define
Encryption
Algorithms
window

36

Chapter 3
Configuring Teradata Plugin

DBS Name This box displays the Teradata DBS name.

Enter Encryption Algorithms The default list includes the following


algorithms - AES128, AES256, and PANAMA. To use any other algorithm
provided by the Defiance module, add it to this list. Do not add any cipher
that is not supported by the Defiance module. Selecting such a cipher for
a backup would cause a job to fail.

5. Click OK to save the list.

NetVault: Backup Teradata Plugin


Users Guide

37

Chapter 4:

BACKING UP DATA WITH


TERADATA PLUGIN
This chapter describes how to use the Teradata Plugin to perform backups. The
information in this chapter is organized into the following topics:

Available Backup Methods

Full Backup

Full On-line Backup

Full Clustered Backup

Full Clustered On-line Backup

Full Multi-stream Backup

Full Multi-stream On-line Backup

Incremental Backup

Data Dictionary Backup

User-defined Backup Scripts

Performing Full and Full On-line Backups

Selecting Data for a Backup

Choosing the Backup Method

Configuring the Backup Options

Using Catalog

Archiving Only Non-empty Databases

Forcing Lock Releases

Using Network-attached Devices

Configuring the Restart Checkpoints

Selecting the Encryption Cipher

Setting Query Band

Configuring Number of Sessions

Overriding the ARC Options

Enabling Checksum During Restore

Choosing the BAR Server to Run Backup

Finalizing and Submitting a Job

Performing Full Clustered and Full Clustered On-line Backups

38

Chapter 4
Backing up Data with Teradata Plugin

Performing Full Multi-stream and Full Multi-stream On-line Backups

Archiving Selected Partitions of PPI Tables


Considerations While Archiving Partitions

Procedure for Backing up PPI Partitions

Modifying the PPI Filter Expression

De-selecting PPI Partitions

Performing Incremental Backup

Backing up Only Data Dictionary

Resuming a Job From Last Checkpoint

Generating ARC Scripts Only

Backing up Data with User Scripts

Managing the Catalog Database

4.1.0

Performing Catalog Database Maintenance from the Plugin GUI

Performing Catalog Database Maintenance from the CLI

Using Selection Sets

Creating a Selection Set

Loading a Selection Set

Additional Notes

Available Backup Methods


An archive operation copies the selected data from the Teradata database to one
or more archive files. You can use the Teradata Plugin to backup databases,
tables and other database objects, and partitions of PPI tables. The plugin
supports the following backup methods:

All-AMPs

Cluster

Multi-stream

Each method can be used to perform online or offline backups. The online
backups allow concurrent updates to tables while the backup is in progress. The
Teradata Plugin utilizes automatic logging for online backups on Teradata
Database 12.0 and later. On prior versions of the database, you must activate
permanent journaling for online backups. Without automatic or permanent logging,
read locks are placed on the object being backed up, preventing updates during
the backup. The available backup types are described in the sections that follow.

NetVault: Backup Teradata Plugin


Users Guide

4.1.1

39

Full Backup
The Full Backup method archives data from all AMPs into a single archive file.
Read utility locks are used to prevent updates by other users during backup.
When a database is selected, the read utility lock is placed at the database level
before archiving begins. When individual tables are selected, the lock is placed on
each table before it is archived. The locks are released when the backup
completes.

4.1.2

Full On-line Backup


Like Full Backup, this method archives the database objects from all AMPs into a
single archive file. However, unlike the Full Backup method, the database objects
are accessible for writes during a backup. The updates are logged to permanent
or temporary journals. The archive contains the data dictionary, tables and objects,
and the change images in the journal which can be rolled forward during a restore.
The implementation of Full On-line Backup differs on Teradata Database V2R6
and the later releases:

4.1.3

Teradata Database V2R6 On V2R6, the Full On-line Backups can only be
used to backup databases with permanent journals. You must also enable the
Allow ARC Script Journaling parameter. For details, refer to Configuring
the Default Settings on page 19. Group Read locks are placed during backup
to allow concurrent updates.

Teradata Database 12.0 and Later Permanent journals are not required on
Teradata database 12.0 and later as the DBS automatically sets up the
required logging mechanism when an on-line backup is requested.

Full Clustered Backup


The Full Clustered Backup archives data from all AMPs into a set of archive files
called a cluster archive. With cluster archives, multiple data streams can be
generated for a single job which can potentially reduce the overall backup time,
especially when targeting large database objects. Read utility locks are used to
prevent updates by other users during backup. When a database is selected, the
read utility lock is placed at the database level before archiving begins. When
individual tables are selected, the lock is placed on each table before it is archived.
The locks are released when the backup completes.
The Full Cluster backup consists of two phases:

Phase 1 archives the data dictionary.

Phase 2 archives the data tables and objects into cluster archives.

40

Chapter 4
Backing up Data with Teradata Plugin

4.1.4

Full Clustered On-line Backup


Like Full Clustered Backup, this method archives the data from all AMPs into a set
of archive files. Multiple data streams can be generated for the backup job to
reduce overall backup time. However, unlike the Full Clustered Backup method,
the database objects are accessible for writes during a backup. The updates are
logged to permanent or temporary journals. The archive contains the data
dictionary, data tables and objects, and the change images in the journal which
can be rolled forward during a restore. The implementation of Full Clustered
On-line Backup differs on Teradata Database V2R6 and the later releases:

Teradata Database V2R6 On V2R6, the Full Clustered On-line backups


can only be used to backup databases with permanent journals. You must
also enable the Allow ARC Script Journaling parameter as described in
Configuring the Default Settings on page 19. Group Read locks are placed
during backup to allow concurrent updates. The backup consists of three
phases:

Phase 1 archives the data dictionary.

Phase 2 archives the data tables into cluster archives.

Phase 3 archives the change images recorded in the permanent journals


during backup.

Teradata Database 12.0 and Later Permanent journals are not required on
release 12.0 and later as the DBS automatically sets up the required logging
mechanism when an on-line backup is requested.

Note: The use of permanent journaling is not supported through the Teradata
Plugin GUI if the Teradata Database Version parameter on the Configure
window is set to Teradata Database 12.0 or Teradata Database 13.0 and Later.
The support for permanent journals through the Teradata Plugin GUI is limited to
Teradata V2R6.

4.1.5

Full Multi-stream Backup


The Full Multi-stream Backup method is a new parallel archiving method available
with TTU 13.0. This method provides enhanced parallelism. With Multi-stream
method, clusters are not considered the smallest unit for generating streams. This
method can use much smaller data units (for example, AMPs and sub-AMPs) to
distribute data optimally and generate multiple data streams. This enables faster
backups. The ARCMAIN itself determines how the data is distributed and what
data each stream backs up. The backup script generated by the plugin does not
contain this information. The data dictionary is automatically included in stream 1.
To use this method, you must set up a TARA Server and specify the server name/
IP and port number on the Configure window. The Full Multi-stream backup
method is not supported on MP-RAS UNIX platform.

NetVault: Backup Teradata Plugin


Users Guide

41

Read utility locks are used to prevent updates by other users during a backup.
When a database is selected, the read utility lock is placed at the database level
before archiving begins. When individual tables are selected, the lock is placed on
each table before it is archived. The locks are released when the backup
completes.

4.1.6

Full Multi-stream On-line Backup


The Full Multi-stream On-line Backup method is similar to the Full Multi-stream
backup method, and enables data distribution a granular level. However, the
database objects are accessible for writes during a backup. The updates are
logged to permanent or temporary journals. The archive contains the data
dictionary, data tables and the change images in the journal which can be rolled
forward during restore. The implementation of Full Multi-stream On-line Backup
differs on Teradata Database V2R6 and the later releases:

Teradata Database V2R6 On V2R6, the Full Multi-stream On-line backups


can only be used to backup databases with permanent journals. You must
also enable the Allow ARC Script Journaling parameter as described in
Configuring the Default Settings on page 19. Group Read locks are placed
during backup to allow concurrent updates.

Teradata Database 12.0 Permanent journals are not required on release


12.0 and later as the DBS automatically sets up the required logging
mechanism when an on-line backup is requested.

To use this method, you must set up a TARA Server and specify the server name/
IP and port number on the Configure window. The Full Multi-stream On-line
backup method is not supported on MP-RAS UNIX platform.

4.1.7

Incremental Backup
For very large databases, backing up the full database each time may not be
practical. To solve this problem, the Teradata Plugin provides the Incremental
Backup method, which can be used in conjunction with the Full On-line backups to
archive the after-change journals. In the unfortunate event of failure, the full
backup along with the journal backup can be used to restore and recover the
database.
To use the incremental backup method you must activate permanent journaling
and enable the Allow ARC Script Journaling parameter. For details, refer to
Configuring the Default Settings on page 19.

42

Chapter 4
Backing up Data with Teradata Plugin

4.1.8

Data Dictionary Backup


A dictionary archive of a database includes the definitions for all the tables, views,
macros and triggers, and dictionary entries for the stored procedures. You can use
this option to backup the dictionary information whenever the structure of tables in
a cluster is modified.

4.1.9

User-defined Backup Scripts


The Teradata Plugin also supports backups through user-defined scripts. For
details on running your own backup script from the plugin GUI, refer to Backing up
Data with User Scripts on page 57.

4.2.0

Performing Full and Full On-line Backups


The procedure for performing Full and Full On-line backups can be divided into the
following steps:

Selecting Data for a Backup

Choosing the Backup Method

Configuring the Backup Options

Choosing the BAR Server to Run Backup

Finalizing and Submitting a Job

These steps are described in detail in the following sections.

4.2.1

Selecting Data for a Backup


To select the data for a backup, perform the following steps:
1. Open the Backup window on the NetVault: Backup Server. (Click Backup on
the toolbar or Large Buttons panel. Alternatively, on the Operations menu,
click Backup.)
2. On the Selections tab, open the Teradata Master Plugin node. To open any
node on the Selections tab, you can do either of the following:

Double-click the node

Right-click the node, and then select Open

3. Locate Teradata in the list of plugins, and open this node.


4. Open the Teradata DBS node to display the Hierarchical View and
Classical View nodes. These are the two methods the Teradata Plugin
provides to browse the DBS and select the database objects.

NetVault: Backup Teradata Plugin


Users Guide

43

Figure 4-1:
Selections tab
on Backup
window.
On Teradata
database 13.0
and later, the
database
objects, such
as triggers,
views, stored
procedures
and others are
also listed in
the selection
tree

Hierarchical View This view displays the parent-child structure of the


DBS. It is similar to the DBS view in the Teradata Administrator
application.

Classical View This view displays a flat selection tree, ignoring the
parent-child relationship.

5. Select the desired browse method, and open the DBS node to view the
contents.
6. A login prompt will appear if you have not configured a default login account
for the plugin. Configure the following parameter in the login window:

Account Name Enter a Teradata DBS user name. This user account
must have sufficient privileges to run backup and restore jobs.

Password Enter the password associated with the configured user.

Click OK. Upon authentication, the database structure will be displayed.


This step is not applicable if you have configured a default login account for
the plugin. For details, refer to Configuring a Default Login Account on page
30.

44

Chapter 4
Backing up Data with Teradata Plugin
7. Make the data selections as described below:

Select an Entire DBS In the Hierarchical View, the entire DBS can be
selected for a backup by selecting the DBC node. In the Classical View,
each node must be selected manually.

Select DBC System Tables The DBC system tables can only be
selected when performing a Full or a Full Multi-stream backup. This can
be done by selecting the <All DBC Objects> node in the Hierarchical
View, or the DBC node in the Classical View.

Select Individual Database(s)

Select (Individual) Tables and Other Types of Database Objects On


Teradata database 13.0 and later you can also select database objects,
like triggers, views, stored procedures and others.

Select PPI Table Partitions The ability to select partitions of a PPI table
is limited to Full and Full Multi-stream backup methods. The other backup
methods do not support backups of PPI table partitions. For more
information, refer to Archiving Selected Partitions of PPI Tables on page
52.

Select Include ALL Option In the Classical View, right-click a database


node, and select Include ALL to select all the tables and its descendants.
Include ALL will mark the selected database with a red arrow in addition
to the standard green check in the checkbox and add the label ALL to the
database name. It is important to know the structure of the database
before using this option or this may result in data being backed up twice.
To remove Include ALL, right-click and select Cancel Include ALL.

Note the following:

For excluding the child objects after selecting a parent node, first
complete all the selections and then omit the unwanted objects from
backup. An inclusion after exclusion will result in a failed job.

The All, Default and Public objects are not displayed in the Hierarchical
View. Select the DBC node to backup these objects.

The SYSUDTLIB which contains the definition of all User Defined Types
(UDTs) is logically linked to the DBC. When you archive DBC, the
SYSUDTLIB is automatically included. If you exclude DBC, the
SYSUDTLIB is also excluded.

NetVault: Backup Teradata Plugin


Users Guide

4.2.2

45

Choosing the Backup Method


Click the Backup Options tab, and select one of the following backup methods:

4.2.3

Full Select this method to perform an all AMPs backup of the selected data
without any journaling.

Full On-line To use this backup method with V2R6, you must activate
permanent journaling and enable the Allow ARC Script Journaling
parameter. For details, refer to Configuring the Default Settings on page 19.

Configuring the Backup Options


Configure the remaining Backup Options as described in the following sections.

Figure 4-2:
Backup
Options for
Full and Full
On-line
methods

4.2.3.a

Using Catalog
To store the backup information in the catalog, do the following:

Select the Use ARC Catalog check box in the Configure window. For
details, refer to Configuring the Default Settings on page 19.

Create the required catalog database. For details, refer to and Creating or
Upgrading the Catalog Database on page 31.

Under Backup Type, leave the Use ARC Catalog check box selected.

Clear this check box if you do not want to use the catalog for a particular job, for
example, when archiving the Catalog database itself.

46

Chapter 4
Backing up Data with Teradata Plugin

4.2.3.b

Archiving Only Non-empty Databases


Under Backup Type, select the Archive only NONEMPTY DATABASES check
box to exclude any empty users or databases.

4.2.3.c

Forcing Lock Releases


To enforce lock releases when a job is aborted, select the Force Release Lock on
Abort check box. The lock is not guaranteed to release in all cases. Particularly,
the following events will result in a leftover lock:

4.2.3.d

If ARC is forcibly aborted by the user or operating system.

If communication to the Teradata Database is lost and cannot be


reestablished.

If an internal failure occurs in ARC, such that program control cannot proceed
to, or complete, the release lock step.

Using Network-attached Devices


By default, the Teradata Plugin writes only to locally available devices. To use
network-attached devices, select the Allow Use of Network Attached Devices
check box under Backup Type. To apply this setting globally to all jobs, select this
check box in the Configure window.

4.2.3.e

Configuring the Restart Checkpoints


The CHECKPOINT parameter saves restart information in the Restart Log at the
specified intervals. This allows you to resume a failed job from the last checkpoint
before failure. To write the restart information to the log, configure the following
parameters:

4.2.3.f

Enable Checkpoint Restarts Select the Enable Checkpoint


Restarts check box to save the tape positioning and other processing
information in the restart log.

Checkpoint Frequency Enter the checkpoint frequency in terms of number


of blocks processed. During backup, the markers are placed at the specified
interval or at the end of an object, whichever occurs first. Since checkpoint
operations cause I/O and additional processing overhead, too many
checkpoints might adversely impact performance.

Selecting the Encryption Cipher


To encrypt the backup data, select the cipher in the Encryption Algorithm list
under Advanced Options. By default, this list includes AES128, AES256, and
PANAMA. To use other ciphers supported by Defiance, add them to the cipher list.
For details, refer to Defining Encryption Algorithms on page 35. For no data
encoding leave the default NONE selected.

NetVault: Backup Teradata Plugin


Users Guide

47

This feature is only supported on Windows 2003 R2 and Linux platforms. It is not
available on MP-RAS UNIX operating system. The Defiance module must be
installed on each BAR Server on which you want to run the encrypted backups.

4.2.3.g

Setting Query Band


A query band is a set of name and value pairs that can be set on a session to
identify where a query originated. Query bands offer a way to identify the user and
application, for example, when applications use pooling mechanisms that hide the
identity of users because each connection in the pool logs into the database using
the same user account. Without query bands, there is no way to tell the source of
the request when the request comes from a multi-tiered application. Another
potential use of query bands is troubleshooting, when it is necessary to provide
the specific user or application that issued a request.
To set the query band, enter the band identifier string for the Query Band ID
parameter under Advanced Options. This string must be specified in the
following format name1=value1;name2=value2;. You can specify a maximum of
2048 characters in the string.

4.2.3.h

Configuring Number of Sessions


In the Sessions box under ARCmain Options, enter the maximum number of
Teradata Database sessions available for the archive and recovery operations.
The default value for this parameter is 4. Teradata ARC uses two control sessions
for archive and recovery operations. The additional sessions are required for
parallel processing during backups and restore/copy operations.
The optimal number of sessions is site specific and depends on the database size
and other factors. Consult a Teradata representative if you are unsure of how
many sessions to use. For most sites 16 sessions is a good starting point. Any
connected sessions that are not actually used in the operation result in wasted
system resources.

4.2.3.i

Overriding the ARC Options


To override any of the globally configured ARC parameters or to specify additional
run-time parameters for the given job, enter the parameters and their values in the
Override ARC Options box under ARCmain Options. Enter the correct syntax
while configuring this parameter. The Teradata Plugin will not check for any
syntactical errors when you save or submit the job.
Note: This option will be passed as the last argument to ARCMAIN so that the you
can override any ARC parameter, including the ones generated internally by the
plugin.

48

Chapter 4
Backing up Data with Teradata Plugin

4.2.3.j

Enabling Checksum During Restore


To validate data integrity during restore, select the Enable ARC Checksums
check box under Overrides.
Alternatively, you can enter CHECKSUM=2 in the Override ARC Options box to
validate data integrity during both backups and restores. To apply this setting
globally to all jobs, configure CHECKSUM as an Additional ARCMAIN
Command Line parameter in the Configure window.

4.2.4

Choosing the BAR Server to Run Backup


For All-AMPs backups, you do not have to specify the target BAR Server while
defining the job. By selecting <AUTO> in the Run Job on Client list under
Overrides, you can direct the plugin to automatically find the most suitable target
and spawn the job on that BAR Server at run-time. The suitability of a BAR Server
is based on the following two criteria, ensuring that the job does not have to wait
for drive or media availability during execution:

The BAR Server has least number of concurrent active jobs

It has access to an online drive

To override the auto-selection and run the job on particular BAR Server, select the
target machine in the Run Job on Client list.

4.2.5

Finalizing and Submitting a Job


To finalize and submit the backup job, perform the following steps:
1. Click the Schedule, Target and Advanced Options tabs, and configure the
required options. These options are common to all NetVault: Backup plugins.
For more information on configuring these options, refer to the NetVault:
Backup Administrators Guide.
Note: For the Teradata Plugin, you cannot configure the Local Drives Only option
on the Target tab.
2. Enter a title for the job in the Job Title box at the top right corner of the
Backup window. Specify a detailed title that allows you to easily identify the
job for monitoring its progress or restoring data.
3. Click Submit on the toolbar. Alternatively, on the Accept menu, click Submit
Backup. To monitor the job progress and access logs, refer to Viewing Logs
and Job Progress on page 87.

NetVault: Backup Teradata Plugin


Users Guide

4.3.0

49

Performing Full Clustered and Full Clustered


On-line Backups
To generate a cluster backup, perform the following steps:
1. Select the data for backup. For details, refer to Selecting Data for a Backup
on page 42.
2. Click the Backup Options tab, and select one of the following backup
methods:

Figure 4-3:
Backup
Options for
Full Clustered
and Full
Clustered Online methods

Full Clustered Select this method to perform a cluster backup of the


selected data without any journaling.

Full Clustered On-line To use this method with V2R6, you must
activate permanent journaling and select the Allow ARC Script
Journaling parameter as described in Configuring the Default Settings on
page 19.

3. Configure the appropriate backup options. For details, refer to Configuring


the Backup Options on page 45.
4. To run parallel cluster backup jobs, configure the following parameters under
MPP Options:

50

Chapter 4
Backing up Data with Teradata Plugin

Maximum Parallel Data Streams to Use Enter the maximum number


of parallel streams that can be generated for the cluster backup. This will
depend on the total number of drives accessible to the BAR Servers on
which the sub-jobs will run.

Cluster Batch Size Enter the number of clusters to be backed up by


each sub-job. The number of sub-jobs is equal to Cluster Count divided by
Batch Size.

Retry Failed Clusters on Another Remaining Client Select this check


box to retry the backup job on remaining BAR Servers if a job fails
because of any of the following reasons:

Write Error The backup fails on a BAR server as a result of write


error caused by a bad tape or a bad tape drive (Access Module error
code ARC0805; severity 12).

ARCMain Dies Unexpectedly The ARCMain process is aborted or


dies unexpectedly on a BAR server.

NetVault Processes Die Unexpectedly The NetVault: Backup


processes are aborted or die unexpectedly on a BAR server.

The Teradata Plugin will attempt to restart the failed cluster sub-jobs on
the remaining active BAR Servers. This might increase the backup time
depending on (1) how much data was transferred before the error, and (2)
whether an idle BAR Server is available immediately. The job status is set
to Backup Completed with Warnings if any of the sub-jobs has to be
rescheduled while the other sub-others are successful.
If you do not select this check box, the job will be aborted when a sub-job
fails.
5. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.

4.4.0

Performing Full Multi-stream and Full Multistream On-line Backups


With TTU 13.0, you can use the Full Multi-stream and Full Multi-stream On-line
backup methods instead of the clustered backup methods for better performance.
To use these backup methods, you must set up a TARA Server and configure the
server address/IP and port number in the Configure window. For details, refer to
Configuring the Default Settings on page 19. With these methods, you just need to
specify the total number of data streams. The generation of streams and
distribution of data is managed by the ARCMAIN.
Note: The Full Multi-stream and Full Multi-stream On-line backup methods are not
supported on MP-RAS UNIX.

NetVault: Backup Teradata Plugin


Users Guide

51

To generate multi-stream backups, perform the following steps:


1. Select the data for backup. For details, refer to Selecting Data for a Backup
on page 42.
2. Click the Backup Options tab, and select one of the following backup
methods:
Figure 4-4:
Backup
Options for
Full Multistream and
Full Multistream On-line
methods

Full Multi-stream Select this method to perform multi-stream archiving


without any journaling.

Full Multi-stream On-line To use this method with V2R6, you must
activate permanent journaling and select the Allow ARC Script
Journaling parameter as described in Configuring the Default Settings on
page 19.

3. Configure the appropriate backup options. For details, refer to Configuring


the Backup Options on page 45.
4. To run parallel jobs, configure the following parameter under MPP Options:

Maximum Parallel Data Streams to Use Enter the maximum number


of parallel streams that can be generated for the backup job. This will
depend on the total number of drives accessible to the BAR Servers on
which the sub-jobs will run.

5. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.

52

Chapter 4
Backing up Data with Teradata Plugin

4.5.0

Archiving Selected Partitions of PPI Tables


With Teradata Plugin, you can archive the individual partitions of a PPI table
instead of performing a full table backup. This feature can be used for the
following:

Archive only a subset of data and avoid duplication. This can minimize the
size of the archive and improve performance.

Restore data in table that is partially damaged.

Copy a limited set of data to another host or a test system.

The ability to select partitions of a PPI table is limited to Full backup method. The
other backup methods do not support backups of PPI table partitions.

4.5.1

Considerations While Archiving Partitions


Consider the following when archiving selected partitions in PPI tables:

4.5.2

A restore operation always deletes the selected partitions of the target table
before restoring the rows that are stored in the archive.

Archiving selected partitions operates on complete partitions within tables,


i.e., selection of a partial partition implies the entire partition.

Partitioning is based on one or more columns specified in the table definition.

If a table has a partitioning expression that is different from the partitioning


expression used in the PPI archive, a PPI restore is possible as long as no
other significant DDL changes are made to the table.

Procedure for Backing up PPI Partitions


To backup the PPI table partitions, perform the following steps:
Important: It is not possible to combine the complete database/table backups and
PPI filtered table backups in the same backup job. The job will fail if you attempt
this.
1. Open the Backup window. On the Selections tab, open the Teradata DBS
node. For details, refer to Selecting Data for a Backup on page 42.
2. Open the database node.
3. Right-click the table, and then select Select PPI Partitions.
4. Enter the expression between the delimiters in the Enter Partition Selection
Expression window. Make sure to enter the correct syntax. The Teradata
Plugin will not check for syntactical errors at this point.

NetVault: Backup Teradata Plugin


Users Guide

53

Figure 4-5:
Enter Partition
Selection
Expression
window

5. Click OK. The PPI table icon changes indicate PPI partition backup and the
partition expression is displayed in parenthesis.
Figure 4-6:
PPI partitions
selected for a
backup

6. To include partitions from other PPI tables, repeat steps 2-4 specifying the
required filter expression for each table.
7. Click the Backup Options tab, and select Full or Full Multi-stream under
Backup Type.
8. Configure the required Backup Options. For details, refer to Configuring the
Backup Options on page 45.
9. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
Backup on page 48. Ignore this step to automatically select a least loaded
BAR Server to perform the backup.
10.Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.

54

Chapter 4
Backing up Data with Teradata Plugin

4.5.3

Modifying the PPI Filter Expression


To modify the filter expression, perform the following steps:
1. On the Selections tab, locate the PPI filtered table.
2. Right-click it and select Modify PPI Expression.
3. Modify the expression in the Enter Partition Selection Expression window
and click OK. The filter expression in parenthesis is modified to display the
changes made.

4.5.4

De-selecting PPI Partitions


To de-select a PPI partition, you must remove the set filter expression. Simply deselecting the table will remove the table from the backup selection, but the set filter
will remain. Perform the following steps to remove the PPI filter expression:
1. On the Selections tab, locate the PPI filtered table.
2. Right-click the table and select Deselect PPI Partitions. This will remove the
filter expression set for the table but the table itself will remain selected.
3. To remove the table, clear the corresponding check box.

4.6.0

Performing Incremental Backup


Instead of backing up the full database each time, you can use the incremental
backup method to archive the after-change journal tables. These archives can be
used with the initial full backup to restore and recover the database. To use the
incremental backup method you must activate permanent journaling and enable
the Allow ARC Script Journaling parameter. For details, refer to Configuring the
Default Settings on page 19.
To backup the after-image journal tables, perform the following steps:
1. Select the data for backup. For details, refer to Selecting Data for a Backup
on page 42.
2. Click the Backup Options tab, and select Incremental under Backup Type.
3. Configure the appropriate backup options. For details, refer to Configuring
the Backup Options on page 45. If you select Archive Only NONEMPTY
DATABASES check box, the databases without a journal will be ignored.
4. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
Backup on page 48. Ignore this step to automatically select a least loaded
BAR Server to perform the backup.
5. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.

NetVault: Backup Teradata Plugin


Users Guide

4.7.0

55

Backing up Only Data Dictionary


A dictionary archive of a database includes all table, view, macro and trigger
definitions, and dictionary entries for stored procedures. You can use this option to
backup the dictionary information when the structure of tables in the cluster is
modified.
To archive the data dictionary, perform the following steps:
1. Open the Backup window. On the Selections tab, select the target
database. For details, refer to Selecting Data for a Backup on page 42.
2. Click the Backup Options tab, and select Data Dictionary under Backup
Type.
3. Configure the appropriate backup options. For details, refer to Configuring
the Backup Options on page 45.
4. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
Backup on page 48. Ignore this step to automatically select a least loaded
BAR Server to perform the backup.
5. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.

4.8.0

Resuming a Job From Last Checkpoint


If the Teradata Database fails during a backup, you can restart the job again after
the system recovers. The backup will resume from the last checkpoint recorded in
the restart log before the failure occurred. If the AMP configuration has changed
(for example, AMPs are online before the failure but offline afterward), the archive
restarts from the last table being archived before the failure. This feature is
available only if you have enabled checkpoint restart for the job. For details, refer
to Configuring the Restart Checkpoints on page 46. The job status is reported as
Backup Stopped instead of Backup Failed.
To resume a backup job, perform the following steps:
1. Open the Job Management window. (Click Job Management on the toolbar
or Large Buttons panel. Alternatively, on the Operations menu, click Job
Management.)
2. Click the Status tab.
3. Right-click the job, and then select Resume.
4. In the confirmation dialog, click OK to resume the job.

56

Chapter 4
Backing up Data with Teradata Plugin
Note the following:

4.9.0

A job must be resumed immediately from the same session. If you close and
reopen the Jobs window, then the Resume option will not be available.

If the Jobs window is not closed/reopened but another job is submitted in the
same session, then the status of the stopped job will change to Incomplete
and the Resume option will no longer be available.

Generating ARC Scripts Only


The Teradata Plugin provides an option to generate only the ARC scripts without
actually executing the job. These scripts are stored as Context Objects in the job
logs. You can save the script to files and use them with the User Script backup
method in Teradata Plugin, or run them outside the plugin. To generate an ARC
script, perform the following steps:
1. Select the data for backup. For details, refer to Selecting Data for a Backup
on page 42.
2. Click the Backup Options tab, and select one of the following backup
methods:

Full Select this method to perform an all AMPs backup of the selected
data without any journaling.

Full On-line To use this method with V2R6 and previous releases, you
must activate permanent journaling and enable the Allow ARC Script
Journaling parameter as described in Configuring the Default Settings on
page 19.

Full Clustered Select this method to perform a cluster backup of the


selected data without any journaling.

Full Clustered On-line To use this method with V2R6 and previous
releases, you must activate permanent journaling and enable the Allow
ARC Script Journaling parameter as described in Configuring the
Default Settings on page 19.

Full Multi-stream Select this method to perform multi-stream archiving


without any journaling.

Full Multi-stream On-line To use this method with V2R6, you must
activate permanent journaling and select the Allow ARC Script
Journaling parameter as described in Configuring the Default Settings on
page 19.

3. under Backup Type, select the Generate ARC Script Only check box.
4. Enter a suitable name for the job in the Job Title box.
5. Click Submit.

NetVault: Backup Teradata Plugin


Users Guide

57

6. For details on viewing and saving the ARC script, refer to Accessing Job Logs
on page 92.

4.10.0

Backing up Data with User Scripts


To run user-defined ARC scripts for backing up data, perform the following steps:
1. Open the Backup window. On the Selections tab, select the Teradata
database. For details, refer to Selecting Data for a Backup on page 42.
Selecting data from the nodes below is not required but the correct database
must be selected.
2. Click the Backup Options tab, and select User Script under Backup Type.
3. Enter file path for the script in the Run User Script box under Overrides.
The script must reside on the Teradata Master Plugin node. For guidelines on
writing user scripts refer to Guidelines for Creating User Scripts on page 103.
4. Configure the appropriate backup options. For details, refer to Configuring
the Backup Options on page 45.
5. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
Backup on page 48. Ignore this step to automatically select a least loaded
BAR Server to perform the backup.
6. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 48.
Note: For backups performed with User Scripts, the contents of the saveset are
not displayed on the Selections tab of the Restore window. However, you can
use the ARC Analyze option available in the Restore Options tab to view the
contents of the backup saveset.

4.11.0

Managing the Catalog Database


NetVault: Backup allows you to set a time-based or generation-based retention
period for a backup saveset. This feature is common to all NetVault: Backup
plugins. The retention period defines how long the information about a saveset is
stored in the NVDB. This is done by setting a retirement period/expiry date for the
saveset. For details on defining a backup retention policy, refer to the NetVault:
Backup Administrators Guide. When the retention period elapses, NetVault:
Backup retires the saveset and deletes information about the saveset from the
NVDB.

58

Chapter 4
Backing up Data with Teradata Plugin
Teradata Plugin v12.x provides a Catalog Database Maintenance feature, which
can be used to remove unnecessary records related to savesets which have been
retired, blanked or removed from the NVDB. This helps in cleaning up the catalog
database and limiting its size.
You can run a catalog cleanup job either from the plugin GUI or from the CLI. The
procedures are described in the following sections.

4.11.1

Performing Catalog Database Maintenance from the


Plugin GUI
To cleanup the catalog database and remove unnecessary records via the plugin
GUI, perform the following steps:
1. Open the Backup window. On the Selections tab, select any entity in the
Teradata database selection tree. For details, refer to Selecting Data for a
Backup on page 42.
2. Click the Backup Options tab, and select Catalog Database Maintenance
under Backup Type.
3. To run the job at a later time or to define a recurring schedule, click the
Schedule tab and configure the scheduling options. For more information on
configuring scheduling options, refer to the NetVault: Backup Administrators
Guide.
4. Enter a name for the job in the Job Title box. Specify a detailed name that
allows you to easily identify the job for monitoring its progress or restoring
data.
5. Click Submit. To monitor the job progress and access logs, refer to Viewing
Logs and Job Progress on page 87.

4.11.2

Performing Catalog Database Maintenance from the


CLI
To run a catalog cleanup job from the CLI, navigate to the .../netvault/bin directory
(where ... represents the NetVault: Backup installation directory) and issue the
following command:
Windows
nvtera.exe NVServer=<Value> DBSName=<Value>
[DBAccount=<Value>] [DBPassword=<Value>]
[Verbose=<ALL|ERROR>] /CatalogDatabaseMaintenance
Linux and MP-RAS
./nvtera NVServer=<Value> DBSName=<Value>
[DBAccount=<Value>] [DBPassword=<Value>]
[Verbose=<ALL|ERROR>] /CatalogDatabaseMaintenance

NetVault: Backup Teradata Plugin


Users Guide

59

<Value> is a user input variable that must be replaced with the actual value.
Parameters enclosed in [ ] are optional. The parameters are described in detail
below:

CatalogDatabaseMaintenance Use this switch to run a catalog


maintenance job. You can use either - or / to specify this switch
(for example, -CatalogDatabaseMaintenance or /
CatalogDatabaseMaintenance).

NVServer NetVault: Backup Server name. This is a mandatory parameter.

DBSName Teradata DBS Name. This is a mandatory parameter.

DBAccount A valid Teradata database user name. This is an optional


parameter.

DBPassword Password associated with Teradata database user name that


is specified with the DBAccount parameter. This is an optional parameter.

Important: If you omit either DBAccount or DBPassword, then the plugin will
use the default account configured for the DBS. Without a default account if you
omit one of these parameters, the job will fail.

Verbose Specify ALL to write both the ERROR and the LOG messages to
the standard output. Specify ERROR to write only the ERROR messages to
standard output. This is an optional parameter. If you omit this parameter or
specify any other value, then the plugin will not write any messages. This
parameter does not affect the NetVault: Backup Log daemon.

Note the following:

4.12.0

The parameters can be specified in any order.

The parameters are not case sensitive (for example, you can enter NVServer
or NVSERVER). However the values are case-sensitive.

Using Selection Sets


A Selection Set allows you to save the frequently selected data into a composite
set, which can be easily accessed for future backup jobs. This eliminates the need
to manually select the data each time a backup is performed. If your backup
strategy includes Full On-line and Incremental backups, you can create a
selection set of objects included in the full backup and use this for the incremental
backups. This ensures that the same data set is selected for the backups.
Selection Sets are common to all NetVault: Backup plugins. For more information
on Selection Sets, refer to the NetVault: Backup Administrators Guide.

60

Chapter 4
Backing up Data with Teradata Plugin

4.12.1

Creating a Selection Set


To create a selection set, perform the following steps:
1. Select the required data and click Save As under Backup Selection Set at
the bottom of the Selections tab.
2. In the Save Backup Selection Set window, enter a unique name for the
Selection Set.
3. Click OK.

4.12.2

Loading a Selection Set


To use a selection set, perform the following steps:
1. Click Load under Backup Selection Set at the bottom of the Selections tab.
2. In the Load Backup Selection Set window, select the required set.
3. Click OK.

4.13.0

Additional Notes
Refer to the notes in this section before you run a backup job.

Database SYSUDTLIB is linked with database DBC and is only archived if


DBC is archived. SYSUDTLIB cannot be specified as an individual object in
an ARCHIVE statement. If database DBC is involved in an archive operation,
it is always archived first, followed by database SYSUDTLIB.

The Teradata Database configuration determines how to archive when AMPs


are offline. If a table has fallback protection or dual after-image journaling,
Teradata ARC makes a complete copy of the data rows, even if an AMP (per
cluster) is offline during archive.

For non fallback tables, it is recommended that you perform a backup when
all AMPs are online. Alternatively, you can perform specific AMP archive for
the offline processors after the AMPs are back online. However, Teradata
Plugin does not support backups of specific AMPs. This must be performed
outside the plugin from the command line.

Since, single after-images (remote or local) are maintained on single AMPs


the after-images for offline AMPs are not included in the incremental archive
of the journal tables. If you restore one of these archives with a roll forward
operation, data from some of the online AMPs will not be rolled forward.

The Teradata Plugin does the following while generating parallel data streams
for cluster backup if the media availability timeout interval has been set in the
Configure window:

NetVault: Backup Teradata Plugin


Users Guide

61

Selects the least loaded BAR Servers depending on whether a suitable


drive/media is available or not, and whether the drive is currently in use or
not.

Ignores the BAR Servers with no suitable drive/media and logs a warning.

Waits for the availability of drives/media if all the drives are currently busy.

Aborts the job if no suitable drive/media is found.

62

Chapter 4
Backing up Data with Teradata Plugin

NetVault: Backup Teradata Plugin


Users Guide

63

Chapter 5:

RESTORING DATA WITH


TERADATA PLUGIN
This chapter describes how to use the Teradata Plugin to restore and recover
data. The information in this chapter is organized into the following topics:

Available Restore Methods

Restore

Copy

Analyze

User-defined Restore Scripts

Restoring or Copying All-AMPs Archives

Selecting Data for a Restore

Connecting to the Target DBS

Choosing the Restore Method

Configuring the Restore Options

Using Catalog

Using Network-attached Devices

Configuring Number of Sessions

Overriding the ARC Options

Verifying ARC Checksum During Restore

Setting Query Band

Recovering Tables and Databases

Choosing the BAR Server to Run the Job

Finalizing and Submitting a Job

Restoring or Copying Cluster Backups

Restoring or Copying Multi-stream Archives

Restoring or Copying Selected Partitions

Restoring Incremental Backups

Restoring Dictionary Archives

Renaming Objects During Restore

Copying Data to an Alternate Database

Analyzing Archive Media

64

Chapter 5
Restoring Data with Teradata Plugin

5.1.0

Generating ARC Script Only

Restoring Data with User Scripts

Restoring Data from User Script Backups

Restoring Data from Plugin Backups with User Scripts

Dumping Restore Map

Additional Features Available on the Selections Tab

Additional Notes

Available Restore Methods


The Teradata Plugin can be used to restore or copy databases, tables and other
database objects, and PPI partitions from the savesets to the same or a different
DBS configuration. The supported restore methods are described in the sections
that follow.

5.1.1

Restore
A restore operation moves data from archived files back to the same Teradata
database from which it was archived. Refer to the following notes before you start
a restore operation:

A restore of database DBC will drop all the new database objects (database,
users, and UDTs) created since the archive. A restore of a user database will
drop new tables and other database objects such as views, macros, etc.,
created since the archive of the database.

The data dictionary must contain the definition of the entity to be restored.
DROP and RENAME statements cause the definition of an entity to be
removed from the dictionary, and this same definition cannot be recreated
using CREATE statement. So a dropped table can be restored only by
restoring the entire database. A dropped database can be restored only by
restoring the DBC first (provided the DBC archive has the database definition
in it). To restore objects not defined in the dictionary, use the Copy method.

When restoring partitions, select the ALL Partitions or Partitions Where


option unless you intend to overwrite the existing table only with the archived
partitions.

Before starting a parallel restore job, ensure that you have created the
required number of restore accounts. For more information, refer to Creating
User Accounts for Parallel Restores on page 32.

NetVault: Backup Teradata Plugin


Users Guide

5.1.2

65

Copy
A copy operation moves data from an archived file to any Teradata Database and
creates a new table if one does not already exist on the target database. The
following conditions must be met before you copy the data:

5.1.3

The user must have restore access privileges on the target database or table.

The target database must exist to copy a database.

The user account must have both CREATE TABLE and RESTORE database
access privileges on the target database to copy a non-existent table.

The target database must have a journal table to copy journal archives.

Analyze
The analyze method allows you to determine the contents of the backup saveset
without actually restoring the data. The Teradata Plugin provides the following two
analyze options:

Analyze Selections Use this option to analyze the contents of the selected
database in the archive.

Analyze All from Archive Use this option to analyze the contents of the
complete saveset.

The analyze method provides the following information about the archive saveset:

5.1.4

Time and date of the archive

The archive type (All-AMPs, Cluster or Multi-stream)

The name of each database, data table, journal table, stored procedure, view,
and macro in each database

The number of bytes and rows in each table

If an archive file contains a selected partition archive of a table, the


expression used to select the partition.

User-defined Restore Scripts


The Teradata Plugin also supports restores through user-defined scripts. This
method can be used to restore data from User Script backups or the plugin
backups. For details on running your own restore script from the plugin GUI, refer
to Restoring Data with User Scripts on page 80.

66

Chapter 5
Restoring Data with Teradata Plugin

5.2.0

Restoring or Copying All-AMPs Archives


The procedure for restoring or copying All-AMPs archives can be divided into the
following steps:

5.2.1

Selecting Data for a Restore

Connecting to the Target DBS

Choosing the Restore Method

Configuring the Restore Options

Recovering Tables and Databases

Choosing the BAR Server to Run the Job

Finalizing and Submitting a Job

Selecting Data for a Restore


To select the data for a restore, perform the following steps:
1. Open the Restore window on the NetVault: Backup Server. (Click Restore on
the toolbar or Large Buttons panel. Alternatively, on the Operations menu,
click Restore.)
2. On the Selections tab, locate the Teradata Master Plugin node and open it.

Figure 5-1:
Selections tab
on Restore
window

NetVault: Backup Teradata Plugin


Users Guide

67

To open any node on the Selections tab, you can do either of the following:

Double-click the node

Right-click the node and select Open

3. Locate Teradata in the list of plugins, and open this node to display the
backup savesets created with the plugin. Each saveset is labeled with its job
title followed by the backup type, saveset ID and the backup timestamp.
4. Open the target backup saveset to display the <All Objects> node.
5. Open the <All Objects> node to list the databases and tables. From this
level, double-click a node to open it (the right-click + Open method is not
available).
6. Select the objects to be restored.
When selecting the data, consider the following:

5.2.2

For excluding the child objects after selecting a parent node, first complete all
the selections and then omit the unwanted objects from backup. An inclusion
after exclusion will result in a failed job.

The SYSUDTLIB which contains the definition of all User Defined Types
(UDTs) is logically linked to the DBC. When you restore DBC, the
SYSUDTLIB is automatically restored. If you exclude DBC, the SYSUDTLIB
is also excluded.

Connecting to the Target DBS


Click the Restore Options tab, and under Login Information enter the following
details:

5.2.3

Target DBS The target database name is displayed in this box. Do not
change it.

Restore Account The Teradata Plugin automatically selects any


configured user to run the job. To run the job from a particular user account,
select the user in the list. To specify a user not in the list, enter the user name
in the Restore Account box.

Password - Enter the password associated with the configured user.

Choosing the Restore Method


Under ARC Restore Options, select Restore or Copy method.

5.2.4

Configuring the Restore Options


Configure the remaining Restore Options as described in the following sections.

68

Chapter 5
Restoring Data with Teradata Plugin

Figure 5-2:
Restore
Options for AllAMPs backup
methods

5.2.4.a

Using Catalog
If the backup information was written to a catalog, select the Use ARC Catalog
check box to speed up the operation. Clear this check box if a catalog was not
used during backup.

5.2.4.b

Using Network-attached Devices


By default, the Teradata Plugin writes only to locally available devices. To use
network-attached devices, select the Allow Use of Network Attached Devices
check box under Backup Type. To apply this setting globally to all jobs, select this
parameter in the Configure window.

5.2.4.c

Configuring Number of Sessions


In the Sessions box under ARCmain Options, enter the maximum number of
Teradata database sessions available for archive and recovery operations. The
default value for this parameter is 4. Teradata ARC uses two control sessions for
archive and recovery operations. The additional sessions are required for parallel
processing during backups and restore/copy operations.
The optimal number of sessions is site specific and depends on the database size
and other factors. Consult a Teradata representative if you are unsure of how
many sessions to use. For most sites 16 sessions is a good starting point. Any

NetVault: Backup Teradata Plugin


Users Guide

69

connected sessions that are not actually used in the operation result in wasted
system resources.

5.2.4.d

Overriding the ARC Options


To override any of the globally configured parameters or to specify additional
run-time parameters for the given job, enter the parameters and their values in
Override ARC Options box under ARCmain Options. Enter the correct syntax
while configuring this parameter. The Teradata Plugin will not check for any
syntactical errors when you save or submit the job.
Note: This option will be passed as the last argument to ARCMAIN so that the you
can override any ARC parameter, including the ones generated internally by the
plugin.

5.2.4.e

Verifying ARC Checksum During Restore


Under Overrides select the Verify ARC Checksums option to validate data
integrity during restore. This option can only be used if checksum was enabled
during backup.

5.2.4.f

Setting Query Band


A query band is a set of name and value pairs that can be set on a session to
identify where a query originated. Query bands offer a way to identify the user and
application, for example, when applications use pooling mechanisms that hide the
identity of users because each connection in the pool logs into the database using
the same user account. Without query bands, there is no way to tell the source of
the request when the request comes from a multi-tiered application. Another
potential use of query bands is troubleshooting, when it is necessary to provide
the specific user or application that issued a request.
To set the query band, enter the band identifier string for the Query Band ID
parameter under Advanced Options. This string must be specified in the format
name1=value1;name2=value2;. You can specify a maximum of 2048
characters in the string.

5.2.5

Recovering Tables and Databases


When restoring on-line backups, the Teradata Plugin provides an option to roll
forward databases or tables from the journal archives. To apply the after-change
images in the restored journal, select the Roll Forward check box under ARC
Restore Options. The plugin completes the recovery as long as the table
structure is same as the structure of the change images. When recovering multiple
tables, the stopped recovery of one table (for example, if the structure of the table
and after change image do not match) does not affect the recovery of other tables.

70

Chapter 5
Restoring Data with Teradata Plugin
If you intend to restore incremental backups next, the rollfoward operation can be
performed with the last incremental restore job.

5.2.6

Choosing the BAR Server to Run the Job


For All-AMPs restores, you do not have to specify the target BAR Server while
defining the job. By selecting <AUTO> in the Run Job on Client list under
Overrides, you can direct the plugin to automatically find the most suitable target
and spawn the job on that BAR Server at run-time. The suitability of a BAR Server
is based on two criteria (1) the BAR Server has least number of concurrent
active jobs (2) it has local access to the data stream to restore. This ensures that
the job does not have to wait for drive or media availability during execution.
To override the auto-selection, and run the job on particular BAR Server, select the
target machine in the Run Job on Client list.

5.2.7

Finalizing and Submitting a Job


To finalize and submit the restore job, perform the following steps:
1. Click the Source, Target Client, Schedule and Advanced Options tabs,
and configure the required options.
These options are common to all NetVault: Backup plugins. For more
information on these options, refer to the NetVault: Backup Administrators
Guide.
2. Enter a title for the job in the Job Title box at the top right corner of the
Restore window. Specify a detailed title that allows you to easily identify the
job for monitoring its progress.
3. Click Submit on the toolbar. Alternatively, on the Accept menu, click Submit
Restore. To monitor the job progress and access logs, refer to Viewing Logs
and Job Progress on page 87.

5.3.0

Restoring or Copying Cluster Backups


The Teradata Plugin provides two methods to restore/copy the cluster backups:

Cluster Restore Method In this method, each sub-job restores one or


more clusters. The smallest data unit for a sub-job is a cluster. The user
specifies the maximum number of data streams that can be generated for a
restore job, and the plugin generates a restore script accordingly.

Multi-stream Restore Method This method can only be used to restore


cluster backups generated using Teradata Plugin v12.0 or later. The multistream restore method requires at least TTU 13.0. Additionally, you must
configure a TARA Server. This method provides enhanced parallelism. With
Multi-stream method, clusters are not considered the smallest unit for
generating streams. This method can use much smaller data units (for

NetVault: Backup Teradata Plugin


Users Guide

71

example, AMPs and sub-AMPs) to distribute data optimally and generate


multiple data streams. This enables faster restores. The ARCMAIN itself
determines how the data is distributed and what data each stream restores.
The restore script generated by the plugin does not contain this information.
To restore/copy cluster backups, perform the following steps:
1. Select the data for restore. For details, refer to Selecting Data for a Restore
on page 66.
2. Click the Restore Options tab. Under Login Information, enter the following
details:
Figure 5-3:
Restore
Options for
Cluster backup
methods

Target DBS The target database name is displayed in this box. Do not
change it.

Restore Account Depending on the restore method you want to use,


configure the restore account as described below:

Cluster Restore Method Do not change the default restore account.


The Teradata Plugin will automatically select the user accounts
required for concurrent restore operations.

Multi-stream Restore Method The Teradata Plugin automatically


selects any configured user to run the job. To run the job from a
particular user account, select the user in the list. To specify a user not
in the list, enter the user name in the Restore Account box.

72

Chapter 5
Restoring Data with Teradata Plugin

Password Enter the password associated with the configured user


account. For cluster restore method, this will be the common password
assigned to the restore accounts.

3. Under ARC Restore Options, select Restore or Copy method.


4. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.
5. To recover the database or tables using the restored journal, select the Roll
Forward check box. For details, refer to Recovering Tables and Databases
on page 69.
6. To generate copy of fallback tables and indexes for fallback and nonfallback
tables, select the Issue BUILD Statement check box under ARC Restore
Options. The build operation can be performed with the last incremental
restore job.
7. Depending on the restore method you are using, configure one of the
following parameters under MPP Options:

Maximum Parallel Data Streams to Use Enter the maximum number


of parallel streams that can be generated for the restore job. The number
of parallel streams depends on the total number of drives accessible to
the BAR Servers on which the sub-jobs will run.

Note: For the Multi-stream Restore Method, you can use the Maximum Parallel
Data Streams to Use option to reduce the number of parallel streams and use
fewer streams than what was used during backup. The plugin will restore the first
subset of data streams, and then continue with the next subset until all data
streams are restored. The remaining streams in the last subset may be lesser than
the configured maximum parallel data streams.

Use TARA Multi-stream Feature Select the Use TARA Multi-stream


Feature check box if you want to restore the cluster backup with the multistream restore method. This restore method requires at least TTU 13.0.
Additionally, you must configure a TARA Server.

8. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.4.0

Restoring or Copying Multi-stream Archives


The archives generated using the Full Multi-stream or Full Multi-stream On-line
backup methods are restored using the Multi-stream Restore method. Multistream Restore is a parallel restore method. This method supports smaller data
units in a backup data stream. The unit of data distribution is not necessarily a
cluster. This method can use smaller data units (for example, AMPs) to distribute
data optimally and generate multiple streams for quicker restores. The ARCMAIN

NetVault: Backup Teradata Plugin


Users Guide

73

itself determines how the data is distributed and what data each stream restores.
The restore script does not contain this information.
To restore/copy backups generated using the multi-stream backup methods,
perform the following steps:
1. Select the data for restore. For details, refer to Selecting Data for a Restore
on page 66.
2. Click the Restore Options tab. Under Login Information enter the following
details:
Figure 5-4:
Restore
Options for
Multi-stream
backup
methods

Target DBS The target database name is displayed in this box. Do not
change it.

Restore Account The Teradata Plugin automatically selects any


configured user to run the job. To run the job from a particular user
account, select the user in the list. To specify a user not in the list, enter
the user name in the Restore Account box.

Password - Enter the password associated with the configured user.

3. Under ARC Restore Options, select Restore or Copy method.


4. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.

74

Chapter 5
Restoring Data with Teradata Plugin
5. To recover the database or tables using the restored journal, select the Roll
Forward check box. For details, refer to Recovering Tables and Databases
on page 69.
6. To generate copy of fallback tables and indexes for fallback and nonfallback
tables, select the Issue BUILD Statement check box under ARC Restore
Options. The build operation can be performed with the last incremental
restore job.
7. Under MPP Options, configure the following parameter:

Maximum Parallel Data Streams to Use Enter the maximum number


of parallel streams that can be generated for the restore job. The number
of parallel streams depends on the total number of drives accessible to
the BAR Servers on which the sub-jobs will run.

Note: For Multi-stream Restore Method, you can use the Maximum Parallel Data
Streams to Use option to reduce the number of parallel streams and use fewer
streams than what was used during backup. The plugin will restore the first subset
of data streams, and then continue with the next subset until all data streams are
restored. The remaining streams in the last subset may be lesser than the
configured maximum parallel data streams.
8. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.5.0

Restoring or Copying Selected Partitions


To restore or copy selected partitions from an All-AMPs backup, perform the
following steps:
Note: The target table must exist to restore/copy the selected partitions.
1. Open the Restore window. On the Selections tab, open the saveset
containing the backup of PPI partitions. For details, refer to Selecting Data for
a Restore on page 66.
2. Select the partition to be restored using one of the following methods:

Figure 5-5:
Different
methods for
selecting data
from a PPI
Partition
Backup

NetVault: Backup Teradata Plugin


Users Guide

75

<PPI Table> (ALL PARTITIONS) Select this check box to restore all the
partitions within the selected saveset. The records within the range
specified by the partition expression is first dropped from the table, and
then the data in the archive is restored.

<PPI Table> (PARTITIONS WHERE <Filter Expression>) Select this


check box to modify the filter expression and select the records for
restore.
To modify the expression, right-click and select Modify PPI Expression.
In the Enter Partition Selection Expression box, the expression used to
backup the data is displayed. Modify the expression and click OK. The
records within the range specified by the expression is dropped from the
table first, and then the data in the archive is restored.

<PPI Table> - Warning! All Data in Target Table will be Dropped


Select this check box to drop all the records in the target table and restore
only the data in the saveset.

3. Click the Restore Options tab, and configure the login details. For details,
refer to Connecting to the Target DBS on page 67.
4. Under ARC Restore Options, select Restore or Copy method.
5. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.
6. To recover the database or tables using the restored journal, select the Roll
Forward check box. For details, refer to Recovering Tables and Databases
on page 69.
7. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
8. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.6.0

Restoring Incremental Backups


After restoring the All-AMPs or Cluster backups (as described in the sections
Restoring or Copying All-AMPs Archives on page 66 or Restoring or Copying
Cluster Backups on page 70), perform the following steps to restore the journal
archives:
1. Open the Restore window. On the Selections tab, open the incremental
saveset and select the data for restore. For details, refer to Selecting Data for
a Restore on page 66.
2. Click the Restore Options tab, and configure the login details. For details,
refer to Connecting to the Target DBS on page 67.

76

Chapter 5
Restoring Data with Teradata Plugin
3. Under ARC Restore Options, select the Restore method.
4. To apply the change-images in the journal archives, select the Roll Forward
check box. For details, refer to Recovering Tables and Databases on page
69.
5. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.
6. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
7. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.7.0

Restoring Dictionary Archives


To restore dictionary archives, perform the following steps:
1. Open the Restore window. On the Selections tab, open the saveset
containing the dictionary archive and select the data for restore. For details,
refer to Selecting Data for a Restore on page 66.
2. Click the Restore Options tab, and configure the login details. For details,
refer to Connecting to the Target DBS on page 67.
3. Under ARC Restore Options, select the Restore method.
4. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.
5. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
6. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.8.0

Renaming Objects During Restore


The Teradata Plugin allows you to rename an object while restoring it to the same
or an alternate database. This feature can be used when you want to create a
copy of a table or any other database object.
Note the following:

You must use the Copy method if you want to rename an object. The job will
fail if you try to rename objects using the Restore method.
An object with the same name must not exist in the database.

NetVault: Backup Teradata Plugin


Users Guide

77

This procedure cannot be used to rename the following objects:

Authorization Type

Instance or Constructor Methods

Macros

Triggers

User-defined Data Types

Views

To rename an object while copying it from the saveset, perform the following steps:
1. Select the data for restore. For details, refer to Selecting Data for a Restore
on page 66.
2. To rename an object, right-click the object and select Rename.
3. Select the Relocate check box, and enter the new name for the object in the
box to the right.
Figure 5-6:
RenameRelocate
window

4. Click OK. On the Selections tab, the new name for the object is displayed in
parenthesis.
Figure 5-7:
The new name
for the object
is displayed on
the Selections
tab

5. Repeat steps 24 for any other object that you want to rename.
6. Under ARC Restore Options, select the Copy method.
7. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67.
8. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run

78

Chapter 5
Restoring Data with Teradata Plugin
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
This step does not apply to cluster backups.
9. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.9.0

Copying Data to an Alternate Database


The Teradata Plugin allows you to copy data to an alternate DBS configuration,
which is useful when you want to migrate data from one database to another. The
target database to which the data is to be copied must already exist. The Teradata
Plugin will not create the target database.
To copy All-AMPs Cluster or Multi-stream backups to a different database, perform
the following steps:
1. Select the data for restore. For details, refer to Selecting Data for a Restore
on page 66.
2. Right-click the database node, and then select Rename.

Figure 5-8:
The Restore
Rename
window

3. Select the Relocate check box, and enter the target database name in the
box to the right.
4. Click OK. On the Selections tab, the target database name is displayed in
parenthesis.
Note: You can also rename tables and other database objects while copying them
to an alternate database. For details, refer to Renaming Objects During Restore
on page 76.
5. Click the Restore Options tab, and configure the login details under Login
Information:

Target DBS Enter the target database name. The database must have
been already be added to the Teradata Plugin. For details, refer to Adding
Teradata DBS on page 27.

Restore Account The Teradata Plugin automatically selects any


configured user to run the job. To run the job from a particular user
account, select the user in the list. To specify a user not in the list, enter
the user name in the Restore Account box.

NetVault: Backup Teradata Plugin


Users Guide

79

Password Enter the password associated with the configured user. For
cluster backups, enter the common password assigned to the restore
accounts.

6. Under ARC Restore Options, select COPY method.


7. For cluster backups, select the Restore to a Different Teradata
Configuration check box under ARC Restore Options. For All-AMPs
backups skip this step.
8. Configure the appropriate restore options. For details, refer to Configuring the
Restore Options on page 67. For cluster backups, clear the Use ARC
Catalog check box. For All-AMPs backups, you can select the check box if
the backup information was stored in a catalog.
Note: When restoring data to an alternate DBS configuration, a clustered saveset
will always be restored serially. The Maximum Parallel Data Streams to Use
parameter under MPP Options will not have any effect. If you select the Use
TARA Multi-stream Feature check box under MPP Options, the plugin will
ignore the option and log a warning message Multi-stream Copy - Option
'Restore to a Different Teradata Configuration' is Ignored.
9. To recover the database or tables using the restored journal, select the Roll
Forward check box. For details, refer to Recovering Tables and Databases
on page 69.
10.To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
This step does not apply to cluster backups.
11. Complete and submit the job. For detail, refer to Finalizing and Submitting a
Job on page 70.

5.10.0

Analyzing Archive Media


The ANALYZE method conducts a basic consistency check on the selected data
stream and displays the contents of the saveset without actually restoring the
data. The output of the ANALYZE statement is stored as Context Object in the
Logs. The Teradata Plugin provides the following two Analyze options:

Analyze Selections Use this option to analyze the contents of the selected
database in the archive.

Analyze All from Archive Use this option to analyze the contents of the
complete saveset.

80

Chapter 5
Restoring Data with Teradata Plugin
To analyze the contents of the archive, perform the following steps:
1. Open the Restore window. On the Selections tab, open the target saveset
and select the database. For details, refer to Selecting Data for a Restore on
page 66.
2. Click the Restore Options tab, and configure the login details. For details,
refer to Connecting to the Target DBS on page 67.
3. Under ARC Restore Options, select ANALYZE Selections or ANALYZE All
from Archive method.
4. Click Submit.
5. For details on viewing the output of ANALYZE statement, refer to Accessing
Job Logs on page 92

5.11.0

Generating ARC Script Only


The Teradata Plugins provides an option to generate the ARC scripts without
actually executing the job. These scripts are stored as Context Objects in the job
logs. You can save the script to files and use them with the User Script backup
option in Teradata Plugin, or run them outside the plugin.
To generate an ARC script, perform the following steps:
1. Select the data for restore. For details, refer to Selecting Data for a Restore
on page 66.
2. Click the Restore Options tab, and select Restore or Copy method under
ARC Restore Options.
3. Under ARC Restore Options, select the Generate ARC Script Only check
box.
4. Enter a suitable name for the job in the Job Title box.
5. Click Submit.
6. For details on viewing and saving the ARC script, refer to Accessing Job Logs
on page 92.

5.12.0

Restoring Data with User Scripts


This section describes the following procedures:

Restoring Data from User Script Backups

Restoring Data from Plugin Backups with User Scripts

Dumping Restore Map

NetVault: Backup Teradata Plugin


Users Guide

5.12.1

81

Restoring Data from User Script Backups


To restore data backed up with the User Script backup option, perform the
following steps:
1. Perform the procedure described in the section Analyzing Archive Media on
page 79, selecting either ANALYZE Selections or ANALYZE ALL from
Archive option to determine the contents of the saveset.
2. Perform the procedure described in the section Dumping Restore Map on
page 83 to determine the backup stream file name.
3. Using the information obtained in step 1 and step 2, write an ARC script for
restoring the required data.
In the ARC script, set the FILE parameter to Restore Map NVUSn as
displayed in the logs for the Dump Restore Map job. For example, set
FILE=NVUS1 when restoring All-AMPs archives. For cluster backups, specify
the Restore Map corresponding to the specific stream file. For example, set
FILE=NVUS1 for the dictionary data, FILE=NVUS2 for cluster 0 and so on for
the remaining clusters depending on the cluster sub-jobs.
For guidelines on writing user scripts, refer to Guidelines for Creating User
Scripts on page 103.
4. On the Selections tab, open the target saveset generated with the User
Script. Select the User Archive node that is displayed. Further drill-down is
not possible. For details on selecting data, refer to Selecting Data for a
Restore on page 66.
5. Click the Restore Options tab, and configure the appropriate restore
options. For details, refer to Configuring the Restore Options on page 67.
6. In the Run User Script box under Overrides, enter the file path for the script
file created in step 3. The script file must reside on the Teradata Master
Plugin node.
7. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
8. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

5.12.2

Restoring Data from Plugin Backups with User Scripts


This procedure can be used to restore specific cluster data, or exclude/include
data items manually. To restore plugin backups with user scripts, perform the
following steps:

82

Chapter 5
Restoring Data with Teradata Plugin
1. Perform the procedure described in the section Analyzing Archive Media on
page 79, selecting either ANALYZE Selections or ANALYZE ALL from
Archive option to determine the contents of the saveset.
2. Perform the procedure described in the section Dumping Restore Map on
page 83 to determine the backup stream file name.
3. Write an ARC script for restoring data using either of the following methods

Create an ARC Script Manually Using the information obtained in step


1 and step 2, write an ARC script for restoring the required data. In the
ARC script, set the FILE parameter to Restore Map NVUSn as displayed
in the logs for the Dump Restore Map job. For example, set
FILE=NVUS1 when restoring All-AMPs archives. For cluster backups,
specify the Restore Map corresponding to the specific stream file. For
example, set FILE=NVUS1 for the dictionary data, FILE=NVUS2 for
cluster 0 and so on for the remaining clusters depending on the cluster
sub-jobs. For guidelines on writing user scripts, refer to Guidelines for
Creating User Scripts on page 103.

Create an ARC Script Using Generate ARC Script Method Perform


the procedure described in the section Generating ARC Script Only on
page 80 to obtain the script and modify it to meet your requirements. For
cluster jobs, reconfigure the FILE parameter that is set to the stream file
FILE=NVCSn to the Restore Map FILE=NVUSn as displayed in the logs
for Dump Restore Map job. Specify the Restore Map corresponding to
the specific stream file. The job will fail if you use the stream file name
(NVCSn).

4. On the Selections tab, open the target saveset. For details, refer to Selecting
Data for a Restore on page 66. Select the top-level entity as any other
selection will be ignored.
5. Click the Restore Options tab, and configure the appropriate restore
options. For details, refer to Configuring the Restore Options on page 67.
6. In the Run User Script box under Overrides, enter the file path for the script
file created in step 3. The script file must reside on the Teradata Master
Plugin node.
7. To run the job on a particular BAR Server, select the target machine in the
Run Job on Client list. For details, refer to Choosing the BAR Server to Run
the Job on page 70. Ignore this step to automatically select a least loaded
BAR Server to perform the restore.
8. Complete and submit the job. For details, refer to Finalizing and Submitting a
Job on page 70.

NetVault: Backup Teradata Plugin


Users Guide

5.12.3

83

Dumping Restore Map


The Restore Map provides backup stream file names that must be used with User
Script option for restoring data. The Restore Maps are stored as Context Objects
in the Logs. To obtain a Restore Map, perform the following steps.
1. Open the Restore window. On the Selections tab, open the User Script
saveset or any other saveset. For details, refer to Selecting Data for a
Restore on page 66.
2. Click the Restore Options tab and select Dump Restore Map Only under
ARC Restore Options.
3. Enter a suitable name for the job in the Job Title box.
4. Click Submit.
5. For instructions on viewing and saving the ARC script, refer to Accessing Job
Logs on page 92.

5.13.0

Additional Features Available on the Selections


Tab
This section provides a brief description of the additional features present on the
Selections tab of the NVBU Restore window. These features are common to all
NVBU plugins. For details on their use, refer to the NetVault: Backup
Administrators Guide.

Sorting the Savesets To sort the savesets listed on the Selections tab,
select one of the following methods in the Selection Method list:

Plugin This is the default method. The savesets are ordered according
to the plugin used to generate them.

Backup Set To sort the savesets by the Selection Set used for the
backup, select Backup Set in the Selection Method list.

Job To sort the savesets by the Job Title, select Job in the Selection
Method list.

Filtering the Savesets To filter the savesets displayed on the Selections


tab, configure the following parameters under Filter Options:

By Date Range Select the By Date Range check box, and enter or
select the From and To dates in the boxes provided to list the savesets
generated during a given period.

Show On-line Status Select the Show On-line Status check box to list
the savesets stored on the currently online media.

Click Apply Filter to set the filter.

84

Chapter 5
Restoring Data with Teradata Plugin

5.14.0

Searching for Data Items To find a data item inside a saveset, right-click it
and select Search. Enter the item name in the Search String box and click
Search.

Viewing Media List To view the media list for a saveset, right-click it and
select Media List.

Compressing Indexes To compress the online indexes in order to reduce


the space used by the NVDB, right-click the target Client or the saveset, and
select Compress. The index is automatically de-compressed when you open
a saveset to browse or restore the data.

Additional Notes
Refer to the notes in this section before you run All-AMPs, Cluster or Multi-stream
restore jobs.

Restoring database DBC also restores database SYSUDTLIB automatically.

DBC and SYSUDTLIB databases must not be selected while using the COPY
method.

If you restore a data table with fallback from All-AMPs or Cluster backups
while one or more AMPs are offline, Teradata ARC generates the information
to restore the data on the offline AMPs when they return to operation. The
system recovery process restores the offline AMPs when they return to online
status.

For non fallback tables, it is recommended that you restore the All-AMPs or
Cluster backups when all AMPs are online. Alternatively, you can restore the
data to specific AMP as soon as they come back online. However, Teradata
Plugin does not support restores to specific AMPs. This must be performed
outside the plugin from the command line.

The Teradata Database does not generate transient journal images during
rollforward operation. If the operation is not completed, the data tables being
recovered are left in an unknown state.

The Teradata Plugin does the following while generating parallel data streams
for cluster restore if the media availability timeout interval has been set in the
Configure window:

Selects the least loaded BAR Servers depending on whether a suitable


drive/media is available or not, and whether the drive is currently in use or
not.

Ignores the BAR Servers with no suitable drive/media and logs a warning.

Waits for the availability of drives/media if all the drives are currently busy.

Aborts the job if no suitable drive/media is found.

When restoring Full Multi-stream and Full Multi-stream On-line backups, the
Teradata Plugin performs the following tasks:

NetVault: Backup Teradata Plugin


Users Guide

85

Restore stream 1 to the same BAR Server that backed it up.

If this BAR Server is not available, then restore stream 1 to any other
available BAR Server.

If no BAR Server is available to restore stream 1, then fail the entire


restore job.

Otherwise, continue with the other streams, and restore the ones that can
be restored to the same BAR Server that backed them up. Skip the
streams that cannot be restored to the same BAR Server

Restore the remaining streams to any other available BAR Server.

86

Chapter 5
Restoring Data with Teradata Plugin

NetVault: Backup Teradata Plugin


Users Guide

87

Chapter 6:

VIEWING LOGS AND JOB


PROGRESS
This chapter describes how to obtain the job progress information and access the
job logs. The information in this chapter is organized into the following topics:

6.1.0

Monitoring Job Progress

Viewing Job Progress Information for All-AMPs Jobs

Viewing Job Progress Information for Cluster Jobs

Viewing Job Progress Information for Multi-stream Jobs

Accessing Job Logs

Monitoring Job Progress


While a backup or restore job is running, you can monitor the job progress via the
Jobs window. The Teradata Plugin shows the data objects currently being backed
up or restored, the real-time data transfer rate and the amount of data transferred.
This information helps you predict the time when the job will be completed.
To monitor the progress of an active job, perform the following steps:
1. Open the Job Management window. (Click Job Management on the toolbar
or Large Buttons panel. Alternatively, on the Operations menu, click Job
Management.)
2. Click the Status tab.
3. Double-click an active job, or right-click and select Monitor Job.
4. Depending on the backup/restore method, refer to the following sections for
details:

Viewing Job Progress Information for All-AMPs Jobs.

Viewing Job Progress Information for Cluster Jobs.

Viewing Job Progress Information for Multi-stream Jobs.

5. Click OK to close the window.

88

Chapter 6
Viewing Logs and Job Progress

6.1.1

Viewing Job Progress Information for All-AMPs Jobs


For Full, Full On-line, Data Dictionary and Catalog Maintenance jobs, the Job
Monitor window displays the following information:

Figure 6-1:
Job Monitor
window for All
AMPs job

Job Information

Job Title The title given to the job

Job ID The job identification number

Instance Instance of the job running

Status The current status of the job (for example, Waiting for Media,
Writing to Media, Backup Completed, Backup Failed, etc.)

Data Transfer Details

Plugin Type Plugin name

Start Time Job start time

Duration The time elapsed since the job started

Client Name The BAR Server on which the job is running

Current Object The current object being backed up or restored (for


example, HEADER, <Table Name>, TRAILER)

Items Completed The number of items backed up

Xfer Volume Total data transferred

Xfer Time Actual time taken to transfer data

Xfer Rate Total data transferred/ Xfer Time (in KB/sec)

NetVault: Backup Teradata Plugin


Users Guide

6.1.2

89

Viewing Job Progress Information for Cluster Jobs


For cluster jobs, the Job Monitor window displays the following information:

Figure 6-2:
Job Monitor
window for
Cluster
Backups

Job Information

Job Title The title given to the job

Job ID The job identification number

Instance Instance of the job running

Status The current status of the job (for example, Waiting for Media,
Writing to Media, Backup Completed, Backup Failed, etc.)

Data Transfer Details

Plugin Type Plugin name

Start Time Job start time

Duration The time elapsed since job start

Master Client The name of the BAR Server on which the Teradata Master
Plugin is running

DBS Database name

Active Clients The BAR Servers on which the sub-jobs are running

90

Chapter 6
Viewing Logs and Job Progress

Inactive Clients The BAR Servers that are not participating in the backup/
restore job

Pending Jobs The sub-jobs that have not started

Performance Details

6.1.3

Job ID Job identification number for individual data streams. For Dictionary
phase, the Job ID will be 0 and for the cluster streams, the Job IDs will be 1,
2, etc.

Type Sub-job type (for example, Dictionary, Cluster)

Status Sub-job status (for example, In Progress, Completed)

Elapsed Time The time elapsed since the job started

Data Transferred Total data transferred

Transfer Rate Total data transferred/ Total elapsed time (in KB/sec)

Items Completed The number of items backed up. This information is


displayed as Items Completed/Total Items.

Client Name The BAR Server on which the sub-job is running

Viewing Job Progress Information for Multi-stream


Jobs
For multi-stream jobs, the Job Monitor window displays the following information:
Job Information

Job Title The title given to the job

Job ID The job identification number

Instance Instance of the job running

Status The current status of the job (for example, Waiting for Media,
Writing to Media, Backup Completed, Backup Failed, etc.)

Data Transfer Details

Plugin Type Plugin name

Start Time Job start time

Duration The time elapsed since job start

Master Client The name of the BAR Server on which the Teradata Master
Plugin is running

DBS Database name

Active Clients The BAR Servers on which the sub-jobs are running

Inactive Clients The BAR Servers that are not participating in the backup/
restore job

Pending Jobs The sub-jobs that have not started

NetVault: Backup Teradata Plugin


Users Guide
Figure 6-3:
Job Monitor
window for
Multi-stream
Backup

Performance Details

Job ID Job identification number for individual data streams.

Type Sub-job type. The job type is Multistream for all data streams.

Status Sub-job status (for example, In Progress, Completed)

Elapsed Time The time elapsed since the job started

Data Transferred Total data transferred

Transfer Rate Total data transferred/ Total elapsed time (in KB/sec)

Items Completed The total number of items backed up.

Client Name The BAR Server on which the job is running

91

92

Chapter 6
Viewing Logs and Job Progress

6.2.0

Accessing Job Logs


While the backup and restore jobs are in progress, the job events are written to the
NetVault: Backup logs. These logs can be viewed from the GUI via the Logs
window. The logs contain messages related to device and media activity, client
selection, ARC Output logs, and the job status. The output logs, ARC scripts, and
Restore Maps are stored as Context Objects, which can be saved to a text file.
To access the logs for a particular job, perform the following steps:
1. Open the Job Management window. (Click Job Management on the toolbar
or Large Buttons panel. Alternatively, on the Operations menu, click Job
Management.)
2. On the Status tab double-click a completed job, or right-click and select View
Log. The Right-click+View method can also be used to access the logs for
an active job.
3. In the NetVault Logs window all the entries related to the job will be
displayed. For each log entry, the following details are provided.

Warning Level Depending on their severity, the messages are


classified into different categories. Different color codes, called the
Warning Level Indicators, are used to distinguish the log categories. An
icon with an exclamation mark is used to represent messages that can be
opened further to view the details or log contexts. The log categories
include the following:

Background Messages The general messages are classified as


Background logs and represented with a green warning level indicator.

Information Messages The messages related to media, scheduler,


and system activities are classified as Information logs and
represented with a blue warning level indicator.

Job Message Messages The job activities are classified as Job


Messages and represented with a purple warning level indicator. By
default, only Job Messages and the higher categories are displayed.

Warning Messages Interferences during process execution are


classified as Warnings and represented with a yellow warning level
indicator.

Error Messages Problems encountered during execution which


might have caused a job to fail are classified as Error Logs and
represented with a red warning level indicator.

Severe Error Messages Critical problems encountered during


execution which might have caused a job to fail are classified as
Severe Error Logs and represented with a red warning level indicator.

NetVault: Backup Teradata Plugin


Users Guide

93

Date/Time The time stamp for the log in Year/Month/Date


Hour:Minute:Second format.

Job ID The Job ID for a backup, restore or a report job.

Class The type of operation that generated the log. For example, media
activity logs are classified as Media, messages sent by the plugin are
classified as Data Plugin, and job messages are classified as Job.

Client The name of the Client on which the process that generated the
log is running.

Log Message The detailed log message/description.

Figure 6-4:
Logs showing
the ARC
scripts
generated for
a Cluster
archive

Among the other entries, the ARC script, ANALYZE statement output, and
Restore Map can be identified by their Log Messages as described in the
table below. For cluster jobs, there are multiple log entries depending on the
number of parallel data streams generated for the job.
Output Type

Log Message

ARC Script for Backup and


Restore Jobs

Job File: ARC Script for Job

Output of Analyze Statement

Job File: ARC Script for Job #


ARCmain Output for Job
ARCmain Output for Job #

94

Chapter 6
Viewing Logs and Job Progress
Output Type
Restore Map

Log Message
Restore file NVUS1 -> Data Steam
Restore file NVUS1 -> Dictionary Stream
Restore file NVUS2 -> Cluster Stream

General Job Output

ARCmain Output for Job


ARCmain Output for Job #

4. Double-click a message with an exclamation mark to open one of the


following windows:

Additional Information Window If the log contains information about


data transfer or other such information, a window containing this
information is displayed.

View Job Context The log context typically contains the execution
scripts or output generated by the plugin.

Figure 6-5:
The log
context
window

5. To save a log context, click Save to File. In the Save Log Context window,
enter the file name and click OK. The file is saved to ...\NetVault\Logs
directory (where ... represents the NetVault: Backup installation directory).

Appendix

NetVault: Backup Teradata Plugin


Users Guide

97

Appendix A:

GLOSSARY
AMP
Access Module Processor
ARC
Archive and Recovery
BTEQ
Basic Teradata Query
COP
Communications Processor
DBC
Database Computer
DBS
Database System
HUT
Host Utility
MPP
Massively Parallel Processing
NetVault: Backup Client
NetVault: Backup Clients are machines that act as backup and/or restore targets.
These machines require at least the Client version of the NetVault: Backup
software.
NetVault: Backup Domain
NetVault: Backup is designed to work in an environment in which one machine is
configured as the NetVault: Backup Server and various other machines throughout
the network act as NetVault: Backup Clients assigned to it. A single Server and its
Clients make up a NetVault: Backup Domain. The Server acts as the domain
controller and all the Clients must be added to the Server to target them for
backups or restores.

98

Appendix A
Glossary
NetVault: Backup Server
NetVault: Backup Server is the core backup management software. The Server
controls all the operations within the NetVault: Backup domain and manages the
backup devices.
PI
Primary Index
PPI
Partitioned Primary Index
SMP
Symmetric Multi Processing
TDE
Teradata Extension
Teradata Master Plugin
The Teradata Master Plugin acts as an agent for the NetVault: Backup Server to
control the Teradata backup and recovery data flows for a Teradata DBS.
TPA
Trusted Parallel Application
TTU
Teradata Tools and Utilities

NetVault: Backup Teradata Plugin


Users Guide

99

Appendix B:

MIGRATING THE NETVAULT:


BACKUP SERVER
This appendix describes how to migrate NetVault: Backup Server from an
MP-RAS UNIX platform to a Windows or Linux platform. The information in this
chapter is organized into the following topics:

B.1.0

Prerequisites

Procedure for Migrating the Server

Prerequisites
Before starting the migration, refer to the following notes and complete the
required tasks:

Ensure that the Target Server has TCP/IP connectivity to all the existing
NetVault: Backup Clients.

Backup the NetVault Database (NVBD) using the NetVault Databases Plugin.
The NVDB contains information about the current NetVault: Backup system,
including the Clients, libraries, media and jobs. This data must be restored to
the new Server to migrate the existing settings. For more information on
using the NetVault Databases Plugin, refer to the NetVault: Backup
Administrators Guide. While performing NVDB backup, note down the bar
codes for the backup media. This can be used to identify the tapes during
restore.

Important: The historic logs will not be preserved when the setup is migrated. You
can, however, restore the log files from a previous NVDB backup and view it by
changing the log source temporarily on the Logs window.

B.2.0

Procedure for Migrating the Server


To migrate the NetVault: Backup Server, perform the following steps:
1. Open the Device Management window on the Source Server, and remove
all direct attached devices. For instructions on removing the devices, refer to
the NetVault: Backup Administrators Guide.
2. Stop NetVault: Backup services.

Start the NetVault: Backup Configurator. On the Service tab click Stop
Service.

100

Appendix B
Migrating the NetVault: Backup Server

Alternatively, open a terminal session and issue the following command:


./nvpmgr shutdown

3. Remove the devices physically and reconnect them to the Target Server.
4. Install the NetVault: Backup Server software on the Target Server. For
instructions on installing the Server software, refer to NetVault: Backup
Installation Guide.
Note the following:

The NetVault: Backup version must be the same as the Source Server.
Any upgrade must be done post migration.

The NetVault: Backup name must be the same as the Source Server.

The installation directory can differ on the two Servers. You can select any
directory on the Target Server.

The NVDB directory can differ on the two Servers. However, ensure that
the selected directory can accommodate the existing NVDB data and
meet the growing space requirements.

5. Install the Teradata Plugin and other plugins that were installed on the Source
Server. The plugin versions and the configuration must match on the two
Servers.
6. Start NetVault: Backup and open the Device Management window.
7. On the Add menu, click Add Library. Add any one drive connected to the
Server. Only one drive needs to be added to restore the NVDB. The
remaining settings can be restored from the NVDB backup.
8. Click the Configure tab. Double-click the library or right-click and select
Configure.
9. On the Configuration tab, click the Mark Unknown Media Blank check box.
This will mark all the media as Blank and help initialize the library quickly.
Otherwise, NetVault: Backup will try to load each tape and read its header,
which will take long to complete. Click OK to save the settings.
10.Click Save Details on the tool bar.
11. Load the NVDB backup media on library. If the media is not already loaded,
find the slot that contains the media (use the media barcode). Right-click the
slot and select Load.
12.The media will be marked as Foreign. Right-click the media and select Scan.
When the scanning completes, all the savesets contained in the media will be
displayed.
13.Open the Restore window, and the open the target saveset. Select the
following entities:

Backup Indexes To restore backup indexes

Media Manager To restore media related information

NetVault: Backup Teradata Plugin


Users Guide

101

Schedule Manager To restore job schedule

Depending on your setup, select the following additional items:

Events To restore custom events defined for backup and/or report jobs

General Report Files To restore custom report templates

Keys To restore the permanent license key for NetVault: Backup Server

Scripts To restore pre or post backup scripts

User Level Access To restore access control settings

14.Click Submit.
The NetVault: Backup service will stop automatically when the job completes.
To restart the service, do one of the following:

Start NetVault: Backup Configurator. On the Service tab, click Start


Service.

Alternatively, open a terminal session and issue the following command:


nvpmgr restart

When the Server is successfully migrated, the following would occur:

All the previously defined jobs run at the scheduled time.

The job definitions can be accessed and modified from the Jobs window.

The Server recognizes all the backup media and the media rotation policies
remain unaffected.

Note: To view the historic logs, restore the log files from an NVBD backup. Open
the Logs window. On the Options menu, click Select Logs Source. In the Select
Log Source window, enter the log file path. For more information, refer to the
NetVault: Backup Administrators Guide.

102

Appendix B
Migrating the NetVault: Backup Server

NetVault: Backup Teradata Plugin


Users Guide

103

Appendix C:

CREATING USER SCRIPTS


This appendix provides general guidelines for creating archive and restore scripts
that can be run using the Teradata Plugin. The information in this chapter is
organized into the following topics:

C.1.0

Guidelines for Creating User Scripts

Logon String

Backup Scripts

Restore Scripts

Guidelines for Creating User Scripts


The Teradata Plugin provides a User Script backup and recovery method which
can be used to run your own archive and recovery scripts. A thorough knowledge
of ARC scripting language is necessary to write these scripts. Additionally, you
must follow certain rules to make these scripts understandable to the Teradata
Plugin. The following sections explain these rules.

C.1.1

Logon String
All scripts must begin with a logon string that connects to the Teradata DBS. There
are two ways to write the logon script:

Write the full logon string. This method is simple but lacks security as the
password is visible in the script file.

Alternatively, enter the following string:


LOGON $LOGON;
This method uses the cached login details. The ARC tries to log on as the
same user that originally scheduled the job. This method is considerably
more secure and the password is not displayed in clear text anywhere on the
system. However, this method will work only if a connection has been
previously established from the given machine to Teradata DBS.

C.1.2

Backup Scripts
The following naming convention is recommended for the script files:
FILE=NVUSn
where <n> represents the file number used for cluster backups.

104

Appendix C
Creating User Scripts
n

Represents

Dictionary

Cluster Group #0

Cluster Group #1

4 (etc.)

Cluster Group #2 (etc.)

The script file name for the cluster phase must not begin with the letters NVC.

C.1.3

Restore Scripts
Refer to the following notes while creating a restore script:

Follow the backup script naming convention.

Examine the backup scripts to find out which file contains what data and enter
the correct file number in the Restore statement to restore the intended data.

You can access the backup archives in any order.

When using plugin generated ARC scripts for Cluster restores, change the
cluster stream file name (for example, NVCS1) to the corresponding Restore
Map file (for example, NVUS2).

NetVault: Backup Teradata Plugin


Users Guide

105

Appendix D:

NETVAULT: BACKUP CLI


CONSIDERATIONS
This appendix provides additional information on using the NetVault: Backup CLI
Utility with the Teradata Plugin. It is intended as a supplement to the NetVault:
Backup Command Line Interface Reference Guide, and contains Teradata Plugin
specific information. The information in this appendix is organized into the
following topics:

D.1.0

NetVault: Backup CLI and the Teradata Plugin

Supported CLI Commands

CLI Commands Providing Limited or No Functionality

nvsetcreate

nvsetmodify

nvjobcreate

nvjobmodify

nvrestore

NetVault: Backup CLI and the Teradata Plugin


The NetVault: Backup CLI is common to all plugins, and is described in detail in
the NetVault : Backup Command Line Interface Reference Guide. The following
sections provide information on the utilities that are fully supported by the Teradata
Plugin, and the others which are not supported or provide limited functionality.

D.1.1

Supported CLI Commands


The following CLI commands can be used with the Teradata Plugin without any
restriction or issues:

Client-specific Commands

Devices-specific Commands

Job-specific Commands Only the following job-specific commands are


fully supported by the Teradata Plugin:

nvjoblist

nvjobstart

nvjobabort

nvjobhold

106

Appendix D
NetVault: Backup CLI Considerations

D.1.2

nvjobresume

nvjobexport

nvjobimport

nvtrigger

nvsetdelete

nvjobdelete

Media-specific Commands

Logs Related Commands

Other CLI Commands

CLI Commands Providing Limited or No Functionality


The following CLI commands have some known issues or limitations when you
use them with the Teradata Plugin:

D.1.2.a

nvsetcreate
The nvsetcreate command can be used to create the following types of Selection
Sets:

Backup Selection Set

Important: The default login for database browsing must be configured in order to
create a backup selection set using nvsetcreate.

Restore Selection Set

Schedule Set

Backup Target Set

Advanced Backup Options Set

Advanced Restore Options Set

This command cannot be used to create a Backup Options Set since the Teradata
Plugin does not support the -backupoption switch. A Backup Options Set can
only be created from the Backup window.
Note: NetVault: Backup does not support Restore Options Set for any plugin.

Examples

Create a Backup Selection Set BS1 to include database DB1


nvsetcreate -setname BS1 -type BS -client TDBAR1
-plugin TeraData
-include "bkb4480/Hierarchical View/DBC/DB1"

Create a Restore Selection Set RS1 to include database DB1

NetVault: Backup Teradata Plugin


Users Guide

107

nvsetcreate -setname RS1 -type RS -client TDBAR1 -plugin


TeraData -saveset 31
-include "<All Objects>/DB1"

D.1.2.b

nvsetmodify
The nvsetmodify command can be used to modify the following types of
Selection Sets:

Backup Selection Set

Restore Selection Set

Schedule Set

Backup Target Set

Advanced Backup Options Set

Advanced Restore Options Set

This command cannot be used to modify a Backup Options Set since the Teradata
Plugin does not support the -backupoption switch. A Backup Options Set can
only be modified from the Backup window.

Examples

Modify Backup Selection Set BS1 to include database DB2 instead of DB1
nvsetmodify -setname BS1 -type BS -change
@tree@path@"bkb4480/Hierarchical View/DBC/DB1"=DB2

Modify Restore Selection Set RS1 to include database DB2 instead of DB1
nvsetmodify -setname RS1 -type RS -change
@tree@path@"<All Objects>/DB1"=DB2

D.1.2.c

nvjobcreate
The nvjobcreate command can be used to create and run Teradata Plugin
backup jobs. However, you cannot use the -backupoption switch.
This command cannot be used for Teradata Plugin restore jobs because of the
following reasons:

D.1.2.d

NetVault Backup does not support a Restore Options Set for any plugin.

The Teradata Plugin cannot run a restore job with the default plugin settings.
It requires at least the Restore Account password to complete a restore job,
and it cannot be from the CLI.

nvjobmodify
The nvjobmodify command can be used to modify the Job Title or the Selection
Sets being used for a backup job. However, you cannot use the
-change Options switch to modify the backup options for a Teradata Plugin job.

108

Appendix D
NetVault: Backup CLI Considerations

D.1.2.e

nvrestore
The nvrestore command cannot be used to restore Teradata Plugin backups. The
-path option, which is a required switch, cannot be specified correctly for the
Teradata Plugin restore jobs. The Teradata Plugin only supports the -list switch
that lists all the completed backups. To restore Teradata Plugin backups from the
CLI, you can use the nvjobcreate and nvjobstart commands, instead.

NetVault: Backup Teradata Plugin


Users Guide

109

Appendix E:

TROUBLESHOOTING
This appendix describes how to troubleshoot some commonly encountered errors.
The information in this chapter is organized into the following topics:

E.1.0

Common Errors

Common Errors
This section lists some common errors and their solution. In cases where an error
occurs and it is not described in this section, obtain the ARC error number from the
Logs and refer to the relevant Teradata Documentation for resolution.

Backup Completed with Warnings


Failed to add backup record
and/or
Failed to write index of backup to the database
These messages indicate that the data was actually backed up but the index
information was not properly added to the NVDB. Without the index the data
cannot be restored. To correct this problem, perform the following:
Open the Device Management window and scan the backup media. This will
write the on tape indexes to the NVDB. To verify, try to open the contents of
the saveset in the Restore window. If the contents are displayed, it implies
that the problem has been corrected.
If this method fails, run the job again.

Backup Failed
User does not have BACKUP access to database xxx
The user does not have sufficient privileges to perform backups. Grant the
necessary privileges or configure another user account with sufficient
privileges to perform backups.

Restore Failed
User identification is not authorized
User does not exist or the password is incorrect. Refer to the section Creating
User Accounts for Parallel Restores on page 32 to configure the restore
accounts.

110

Appendix E
Troubleshooting

Restore Failed
User does not have RESTORE access to database xxx
The restore accounts do not have the required privileges. Refer to the section
Granting Privileges to the Accounts on page 34 to grant the necessary
privileges.

Restore Failed
Unable to locate catalog table
While restoring backups for which Catalog database was not used, disable
the Use ARC Catalog option.

You might also like