emc avamar db2 client - dell emc czech republic · avamar db2 client 4.1 • installation guide and...

INSTALLATION GUIDE AND REFERENCE MANUALP/N 300-007-031

REV A01

EMC CORPORATION

COPORATE HEADQUARTERS:HOPKINTON, MA 01748-9103

1-508-435-1000WWW.EMC.COM

EMC AVAMAR

DB2 CLIENT4.1

Copyright and Trademark Notices

This document contains information proprietary to EMC. Due to continuing product development, product specifications and capabilities are subject to change without notice. You may not disclose or use any proprietary information or reproduce or transmit any part of this document in any form or by any means, electronic or mechanical, for any purpose, without written permission from EMC.

EMC has made every effort to keep the information in this document current and accurate as of the date of publication or revision. However, EMC does not guarantee or imply that this document is error free or accurate with regard to any particular specification. In no event will EMC be liable for direct, indirect, incidental or consequential damages resulting from any defect in the documentation, even if advised of the possibility of such damages. No EMC agent or employee is authorized to make any modification, extension or addition to the above statements.

EMC may have patents, patent applications, trademarks, copyrights or other intellectual property rights covering subject matter in this document. The furnishing of this document does not provide any license to these patents, trademarks, copyrights or other intellectual property.

The Avamar Agent for Microsoft Windows incorporates Open Transaction Manager (OTM), a product of Columbia Data Products, Inc. (CDP). CDP assumes no liability for any claim that may arise regarding this incorporation. In addition, EMC disclaims all warranties, both express and implied, arising from the use of Open Transaction Manager. Copyright 1999-2002 Columbia Data Products, Inc. Altamonte Springs. All rights reserved.

Avamar, RAIN and AvaSphere are trademarks or registered trademarks of EMC in the US and/or other countries.

All other product names and/or slogans mentioned herein may be trademarks or registered trademarks of their respective companies. All information presented here is subject to change and intended for general information.

Copyright 2002-2008 EMC. All rights reserved.

Protected by US Patents No. 6,704,730, 6,810,398 and patents pending.

Printed in the USA.

TABLE OF CONTENTS
Foreword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Scope and Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Product Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Typeface Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Notes, Tips and Warnings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Pre-Installation Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Register Avamar Client and Create User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Installing Avamar DB2 Client on IBM AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Download Avamar AIX DB2 Install Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Install and Register the Avamar AIX Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Install and Configure the Avamar DB2 Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Uninstalling Avamar DB2 Client on IBM AIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Installing Avamar DB2 Client on Microsoft Windows x64 . . . . . . . . . . . . . . . . . . . . . . . . 20

Install the Avamar Windows Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Register the Avamar Windows Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Install the Avamar Windows x64 DB2 Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Uninstalling and Upgrading the Avamar DB2 Client on Microsoft Windows x64. . . . . . . 23

Using the Avamar DB2 Client on IBM AIX . . . . . . . . . . . . . . . . . . . . . . . . .24Database Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24On-Demand Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Scheduling DB2 Server Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Create a New Dataset for DB2 Server Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Set Up Scheduled DB2 Server Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Enable Scheduled DB2 Server Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Using the Avamar DB2 Client on Microsoft Windows x64 . . . . . . . . . . .41Capabilities and Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Appendix A — Plug-in Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43Setting Plugin Options Using Graphical Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Entering Option Names and Values as Free Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

AVAMAR DB2 CLIENT 4.1 • INSTALLATION GUIDE AND REFERENCE MANUAL 3

TABLE OF CONTENTS

Common Plugin Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Backup Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Restore Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

AIX DB2 Plugin Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Backup Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Restore Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Windows DB2 Plugin Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Advanced Technical Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55


FOREWORD

Scope and Intended AudienceScope. This publication describes how to install, configure, administer and use the Avamar DB2 Client.

Intended Audience. The information in this publication is primarily intended for:

• System administrators who are responsible for installing software and maintaining servers and clients on a network

• Database Administrators (DBAs) who are responsible for backing up and maintaining DB2 databases

Prerequisites. Persons using this publication should have current practical experience with the following:

• Operating system shell commands (root permission required)• The specific version of DB2 software currently deployed at your site

Product InformationFor current documentation, release notes, software updates, as well as information about EMC products, licensing and service, go to the EMC Powerlink web site at http://Powerlink.EMC.com.


Notes, Tips and WarningsFOREWORD

Typeface ConventionsThe following table provides examples of standard typeface styles used in this publication to convey various kinds of information.

Notes, Tips and WarningsThe following kinds of notes, tips and warnings appear in this publication:

IMPORTANT: This is a warning. Warnings always containinformation that if not heeded could result in unpredictablesystem behavior or loss of data.

TIP: This is a tip. Tips present optional information intendedto improve your productivity or otherwise enhance yourexperience with our product. Tips never contain informationthat will cause a failure if ignored.

NOTE: This is a general note. Notes contain ancillary infor-mation intended to clarify a topic or procedure. Notes nevercontain information that will cause a failure if ignored.

EXAMPLE DESCRIPTION

Click OK. - or -Choose File > Close.

Bold text denotes actual Graphical User Interface (GUI) buttons, commands, menus and options (any GUI element that initiates action).Also note in the second example that sequential commands are separated by a greater-than (>) character. In this example, you are being instructed to choose the Close command from the File menu.

Enter: cd /temp

Bold fixed-width text denotes shell commands that must be entered exactly as they appear in this publication.

--logfile=FILE All caps text often denotes a placeholder (token) for an actual value that must be supplied by the user. In this example, FILE would be an actual filename.

Installation Complete. Regular (not bold) fixed-width text denotes command shell messages. It is also used to list code and file contents.



INTRODUCTIONThe Avamar DB2 Client provides a complete backup and restore solution for DB2 databases. Once a database has been backed up to the Avamar system, the entire database can be quickly restored without having to locate and mount tapes or optical media.

System RequirementsIn order to install and use the Avamar DB2 Client, the DB2 database server must meet the following minimum requirements:

REQUIREMENT MINIMUM

Operating System • IBM AIX 5.2• IBM AIX 5.1• Microsoft Windows x64 (non-Itanium)

RAM 64 MB.

Hard Drive Space 130 MB permanent hard drive space for software installation.The Avamar client software also requires an additional 12 MB of permanent hard drive space for each 64 MB of physical RAM. This space is used for local cache files.

Network Interface 10baseT minimum; 100baseT or higher recommended, configured with latest drivers for your platform.

Adobe Acrobat Reader 5.0 or higher. Available from www.adobe.com.Required in order to view online documentation.

Other Software DB2 8.2

INSTALLATION AND CONFIGURATIONThis chapter describes how to install and configure Avamar DB2 Client software on the computer hosting the DB2 database. Two basic server platforms are supported:

• IBM AIX• Microsoft Windows x64

The Pre-Installation Checks (page 8) and Register Avamar Client and Create User Account (page 9) tasks are applicable to all server platforms. However, use the correct client installation procedure for your specific server platform.

Pre-Installation ChecksBefore installing any Avamar software, perform the following:

1. Ensure that you have operating system root privileges on the computer hosting the DB2 server.

2. Ensure that DB2 is installed and functioning properly.

3. Ensure that the Avamar server is operational and present on the same network as the DB2 server.

You can verify this by opening a command shell on the DB2 server and entering the following:

ping AVAMARSERVER

Where AVAMARSERVER is the network hostname (as defined in DNS) or IP address of your Avamar server.

4. Make note of the actual network hostname (as defined in DNS) for:

• Avamar server• Utility node

These DNS entries should have been added during deployment of the Avamar system at your site.


Register Avamar Client and Create User AccountINSTALLATION AND CONFIGURATION

Register Avamar Client and Create User AccountAlthough Avamar provides a default client registration/activation mechanism, registering this client and creating this user account with the Avamar system ensures that they get added to the system in a way that best meets your specific needs.

A complete discussion of registering and activating new Avamar clients, domains and user accounts is beyond the scope of this publication. Refer to the Avamar System Administration Manual for additional information.

1. Start Avamar Administrator and log into your Avamar server.

2. Choose Navigation > Administration or click the launcher Administration button.

The Administration window appears.

Add a New Clientto the Avamar

System

3. Click the Account Management tab.

4. Select which domain you want to add this client to.

TIP: You may also want to consider adding a new domain tothe Avamar system in order to segregate clients performingDB2 backups from clients backing up physical filesystems.However, this is entirely optional. You can add this client toany existing Avamar domain.

Refer to the Avamar System Administration Manual for addi-tional information



5. Choose Actions > Account Management > New Client… or click the toolbar icon shown immediately to the left.

The New Client dialog box appears.

6. Enter the following:

7. Click OK.

The New Client dialog box closes and the new client appears in the Account Management tree pane.

Create a New UserAccount for This

Client

The remaining steps create an Avamar user account that will be used to access the client backups in the Avamar system.

8. Switch to the Administration window.

9. Click the Account Management tab.

10.Select the client you just added.

FIELD DESCRIPTION

New client name Enter the new client name here.IMPORTANT: In order to ensure error-free client registration, this Avamar client name must be the actual DB2 server network hostname as defined in DNS.

Contact Optional contact name.

Phone Optional contact telephone number.

Email Optional contact email address.

Location Optional contact location.



11.Choose Actions > Account Management > New User(s)… or click the toolbar icon shown immediately to the left.

The New User dialog box appears.

12. Enter or select the following:

13.Click OK.

The following status message appears: User added.

FIELD/OPTION DESCRIPTION

Authentication System

Select either the default internal Avamar Authentication System, or any external authentication system you have configured to work with Avamar.

Everyone Set this option if you want to designate privileges for all users on this client.

User Name Set this option and enter the new user name.IMPORTANT: If you are using an external authentication system, this must be the user name you use to log into that system.

Privilege Select the Backup and Restore privilege for this user.

Password Enter your password. Avamar passwords must be at least six characters long.This field is not used if you are using an external authentication system.

Confirm Re-enter your password to confirm that you did not enter it incorrectly in the Password field.This field is not used if you are using an external authentication system.


Installing Avamar DB2 Client on IBM AIXINSTALLATION AND CONFIGURATION

14.Click OK.

The status message closes and the new user appears in that client’s list of users.

NOTE: dba-1 is used as an example Avamar user name inthe remainder of this installation procedure. Your actual Ava-mar user name may be different.

Installing Avamar DB2 Client on IBM AIXTask List In order to successfully install the Avamar DB2 Client on supported IBM AIX

platforms, you must perform all the following installation tasks:

• Download Avamar AIX DB2 Install Packages (page 12)• Install and Register the Avamar AIX Client (page 13)• Install and Configure the Avamar DB2 Plug-In (page 15)

Download Avamar AIX DB2 Install Packages1. Log into the computer hosting the DB2 server.

2. Point your web browser at the Avamar server by entering the following URL:

http://AVAMARSERVER

Where AVAMARSERVER is your actual Avamar system network hostname (as defined in DNS) or IP address.

You will be automatically redirected to the Avamar secure web server.

Depending on your browser security settings, a security alert dialog box might appear.

3. If a security alert dialog box appears, click Yes or OK to allow redirection to the Avamar secure web server.

The Secure Log On page appears.

4. Page down until the Downloads and Documents hyperlink is visible.

5. Click Downloads and Documents.

The Downloads and Documentation page appears.

6. Click the appropriate operating system hyperlink for the computer hosting the DB2 server.

A directory listing appears in your browser.



Download AvamarAIX ClientPackage

7. Download the Avamar AIX Client install package to any convenient temporary install directory on your system.

NOTE: /tmp is used as an example temporary install direc-tory in the remainder of this installation procedure. Youractual temporary install directory may be different.

8. Note the actual filename of the Avamar AIX Client install package.

NOTE: AVAMARAIX.bff is used as an example filename forthe Avamar AIX Client install package in the remainder ofthis installation procedure. Your actual filename will be dif-ferent.

Download AvamarDB2 Plug-In

9. Download the Avamar DB2 plug-in install package to the same directory as the Avamar AIX Client install package.

10.Note the actual filename of the Avamar DB2 plug-in install package.

NOTE: AVAMARAIXDB2.bff is used as an example filenamefor the Avamar DB2 plug-in install package in the remainderof the AIX installation and configuration procedure. Youractual filename will be different.

Install and Register the Avamar AIX ClientLog in as root 1. Open a command shell and log into the computer hosting the DB2 server

as root.

Install Avamar AIXClient Software

2. Enter:

cd /tmp

geninstall -d AVAMARAIX.bff all

Where AVAMARAIX.bff is the actual Avamar AIX Client install package you previously downloaded (page 13).

The following appears in the command shell:

+----------------------------------------------------------------------------+Pre-installation Verification...

+----------------------------------------------------------------------------+Verifying selections...doneVerifying requisites...doneResults...SUCCESSES---------

Filesets listed in this section passed pre-installationverification and will be installed.

Selected Filesets-----------------

AVMRclnt 4.1.0-910 # Avamar AIX Client 4.1.0-910...



<< End of Success Section >>

FILESET STATISTICS------------------

1 Selected to be installed, of which:1 Passed pre-installation verification

----1 Total to be installed

Filesystem size changed to 524288

+----------------------------------------------------------------------------+Installing Software...

+----------------------------------------------------------------------------+installp: APPLYING software for:

AVMRclnt 4.1.0.910

. . . . . << Copyright notice for AVMRclnt >> . . . . . . .

This software is copyright EMC 2001-2008.

Please read and agree to the End User License Agreement which will be placed in the base directory of the install as a file named AvamarClient-License.txt.

. . . . . << End of copyright notice for AVMRclnt >>. . . .

Installation completeYou may run /usr/local/avamar/bin/avregister to register and activate this client with the Administrator server.avagent Info <5241>: Logging to /usr/local/avamar/var/avagent.logavagent Info <5417>: daemonized as process id 17444avagent.d Info: Client Agent started.Finished processing all filesets. (Total time: 9 secs).

+----------------------------------------------------------------------------+Summaries:

+----------------------------------------------------------------------------+

Installation Summary--------------------

Name Level Part Event Result-----------------------------------------------------------------------------AVMRclnt 4.1.0.910 USR APPLY SUCCESS

Register this ClientWith the Avamar

Server

3. Enter:

/usr/local/avamar/bin/avregister


=== Client Registration and ActivationThis script will register and activate the client with the Administrator server.

Enter the base directory of the AvamarClient installation [/usr/local/avamar]:

4. Press ENTER to accept the default base installation directory.


Enter the Administrator server address (DNS text name, not numeric IP address):

5. Enter the actual network hostname (as defined in DNS) of your Avamar Administrator server and press ENTER.



NOTE: The remainder of this procedure uses dpn01mcs foradministrator server network hostname. Your administratorserver network hostname may be different.


Enter the Avamar server domain [clients]:Avamar

The default domain is “clients.” However, your Avamar system administrator may have defined other domains and sub-domains. Consult your Avamar system administrator for the specific domain you should use when registering this client.

IMPORTANT: If entering a sub-domain (for example, (forexample, clients/aix), do not include a slash (/) as the firstcharacter. Including a slash as the first character will causean error and prevent you from registering this client.

6. Press ENTER to accept the default domain (clients).


avagent.d Info: Server stopped.avagent Info <5241>: Logging to ///usr/local/avamar//var/avagent.logavagent.d Info: Client activated successfully.avagent.d Info: startavagent Info <5241>: Logging to ///usr/local/avamar//var/avagent.logavagent Info <5417>: daemonized as process id 17620avagent.d Info: Server started.Registration Complete.

Install and Configure the Avamar DB2 Plug-In

IMPORTANT: You must Install and Register the AvamarAIX Client (page 13) before installing the Avamar DB2 Plug-In.

Log in as root 1. Open a command shell and log into the computer hosting the DB2 server as root.

Install Avamar DB2Plug-In Software

2. Enter:

cd /tmp

geninstall -d AVAMARAIXDB2.bff all

Where AVAMARAIXDB2.bff is the actual filename of the Avamar DB2 plug-in install package you downloaded (page 13).


+----------------------------------------------------------------------------+Pre-installation Verification...

+----------------------------------------------------------------------------+Verifying selections...doneVerifying requisites...doneResults...



SUCCESSES---------

Filesets listed in this section passed pre-installationverification and will be installed.

Selected Filesets-----------------

AVMRdb2 4.1.0-910 # EMC Avamar client 4.1.0-910...



1 Selected to be installed, of which:1 Passed pre-installation verification

----1 Total to be installed

+----------------------------------------------------------------------------+Installing Software...

+----------------------------------------------------------------------------+installp: APPLYING software for:AVMRdb2 4.1.0-910

. . . . . << Copyright notice for AVMRdb2 >> . . . . . . .

This software is copyright EMC 2001-2008.

Please read and agree to the End User License Agreement whichwill be placed in the base directory of the install as a filenamed AvamarClient-License.txt.

. . . . . << End of copyright notice for AVMRdb2 >>. . . .

installdir is /usr/local/avamar/AVMRdb2total 680-rw-r--r-- 1 root sys 12986 Mar 17 20:49 AvamarClient-License.txt-rwxr-xr-x 1 root sys 25182 Mar 17 20:49 avdb2-rwxr-xr-x 1 root system 24871 Dec 13 03:57 avdb2.save1-rwxr-xr-x 1 root sys 5545 Mar 17 20:49 avsetupdb2-rw-r--r-- 1 root sys 119 Mar 17 20:49 db2.pin-rwxr-xr-x 1 root sys 209 Mar 17 20:49 db2backup-rwxr-xr-x 1 root sys 197 Mar 17 20:49 db2list-rwxr-xr-x 1 root sys 327 Mar 17 20:49 db2logpath-rws------ 1 root sys 241856 Mar 17 20:49 db2owner-rwxr-xr-x 1 root sys 230 Mar 17 20:49 db2restoreInstallation completeYou may run /usr/local/avamar/AVMRdb2/avsetupdb2 to configure this module to backup to the dpn.Finished processing all filesets. (Total time: 1 secs).

+----------------------------------------------------------------------------+Summaries:

+----------------------------------------------------------------------------+


Name Level Part Event Result-----------------------------------------------------------------------------AVMRdb2 4.1.0-910 USR APPLY SUCCESS



Configure DB2Plug-In Software

3. Enter:

NOTE: The following example shell session uses db2dba asthe database instance owner and /data02/db2qa as thatuser’s home directory.

/usr/local/avamar/AVMRdb2/avsetupdb2


This script will configure the EMC Avamar DB2 plugin

Enter path to EMC Avamar Client installation [/usr/local/avamar]:

4. Press ENTER.

The following appears in the command shell:Username for DB2 instance owner: db2dba

5. Enter the user account that owns this database instance and press ENTER.


Home directory for DB2 instance owner [/home/db2dba]:

6. Enter the full path to the home directory of the user that owns this database instance and press ENTER.

The following appears in the command shell:Writing /usr/local/avamar/etc/db2.cfg...

Restarting client agent...avagent.d Info: Stopping Avamar Client Agent (avagent)...avagent.d Info: Client Agent stopped.avagent Info <5241>: Logging to /usr/local/avamar/var/avagent.logavagent Info <5417>: daemonized as process id 36886avagent.d Info: Client Agent started.

Trying to get list of databases from /data02/db2dba...

System Database Directory

Number of entries in the directory = 3

Database 1 entry:

Database alias = TOOLSDBDatabase name = TOOLSDBLocal database directory = /data02/db2dbaDatabase release level = a.00Comment =Directory entry type = IndirectCatalog database partition number = 0Alternate server hostname =Alternate server port number =

Database 2 entry:

Database alias = QADatabase name = QALocal database directory = /data02/db2dba/db2dbaDatabase release level = a.00Comment =Directory entry type = Indirect


Uninstalling Avamar DB2 Client on IBM AIXINSTALLATION AND CONFIGURATION

Catalog database partition number = 0Alternate server hostname =Alternate server port number =

Database 3 entry:

Database alias = SAMPLEDatabase name = SAMPLELocal database directory = /data02/db2dbaDatabase release level = a.00Comment =Directory entry type = IndirectCatalog database partition number = 0Alternate server hostname =Alternate server port number =

Uninstalling Avamar DB2 Client on IBM AIXLog in as root 1. Open a command shell and log into the computer hosting the DB2 server

as root.

Uninstall AvamarDB2 Plug-In

Software

2. Enter:

geninstall -u AVMRdb2

The following appears in the command shell:+----------------------------------------------------------------------------+

Pre-deinstall Verification...+----------------------------------------------------------------------------+Verifying selections...avagent.d Info: Stopping Avamar Client Agent (avagent)...avagent.d Info: Client Agent stopped.avagent Info <5241>: Logging to /usr/local/avamar/var/avagent.logavagent Info <5417>: daemonized as process id 36882avagent.d Info: Client Agent started.doneVerifying requisites...doneResults...

SUCCESSES---------

Filesets listed in this section passed pre-deinstall verificationand will be removed.

Selected Filesets-----------------AVMRdb2 4.1.0-910 # EMC Avamar client 4.1.0-910...



1 Selected to be deinstalled, of which:1 Passed pre-deinstall verification----

1 Total to be deinstalled

+----------------------------------------------------------------------------+Deinstalling Software...

+----------------------------------------------------------------------------+

installp: DEINSTALLING software for:AVMRdb2 4.1.0-910

Finished processing all filesets. (Total time: 8 secs).


Uninstalling Avamar DB2 Client on IBM AIXINSTALLATION AND CONFIGURATION

+----------------------------------------------------------------------------+Summaries:

+----------------------------------------------------------------------------+


Name Level Part Event Result-----------------------------------------------------------------------------AVMRdb2 4.1.0-910 USR DEINSTALL SUCCESS

Uninstall AvamarAIX ClientSoftware

3. Enter:

geninstall -u AVMRclnt

The following appears in the command shell:+----------------------------------------------------------------------------+

Pre-deinstall Verification...+----------------------------------------------------------------------------+

Verifying selections...avagent.d Info: Could not cd into vardir ("/usr/local/avamar/var").avagent.d Info: Could not cd into vardir ("/usr/local/avamar/var").avagent.d Info: Could not cd into vardir ("/usr/local/avamar/var").doneVerifying requisites...doneResults...

SUCCESSES---------

Filesets listed in this section passed pre-deinstallverification and will be removed.

Selected Filesets-----------------AVMRclnt 4.1.0.910 # Avamar AIX Client 4.1.0-910...



1 Selected to be deinstalled, of which:1 Passed pre-deinstall verification

----1 Total to be deinstalled

+----------------------------------------------------------------------------+Deinstalling Software...

+----------------------------------------------------------------------------+

installp: DEINSTALLING software for:AVMRclnt 4.1.0.910

Finished processing all filesets. (Total time: 1 secs).

+----------------------------------------------------------------------------+Summaries:

+----------------------------------------------------------------------------+


Name Level Part Event Result-----------------------------------------------------------------------------AVMRclnt 4.1.0.910 USR DEINSTALL SUCCESS


Installing Avamar DB2 Client on Microsoft Windows x64INSTALLATION AND CONFIGURATION

Installing Avamar DB2 Client on Microsoft Windows x64Task List In order to successfully install the Avamar DB2 Client on supported Microsoft

Windows x64 platforms, you must perform all the following installation tasks:

• Install the Avamar Windows Client (page 20)• Register the Avamar Windows Client (page 21)• Pre-Installation Checks (page 8)

Install the Avamar Windows Client1. Log into the computer hosting the DB2 server.


http://AVAMARSERVER









6. Click the appropriate operating system hyperlink for your client computer.


7. Double-click the AvamarClient-VERSION.Windows.exe install package.

Your browser will prompt you to either open the file “in-place” (on the server) or save it to your local computer. Either method will work. However, if you save the file to your local computer, you must open (double-click) that installation file to continue with this procedure.

8. Open the installation in place (on the server).

The InstallShield Wizard appears.

9. Follow the on-screen instructions.

10.Click Finish to complete the installation procedure.

The Avamar client icon (shown left) appears in the system tray.



Register the Avamar Windows ClientiBefore you can backup or restore any files on this DB2 server, you must register it with the Avamar system.

1. Right click the Avamar client system tray icon (shown left).

A menu appears.

2. Choose Activate.

The Activate Client Setup dialog box appears.

3. Enter the following:

4. Click OK.

The Activate Client Setup dialog box closes.

FIELD DESCRIPTION

Administrator Server Address

Administrator server network hostname as defined in DNS.

Client Domain Avamar domain where you want this client to reside.The default domain is “clients.” However, your Avamar system administrator may have defined other domains and sub-domains. Consult your Avamar system administrator for the specific domain you should use when registering this client.IMPORTANT: If entering a sub-domain (for example, clients/windows), do not include a slash (/) as the first character. Including a slash as the first character will cause an error and prevent you from registering this client.

Client User Access List (UAL)

Not used.



Install the Avamar Windows x64 DB2 Plugin1. Log into the computer hosting the DB2 server.


http://AVAMARSERVER









6. Click the appropriate operating system hyperlink for your client computer or workstation.


7. Click the AvamarDB2-VERSION.Windows64.exe install package.

Your browser will prompt you to either open the file “in-place” (on the server) or save it to your local computer or workstation. Either method will work. However, if you save the file to your local computer or workstation, you must open (double-click) that installation file to continue with this procedure.

8. Open the installation in place (on the server).

The InstallShield Wizard appears.

9. Follow the on-screen instructions.

10.Click Finish to complete the installation procedure.


Uninstalling and Upgrading the Avamar DB2 Client on Microsoft Windows x64INSTALLATION AND CONFIGURATION

Uninstalling and Upgrading the Avamar DB2 Client on Microsoft Windows x64

Unlike other platforms, previous versions of Avamar DB2 Client software do not have to be explicitly uninstalled before a new version can be installed. If you attempt to install the Avamar DB2 Client on a server that already has it installed, you will be prompted during installation to select one of the following choices:

1. Upgrade current Avamar DB2 Client installation to the new version.

2. Remove old Avamar DB2 Client installation.

If you choose to remove the old installation, you will need to re-run the installation file to install the new version (the current installation session becomes an “uninstall” session, then terminates).

You can also use the Windows Control Panel > Add/Remove Programs feature to completely uninstall the Avamar DB2 Client.


USING THE AVAMAR DB2 CLIENT ON IBM AIXThis chapter describes how to use the Avamar DB2 Client to back up or restore an entire database.

IMPORTANT: The information presented in this chapter isonly applicable to DB2 servers running on supported IBM AIXplatforms; it is specifically not applicable to DB2 servers run-ning on Microsoft Windows x64 platforms.

Refer to Using the Avamar DB2 Client on Microsoft Windowsx64 (page 41) for information applicable to DB2 servers run-ning on Microsoft Windows x64 platforms.

Database PreparationNormal Backups and Restores. In order to perform normal (not online) backups and restores of your DB2 database, ensure that the database is idle when the operation begins and that no clients attempt to connect to the database for the entire duration of the backup or restore operation.

Online Backups. In order to perform an online backup of a DB2 database, you must perform the following actions prior to your first online backup:

1. Issue the following command on your DB2 server:

db2 update db cfg using LOGRETAIN ON

2. Perform a normal backup of your DB2 database.

The database is now in a state that will support future online “hot” backups.

You must also set the Create an ONLINE backup option in the dataset level or as an on-demand backup option (page 28).

Each online backup actually generates two separate backups: a database backup and a filesystem backup containing the transaction logs as shown below:


Database PreparationUSING THE AVAMAR DB2 CLIENT ON IBM AIX

Both backups must be restored in order to fully restore a database from an online backup.

IMPORTANT: You should ensure that no changes to thedatabase are taking place during the backup window. Modi-fying a database in the middle of a backup can cause unpre-dictable application behavior including failed backups.

Restores From Online Backups. If you will be restoring a database from an online backup, you must perform the following tasks in the following order:

1. Restore the database from the database backup.

2. Restore the transaction logs from the transaction log filesystem backup.

3. Roll the database forward to the desired point in time.

This is an example of a command that rolls the database forward to the end of the transaction logs (it applies all the logs):

db2 rollforward db MYDATA to end of logs and complete

Where MYDATA is the database name.

If the rollforward operation is not executed, subsequent backup/restore operations involving the Avamar DB2 plug-in will fail with and display an error message advising that the database must be rolled forward.


On-Demand BackupUSING THE AVAMAR DB2 CLIENT ON IBM AIX

On-Demand Backup

IMPORTANT: Before attempting any database backup,ensure that you have read and understood how to preparethe database for this operation.

Refer to Database Preparation (page 24) for additional infor-mation.

1. Start Avamar Administrator.

2. Choose Navigation > Backup and Restore or click the Backup & Restore launcher button.

The Backup and Restore window appears.

3. Click the Select for Backup tab.

4. In the Clients tree, select the DB2 server.

REMINDER: You cannot view clients outside your domain.To view all clients, you must be logged into the root domain.

5. Select the DB2 plug-in.

IMPORTANT: Currently, you can only back up one DB2server database per backup operation.

6. Select the database you want to backup.



7. Choose Actions > Backup Now… or click the toolbar icon shown immediately to the left.

The On Demand Backup Options dialog box appears.

8. Review your backup settings.

Clicking Cancel returns you to the Backup and Restore window where you can modify your backup selections.

9. If you want to change your backup retention setting, enter or select the following:


Retention period If you want this backup to be deleted from the Avamar server after a specific number of days, weeks, months or years, set this option and enter the number of days, weeks, months or years.

End date If you want this backup to be deleted from the Avamar server on a specific calendar date, set this option and browse to that date on the calendar.

No end date If you want to keep this backup for as long as this client remains active in the Avamar server, set this option.



10.Select the encryption method you want to use for client/server data transfer during this backup.

Choices are:

11.Do one of the following:

12.Click OK.

The On Demand Backup Options dialog box closes and the following status message appears: Backup initiated.

13.Click OK.

Medium Medium strength encryption.

High Strongest available encryption setting for that specific client platform.

None No encryption.

NOTE: The exact encryption technology and bit strength used for any given client/server connection is dependent on a number of factors, including the client platform and Avamar server version. Refer to your Avamar Product Security Manual for additional information.

IF DO THIS

You want to perform an online “hot” backup of this database (page 24).

Click More Options...Set Create an ONLINE backup.

You want to perform a normal backup of this database (page 24).

Go directly to step 12.


RestoreUSING THE AVAMAR DB2 CLIENT ON IBM AIX

Restore1. Start Avamar Administrator.

2. Choose Navigation > Backup and Restore or click the Backup & Restore launcher button.

The Backup and Restore window appears.

3. Click the Select for Restore tab.



5. Click the By Date tab.

Clicking the By Date tab displays a browsable calendar for locating backups in the Avamar server.

Dates highlighted in yellow indicate that a backup was performed on that date.

Selecting a valid backup date on the calendar populates the backups list immediately to the right of the calendar.

Selecting a backup populates the contents list directly below the Backup History pane.

6. In the Backup History pane, browse to a valid backup date in the Calendar (highlighted in yellow).

7. Select a backup from the backups list directly to the right of the calendar.



8. Select the database you want to restore.

9. Choose Actions > Restore Now… or click the toolbar icon shown immediately to the left.

The Restore Options dialog box appears.

10.Review your restore settings.

Clicking Cancel returns you to the Backup and Restore window where you can modify your restore selections.

11.Set Restore Everything to its original location.

12. Leave all other restore options unset.

13.Click OK.

The Restore Options dialog box closes and the following status message appears: Restore initiated.

14.Click OK.




16.Roll the database forward to the desired point in time.

This is an example of a command that rolls the database forward to the end of the transaction logs (it applies all the logs):

db2 rollforward db MYDATA to end of logs and complete

Where MYDATA is the database name.

If the rollforward operation is not executed, subsequent backup/restore operations involving the Avamar DB2 plug-in will fail with and display an error message advising that the database must be rolled forward.

IF DO THIS

You are restoring from an online backup (page 25).

In addition to restoring the database as you have just done, you must also restore the transaction logs from the transaction log filesystem backup.Repeat steps 3 thru 15, selecting the transaction log filesystem backup in step 9.Roll the database forward to the desired point in time by performing step 17.

You are restoring from a normal backup.

You are finished.


Scheduling DB2 Server BackupsUSING THE AVAMAR DB2 CLIENT ON IBM AIX

Scheduling DB2 Server BackupsIn order to back up your DB2 server on a regular schedule, you must:

1. Create a New Dataset for DB2 Server Backups (page 32).

2. Set Up Scheduled DB2 Server Backups (page 35). This involves:

(a) Creating a new group expressly for DB2 backups.

(b) Adding the DB2 server to this new group.

(c) Assigning the new dataset to this new group.

(d) Assigning a schedule to this new group.

(e) Assigning a retention policy to this new group.

3. Enable Scheduled DB2 Server Backups (page 40).

A thorough discussion of groups, group policy, datasets, schedules and retention policies is beyond the scope of this publication. Refer to your Avamar System Administration Manual for additional information.

Create a New Dataset for DB2 Server Backups

REMINDER: You must be logged into the root domain as anadministrative user in order to perform this procedure.


2. Choose Tools > Manage Datasets…

The Manage All Datasets window appears.



3. Click New.

The New Dataset dialog box appears.

4. Enter a name for this new dataset.

IMPORTANT: Do not use any of the following characters inyour dataset name: asterisk (*), forward slash (/), backwardslash (\), colon (:), semicolon (;), question mark (?),greater-than sign (>), less-than sign (<) or vertical bar (|).

5. Click the Source Data tab.

6. Set Enter Explicitly.

7. Select the AIX DB2 plug-in from the Select Plug-In Type drop-down list.

8. Click ...

The Select Files And/Or Folders dialog box appears.



10.Select the DB2 plug-in.

IMPORTANT: Currently, you can only back up one DB2server database per backup operation.



11.Select the database you want to back up with this dataset.

12.Click OK.

The Select Files And/Or Folders dialog box closes.

The remaining dialog box tabs are used to set optional parameters such as exclude and include list entries and optional plug-in commands.

IMPORTANT: The DB2 plug-in does not support include orexclude lists in datasets.


14.Click OK.

The New Dataset dialog box closes.

IF DO THIS

You want to perform an online “hot” backup of this database (page 24).

Click the Options tabSet Create an ONLINE backup.

You want to perform a normal backup of this database (page 24).

Go directly to step 14.



Set Up Scheduled DB2 Server Backups



2. Choose Navigation > Policy or click the Policy launcher button.

The Policy window appears.

3. Choose Actions > New Group… or click the toolbar icon shown immediately to the left.

The New Group wizard appears.



4. Enter or set the following:

The remaining wizard screens are used to select a dataset, schedule and retention policy, as well as build a client list for this group.

You can click Finish at any time. Doing so will cause the new group to be created using system default settings and an empty client list. You can change those settings by editing the group properties.


Name Enter a name for this new group.IMPORTANT: Do not use any of the following characters in your group name: asterisk (*), forward slash (/), backward slash (\), colon (:), semicolon (;), question mark (?), greater-than sign (>), less-than sign (<) or vertical bar (|).

Disabled This option is set by default. Unset this option if you want to immediately use this group to take regularly scheduled client backups.

Encryption Method

This is the group encryption method that will be used by all members of this group for client/server network communications unless it is overridden at the client level. Choices are:

Medium Medium strength encryption.

High Strongest available encryption setting for that specific client platform.

None No encryption.

NOTE: The exact encryption technology and bit strength used for any given client-server connection is dependent on a number of factors, including the client platform and Avamar server version. Refer to your Avamar Product Security Manual for additional information.

Override Schedule

Set this option if you want to override the assigned schedule for this group.You can also skip the next scheduled backup entirely (Skip Next Backup) or perform the next scheduled backup one time only (Run Next Backup Once).

Domain Location in the Avamar server where this group should reside.



5. Click Next.

The next New Group wizard screen appears.

This screen is used to select a dataset for use with this group.

6. Select the dataset you defined during Create a New Dataset for DB2 Server Backups (page 32) from the Select an Existing Dataset drop-down list.

7. Click Next.


This screen is used to select a schedule for use with this group.



8. Select a schedule from the Select an Existing Schedule drop-down list.

NOTE: Schedules are not modifiable from this screen.Detailed schedule properties are shown so that you canreview them prior to making your selection. Refer to yourAvamar System Administration Manual for additional infor-mation about editing schedule properties.

9. Click Next.


This screen is used to select a retention policy for use with this group.

10.Select a retention policy from the Select an Existing Retention Policy drop-down list.

NOTE: Retention policies are not modifiable from thisscreen. Detailed retention policy properties are shown sothat you can review them prior to making your selection.Refer to your Avamar System Administration Manual foradditional information about editing retention policy proper-ties.



11.Click Next.

The final New Group wizard screen appears.

This screen is used to build a list of clients that will be members of this group. In this case, our group will contain only one client — the DB2.

12.Select the DB2 server from the client list and click >> to add it to this group’s client list.

TIP: If you need to remove a client from the list, select it,then click <<.

13.Click Finish.

The New Group wizard closes and the new group appears in the Policy window.



Enable Scheduled DB2 Server Backups



2. Choose Navigation > Policy or click the Policy launcher button.

The Policy window appears.

3. Click the Policy Management tab.

4. Click the Groups tab.

5. Select the group you created in the previous procedure (the group that now contains only your DB2 server).

6. Choose Actions > Group > Disable Group.

This unsets the Disable Group option on the Actions > Group menu.

A confirmation message appears.

7. Click Yes to enable this group.


USING THE AVAMAR DB2 CLIENT ON MICROSOFT WINDOWSX64

This chapter describes how to use the Avamar DB2 Client to back up or restore an entire database.

IMPORTANT: The information presented in this chapter isonly applicable to DB2 servers running on supported Micro-soft Windows x64 platforms; it is specifically not applicableto DB2 servers running on IBM AIX platforms.

Refer to Using the Avamar DB2 Client on IBM AIX (page 24)for information applicable to DB2 servers running on IBMAIX platforms.

Capabilities and LimitationsThis topic discusses the current capabilities and limitations of Avamar DB2 Client on Microsoft Windows x64:

Command-Line Only Implementation. The Avamar Windows x64 DB2 Plugin is a command-line only implementation. All backups and restores must be initiated from the command line. You cannot initiate on-demand backups and restores from within Avamar Administrator; nor can you schedule backups from within Avamar Administrator.

Only Full Backups Supported. Only full database backups and restores are supported; incremental backups and restores are not supported


RestoreUSING THE AVAMAR DB2 CLIENT ON MICROSOFT WINDOWS X64

Backup

IMPORTANT: Before attempting any database backup,ensure that you have read and understood how to preparethe database for this operation.

Refer to Database Preparation (page 24) for additional infor-mation.

1. Open a command shell and log into the computer hosting the DB2 server.

2. Enter the following on a single command line:

db2 => backup database MY-DB user DB2-DBA using PASSWORD load "D:\Program Files\avs\bin\backdb2.dll"

Where MY-DB is your actual DB2 database instance, DB2-DBA and PASSWORD are your actual DB2 administrative user name and password, respectively.

The following information appears in your command shell:

Backup successful. The timestamp for this backup image is : 20061129115110

Restore1. Open a command shell and log into the computer hosting the DB2 server.

2. Enter the following on a single command line:

db2 => restore database MY-DB user DB2-DBA using PASSWORD load "D:\Program Files\avs\bin\backdb2.dll" without rolling forward

Where MY-DB is your actual DB2 database instance, DB2-DBA and PASSWORD are your actual DB2 administrative user name and password, respectively.

The following information appears in your command shell:

SQL2539W Warning! Restoring to an existing database that is the same as the backup image database. The database files will be deleted.

Do you want to continue ? (y/n) y

3. Enter Y and press ENTER.


APPENDIX A — PLUG-IN OPTIONSPlugin options provide additional control of backups and restores. These options are context-sensitive to both the operation being performed and the specific plugin selected for that operation.

These options can be specified during on-demand backup and restore options, or persistently set within datasets for all future scheduled backups

Plugin options can be set two ways:

• By using the graphical controls (page 44)• By entering option names and values as free text (page 45)


Setting Plugin Options Using Graphical ControlsAPPENDIX A — PLUG-IN OPTIONS

Setting Plugin Options Using Graphical ControlsClicking the Options tab and selecting a plugin displays all current plugin options for that specific plugin. The Windows filesystem plugin is shown in this example.

These settings are represented by graphical controls (for example, options, radio buttons, drop-down lists, and so forth).

The advantage to setting plugin options using graphical controls is that you cannot enter an option name or value incorrectly — only valid states are shown.


Entering Option Names and Values as Free TextAPPENDIX A — PLUG-IN OPTIONS

Setting Show Advanced Options expands this list even further by displaying options that are normally only of interest to persons debugging an Avamar system. These advanced options are shown in red. A partial list of advanced Windows filesystem plugin options is shown as an example (below).

Entering Option Names and Values as Free TextYou can also set plugin options by entering option names and values as free text.

Clicking More expands the dialog box to include Enter Attribute and Attribute Value fields.

The Enter Attribute and Attribute Value fields are used to input plugin options and values as free text.

However, it must be understood that no error checking or validation is performed on these free text entries and that free text entries override settings made by way of the graphical controls.


Common Plugin OptionsAPPENDIX A — PLUG-IN OPTIONS

Common Plugin OptionsThis topic lists plugin options that are common to nearly all plugins. These options can be specified during on-demand backups and restores, or persistently set within datasets for all future scheduled backups.

Backup Options


Backup label User-defined label to assign to backup

LOG

GIN

G

List backup contents Specify how much information about backup contents should be included in the log files. One of the following:

No file listing

List file names

List files and dates

Informational message level

Specify how many informational messages should be included in the log files. One of the following:

No informationals All informational messages are suppressed. However, errors and warnings are included in the log files.

Some informationals Some informational messages are included in the log files.

Many informationals Additional status information is included in the log files.

All informationals Provides maximum information. In addition to errors and warnings, all informational messages are included in the log files.

Report advanced statistics

If set, advanced timing and deduplication statistics are written to log files.

Enable debugging messages

If set, maximum information is written to log files.IMPORTANT: If set, very large log files will be created during this backup.



FILE

SY

ST

EM

TR

AV

ER

SA

L

Do not traverse any mounts

If set, no mount points are traversed during this backup.

Traverse fixed-disk mounts

If set, only fixed-disk filesystem mount points are traversed during this backup.

Traverse fixed-disk and remote network mounts

If set, both fixed-disk and NFS network mount points are traversed during this backup.

Force traversal of specified file system type(s)

Accepts a comma-separated list of one or more filesystem types (for example, nfs, ext2, jfs, xfs) that should be traversed during this backup.

Force non-traversal of specified file system type(s)

Accepts a comma-separated list of one or more filesystem types (for example, nfs, ext2, jfs, xfs) that should not be traversed during this backup.

PR

E-S

CR

IPT

Run user-defined script at beginning of backup

Runs user-defined script at beginning of backup session.Script must be located in:

/usr/local/avamar/etc/scripts on AIX and Linux/opt/AVMRclnt/etc/scripts on HP-UX and Solaris C:\Program Files\avs\etc\scripts on Windows

On Windows clients, script must have a .bat, .js or .vbs extension. There are no limitations on other client platforms.

Abort backup if script fails

If set, stop backup if script returns a non-zero status code.

POS

T-S

CR

IPT

Run user-defined script at end of backup

Runs user-defined script at end of backup session.Script must be located in:



Exit process with script failure exitcode

If set, avtar exits with the exit code of the script instead of a standard avtar exit code.




Restore Options

CLI

EN

T C

AC

HE

CH

EC

K/R

EP

AIR

Check client-side caches and report inconsistencies

If set, a backup is not performed. Instead, forces a validation check of client-side cache with the Avamar server.

Check and repair client-side caches

If set, a backup is not performed. Instead, forces a validation check of client-side cache with the Avamar server, and repairs inconsistencies.

Maximum client file cache size (MBs)

Specifies maximum client file cache size in MBs. A negative value indicates a fraction of RAM (for example, -8 specifies that no more than 1/8th of physical RAM be allocated to the client file cache).

Maximum client hash cache size (MBs)

Specifies maximum client hash cache size in MBs. A negative value indicates a fraction of RAM (for example, -8 specifies that no more than 1/8th of physical RAM be allocated to the client hash cache).

AD

VA

NC

ED

OP

TIO

NS Client-side flag file Specifies path to a flag file on the client, which

contains additional option settings.

Network usage throttle (Mbps)

Specifies a setting that reduces network usage to specified rate, expressed as megabits/second (for example, 0 = unrestricted, 50% of a T1 = 0.772).

Directly connect to all server nodes

set, establish multiple connections to the server. This can improve backup performance under certain circumstances.


Overwrite existing files Controls behavior when file to be restored already exists. One of the following:

Never

Always

Generate New Name

If Modified

If Newer




LOG

GIN

G

List backup contents Specify how much information about backup contents should be included in the log files. One of the following:

No file listing

List file names

List files and dates

Informational message level

Specify how many informational messages should be included in the log files. One of the following:

No informationals All informational messages are suppressed. However, errors and warnings are included in the log files.

Some informationals Some informational messages are included in the log files.

Many informationals Additional status information is included in the log files.

All informationals Provides maximum information. In addition to errors and warnings, all informational messages are included in the log files.

Report advanced statistics

If set, advanced timing and deduplication statistics are written to log files.

Enable debugging messages

If set, maximum information is written to log files.

IMPORTANT: If set, very large log files will be created during this restore.

PR

E-S

CR

IPT

Run user-defined script at beginning of restore

Runs user-defined script at beginning of restore session.Script must be located in:



Abort restore if script fails

If set, stop restore if script returns a non-zero status code.




PO

ST

-SC

RIP

T

Run user-defined script at end of restore

Runs user-defined script at end of restore session.Script must be located in:



Exit process with script failure exitcode

If set, avtar exits with the exit code of the script instead of a standard avtar exit code.

CLI

EN

T C

AC

HE

CH

EC

K/R

EP

AIR

Check client-side caches and report inconsistencies

If set, a restore is not performed. Instead, forces a validation check of client-side cache with the Avamar server.

Check and repair client-side caches

If set, a restore is not performed. Instead, forces a validation check of client-side cache with the Avamar server, and repairs inconsistencies.

Maximum client file cache size (MBs)

Specifies maximum client file cache size in MBs. A negative value indicates a fraction of RAM (for example, -8 specifies that no more than 1/8th of physical RAM be allocated to the client file cache).

Maximum client hash cache size (MBs)

Specifies maximum client hash cache size in MBs. A negative value indicates a fraction of RAM (for example, -8 specifies that no more than 1/8th of physical RAM be allocated to the client hash cache).

AD

VA

NC

ED

OP

TIO

NS

Do not descend into subdirectories

If set, restore only the specified top-level directory; do not restore any subdirectories.

Recreate original path beneath target directory

If set, recreate the original path to files and directories beneath the specified target directory.For example, if restoring F:\Temp\MyFile.txt to C:\Temp and you set this option, the full path to the restored file will be C:\Temp\F\Temp\MyFile.txt.

Directly connect to all server nodes

set, establish multiple connections to the server. This can improve restore performance under certain circumstances.



AIX DB2 Plugin OptionsAPPENDIX A — PLUG-IN OPTIONS

AIX DB2 Plugin OptionsIn addition to the Common Plugin Options (page 8) discussed previously, the following additional plugin options are also available for use with the Avamar AIX DB2 database plugin.

IMPORTANT: The information presented in this topic isonly applicable to DB2 servers running on running on IBMAIX platforms; it is specifically not applicable to DB2 serversrunning on Microsoft Windows x64 platforms.

Backup Options

Restore OptionsThe only restore option available for use with the Avamar AIX DB2 database plugin is Enable debugging messages. Refer to Common Plugin Options (page 8) for additional information.


Create an ONLINE backup If set, database can be backed up while it is operational (also known as “hot backup”).


Windows DB2 Plugin OptionsAPPENDIX A — PLUG-IN OPTIONS

Windows DB2 Plugin OptionsThe Avamar Windows x64 DB2 Plugin is a command-line only implementation. All backups and restores must be initiated from the command line. You cannot initiate on-demand backups and restores from within Avamar Administrator; nor can you schedule backups from within Avamar Administrator.

IMPORTANT: The information presented in this topic isonly applicable to DB2 servers running on Microsoft Windowsx64 platforms; it is specifically not applicable to DB2 serversrunning on IBM AIX platforms.

Advanced Technical InformationThe DB2 command processor supports passing an option string to a third party vendor backup system during backup and restore.

Avamar has various mandatory and optional settings that control the operation of backups and restores. These settings can be specified in the option string or via the Automatic Flag File Feature (page 54).

Required and Advisable SettingsThese settings must be specified for each backup or restore operation:

The following example database backup command specifies all three settings:

db2 => backup database MY-DB user DB2-DBA using DB2-DBA-PASSWORD load "D:\Program Files\avs\bin\backdb2.dll" options "--path=/clients/MY-DB2-SERVER --id=AV-USER-NAME --ap=AV-PASSWORD"

--ap=AV-PASSWORD Specifies password (AV-PASSWORD) for the --id user account.

--id=AV-USER-NAME Specifies Avamar user name (AV-USER-NAME) that is authorized to perform a backup or restore using the location specified by --path.If this user account does not reside at the top (root) level of the Avamar server, you must also specify the Avamar server domain where this user account resides, using the following syntax:--id=AV-USER-NAME@DOMAIN

--path=PATH Specifies location (domain and client) on the Avamar for a particular backup.



Additionally, explicitly including the following setting is highly recommended in most windows DB2 hosts, and is required on windows cluster hosts:

The following example database backup command specifies all four settings:

db2 => backup database MY-DB user DB2-DBA using DB2-DBA-PASSWORD load "D:\Program Files\avs\bin\backdb2.dll" options "--path=/clients/My-DB2-SERVER --id=AV-USER-NAME --ap=AV-PASSWORD --vardir='d:\Program Files\avs\var'"

Optional SettingsThe following settings are entirely optional:

--vardir Specifies directory used for configuration and log files by various components the Avamar backup client. This directory is either manually specified or automatically determined when the Avamar filesystem backup software is installed the first time. The default location is Program Files\avs\var on the Windows system drive.

--logfile=FILE Specifies log FILE that avtar will write to. A filename ending with the extension .log, located within the vardir is highly recommended as this will be supported by automatic “garbage collection” of old log files to constrain storage consumption by log files. If the log file path includes embedded spaces, it must be enclosed in single quotes.

--label=LABEL Specifies a custom backup label.DB2 automatically assigns a timestamp to a backup and reports this timestamp when the backup completes. Avamar uses a label to catalog backups. By default the DB2 timestamp will be used as the label for Avamar backups. If this option is specified on a backup, the DB2 timestamp is not used as the label; instead this custom LABEL is used. On restores, the restore will automatically attempt to restore from the most recent backup. If a label is specified on a restore, the restore will attempt to use the backup associated with the specified label.

--flagfile=FILE Specifies one or more option settings contained within a text file. This can be used to record a series of commonly used options, for repetitive use. If the path for this file includes embedded spaces, it must be enclosed in single quotes.



Automatic Flag File FeatureIf a file named DB2Options.txt is located in the same directory as the DB2 backup DLL (backdb2.dll), it will automatically be used as a flag file, just as if it was explicitly specified with the --flagfile=FILE option.

This feature could be used to hold repetitive options such as the --path. Note however that this could potentially pose a security risk

If this file exists and the --flagfile=FILE option specifies a different file, the file explicitly specified with the --flagfile=FILE option will be used.


INDEX

Aabort backup plugin option 47abort restore plugin option 49about this manual 5Add/Remove Programs application 23adding Avamar domains 9adding new Avamar clients 9AIX Client. See Avamar AIX Clientap plugin option 52authentication systems

Avamar Authentication System 11external 11

automatic flag file feature 54Avamar Administrator

adding Avamar clients 9creating user accounts 11enabling scheduled backups 40performing on-demand backups 26, 27restoring DB2 databases 29setting up scheduled backups 35

Avamar AIX Clientdownloading install packages 12, 13installing 13registering 14uninstalling 19

Avamar Authentication System 11Avamar client name, specifying 10Avamar DB2 Client

See also Avamar DB2 Plug-Indescription 7system requirements 7using 24

Avamar DB2 Plug-InIBM AIX

configuring 17downloading 13installing 15uninstalling 18

Windows x64downloading 22installing 22limitation 41plugin options ??–54uninstalling 23upgrading 23

Avamar DB2 PluginIBM AIX

backup options 51restore options 51

Windows x64optional settings 53plugin options 52–??required settings 52–53

Avamar domainsadding 9default 15server 36viewing clients 26

Avamar server, verifying 8Avamar Windows Client

downloading install package 20installing 20registering 21

Avamar, password requirements 11avregister command 14avtar exit code 47

Bbacking up DB2 database

IBM AIXonline backup option 51overriding schedule 36preparation 24scheduled 32, 40setting encryption method 28


INDEX

setting retention 27segregating clients 9transaction logs 24Windows x64

capabilities 41command 42limitations 41optional settings 53required settings 52–53

backup schedules. See schedules

Ccaches check and repair plugin option 48, 50caches check and report plugin option 48, 50character limitations

dataset names 33groups names 36slash 15, 21

clientprivileges 11registration 9removing from groups 39

client lists, adding DB2 server 39client-side flag file plugin option 48configuring Avamar DB2 Plug-In 17connect to all server nodes plugin option 48, 50create online backup option 51creating user account 11

Ddatabase modifications 25datasets

creating 32exclude lists 34include lists 34name, character limitations 33normal backups 34

DB2 databasebackup limitation 26backup preparation 24modifying 25rolling forward 31transaction log backups 24transaction logs 31

DB2 serveradding to client list 39backing up 32dataset 32host name 10scheduled backups 35

DB2 software requirements 7, 8debugging messages option 51debugging plugin option 46, 49deduplication statistics plugin option 46, 49disk space requirements 7

DNS entriesAvamar Administrator server 14Avamar server 21Avamar system 8

do not descend subdirectories plugin option 50do not traverse file systems plugin option 47do not traverse mounts plugin option 47domains. See Avamar domainsdownloading install packages

Avamar AIX Client 12, 13Avamar DB2 Plug-In

IBM AIX 12, 13Windows x64 22

Avamar Windows Client 20

EEMC Powerlink 5encryption

groups 36high 28, 36medium 28, 36setting 28

exclude lists 34exit backup process plugin option 47, 50exit code 47, 50exit restore process plugin option 50

Ffile system backups 24flagfile plugin option 53, 54force file system traversal plugin option 47

Ggroups

adding 32–39disabling 36domains 36encryption method 36names 36overriding schedule 36

Hhost names

Administrator server 21Avamar server 8, 14DB2 server 10

hot backups. See online backups

Iid plugin option 52include lists 34installing

Avamar AIX Client software 13Avamar DB2 Plug-In


INDEX

IBM AIX 15Windows x64 22

Avamar Windows Client 20

Llabel plugin option 53licensing information 5limitations

backing up DB2 databases 26dataset names 33exclude lists 34group names 36include lists 34slash character 15, 21using Windows x64 DB2 Plug-In 41

list backup contents plugin option 46, 49logfile plugin option 53

Mmax client file cache size plugin option 48, 50max client hash cache size plugin option 48, 50memory requirements 7message level plugin option 46, 49Microsoft Windows

Add/Remove Programs application 23See alsoWindows x64

minimum requirements. See system requirements

Nnetwork interface requirements 7network usage throttle plugin option 48new Avamar clients, adding 9normal backups

DB2 database 24restoring 31

normal restores 24

Oon-demand backups

IBM AIX 26, 27plugin options 43Windows x64 41

on-demand restoresplugin options 43Windows x64 41

online backupsIBM AIX 24plugin option 51preparation 24restoring 31restoring DB2 database 25setting up 34

operating systems, supported 7

overwrite existing files plugin option 48

Ppassword requirements, Avamar 11path plugin option 52pinging Avamar server 8plug-in options

restorede-duplication statistics 49

plugin optionsbackup

abort backup 47caches check and repair 48caches check and report 48client-side flag file 48connect to all server nodes 48debugging 46de-deduplication statistics 46do not traversal of file systems 47do not traverse mounts 47exit process 47force file system traversal 47list backup contents 46max client file cache size 48max client hash cache size 48message level 46network usage throttle 48run user-defined script 47traverse fixed and remote mounts 47traverse fixed-disk mounts 47

description 43restore

abort restore 49caches check and repair 50caches check and report 50connect to all server nodes 50debugging 49exit process with exit code 50list backup contents 49max client file cache size 50max client hash cache size 50message level 49overwrite existing files 48recreate original path 50run user-defined script 49, 50top-level directory 50

pre-installation, requirements 8privileges

designating 11root 8

product information 5

RRAM. See memory requirementsrecovering DB2 databases. See restoring DB2


INDEX

databasesrecreate original path plugin option 50registering

Avamar AIX Client 14Avamar client 9Avamar Windows Client 21

requirements. See system requirementsrestoring DB2 databases

IBM AIXdebugging messages option 51normal backups 24, 31on-demand 29–30preparation 25transaction logs 31

Windows x64capabilities 41command 42limitations 41

restoring files. See restoring DB2 databasesretention policy, setting up 27, 38rolling forward DB2 database 31root privilege requirement 8run user-defined script plugin option 47, 49, 50

Sscheduled backups

enabling 36exclude lists 34IBM AIX 32include lists 34setting up 35

schedulesgroups 36overriding 36

segregating backups 9slash character, limitations 15, 21software downloads. See downloading install packagesspecifying

Avamar client name 10sub-domain name 21

sub-domain name, specifying 21supported DB2 database servers 8system requirement 7

Ttransaction logs

backups 24restores 31

traverse fixed/remote mounts plugin option 47traverse fixed-disk mounts plugin option 47

Uuninstalling

Add/Removing Programs application 23Avamar AIX Client 19Avamar DB2 Plug-In

IBM AIX 18Windows x64 23

user account, creating 11User Acess List (UAL) 21

Vvardir plugin option 53verifying Avamar server 8

WWindows x64

See also Avamar Windows Clientbacking up DB2 41DB2 plug-in limitation 41DB2 plugin options 52–54
