DB 2
DB 2
TABLE OF CONTENTS
OVERVIEW
INSTALLATION
CONFIGURATION
MANAGEMENT
Page 1 of 96
Features - DB2 iDataAgent
z Introduction
z Client Terminology
z Supported Data Types
z Tree Levels in the DB2 iDataAgent
z License Requirement
z Databases, Instances, Backup Sets, and Subclients
z Securing DB2 Application Data Using the File System iDataAgent
z Third-Party Command Line
z Disaster Recovery Considerations
INTRODUCTION
The DB2 iDataAgent is responsible for backing up and restoring DB2 databases.
The DB2 iDataAgent is just one of several iDataAgents that provide backup and restore support for different kinds of data in what is often a mixed network
environment. Remember that this product secures only the DB2 databases (e.g., system and user databases). To secure DB2 application files that reside on a
local hard drive or file system data that resides on an DB2 computer, you must use the File System iDataAgent. (For information on the DB2 entities
mentioned, see Databases, Instances, Backup Sets, and Subclients.)
The DB2 database comprises several objects. These objects can be backed up by the DB2 iDataAgent. For more information on the DB2 objects, refer to your
DB2 documentation.
Back to Top
CLIENT TERMINOLOGY
The following definitions are applicable to the DB2 iDataAgent.
z A client is a computer whose data is backed up via an iDataAgent. This may include DB2, File System, etc.
z DB2 clients are computers that contain the DB2 database(s) that you want to back up. Each DB2 client contains the DB2 iDataAgent to back up the various
objects in the DB2 database and the File System iDataAgent to back up the DB2 application files and operating system data.
z Within the DB2 iDataAgent, each instance can contain one or more backup sets, and each backup set can contain one or more subclients containing a single
entire database or portion thereof (i.e., selected table spaces).
z The iDataAgent creates a default subclient for each backup set within each instance. At the time of creation, the default subclient contains all the objects in
the database (backup set). You can modify the default subclient and create new subclients to suit the backup strategy you have devised.
Back to Top
Data Protection Operations for all other data types not mentioned in the previous list are not supported by the DB2 iDataAgent, including:
Both of these data types can be secured by the appropriate File System iDataAgent.
Back to Top
Page 2 of 96
Features - DB2 iDataAgent
bootes: Client
DB2: Agent
<user_defined_instance>: Instance
<user_defined_backupsets>: Backup Sets
In order to run the first backup, an instance must be added and a backup set must be added. Each backup set
creates a default subclient.
LICENSE REQUIREMENT
To perform a data protection operation using this Agent a specific Product License must be available in the CommServe® Server.
Review general license requirements included in License Administration. Also, View All Licenses provides step-by-step instructions on how to view the license
information.
Back to Top
A backup set is a logical grouping of subclients. Backup sets are created based on the available DB2 databases. Each backup set is designed to represent a
single database, and the backup set name is identical to the name of the database that the backup set represents. You cannot create multiple backup sets for
a single DB2 database.
Each backup set includes one or more subclients. Whenever you create a backup set, the software automatically creates a default subclient that represents the
entire DB2 database on the client computer. Thereafter, you can create one or more user-defined subclients for the backup set to suit your backup strategy.
Backups for DB2 are run from the subclient level.
Instances and backup sets have various configuration options, and these options affect the associated subclients. These and other configuration options are
accessed using the Properties dialog box associated with the appropriate level, and they are discussed in the online help.
Back to Top
Back to Top
Page 3 of 96
Features - DB2 iDataAgent
The DB2 iDataAgent supports the ability to perform backups and restores from the third-party command line. For more information, see Third-Party Command
Line Operations.
Back to Top
Back to Top
Page 4 of 96
Features - DB2 iDataAgent
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 x64, Sparc5 (or higher recommended)
WINDOWS Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
SERVER 2008 *Core Editions not supported
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 2 All Windows-compatible processors supported
Red Hat Enterprise Linux 6 with glibc 2.12.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 5 with glibc 2.6.x Intel Pentium or compatible processors
SuSE Linux 11.x with glibc 2.9.x and above Intel Pentium or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium or compatible processors
Page 5 of 96
Features - DB2 iDataAgent
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 x64, Sparc5 (or higher recommended)
Microsoft Windows Server 2008 x64 Editions All Windows-compatible processors supported
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Page 6 of 96
Features - DB2 iDataAgent
Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
*Core Editions not supported
WINDOWS 2003
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 2 All Windows-compatible processors supported
Red Hat Enterprise Linux 6 with glibc 2.12.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 5 with glibc 2.6.x Intel Pentium or compatible processors
SuSE Linux 11.x with glibc 2.9.x and above Intel Pentium or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium or compatible processors
Microsoft Windows Server 2008 32-bit Editions* Intel Pentium or compatible processors
*Core Editions not supported
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Page 7 of 96
Features - DB2 iDataAgent
Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
*Core Editions not supported
WINDOWS 2003
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 1 All Windows-compatible processors supported
Red Hat Enterprise Linux 6 with glibc 2.12.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 5 with glibc 2.6.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 4.x with glibc 2.3.x Intel Pentium or compatible processors
SuSE Linux 11.x with glibc 2.9.x and above Intel Pentium or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium or compatible processors
Microsoft Windows Server 2008 32-bit Editions* All Windows-compatible processors supported
*Core Editions not supported
WINDOWS 2003
Microsoft Windows Server 2003 32-bit Editions with a minimum of Service Pack All Windows-compatible processors supported
2
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Page 8 of 96
Features - DB2 iDataAgent
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
*Core Editions not supported
WINDOWS 2003
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 1 All Windows-compatible processors supported
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Red Hat Enterprise Linux 6 with glibc 2.12.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 5 with glibc 2.6.x Intel Pentium or compatible processors
Red Hat Enterprise Linux 4.x with glibc 2.3.x Intel Pentium or compatible processors
SuSE Linux 11.x with glibc 2.9.x and above Intel Pentium or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium or compatible processors
SOLARIS Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Microsoft Windows Server 2008 32-bit Editions* All Windows-compatible processors supported
*Core Editions not supported
WINDOWS 2003
Microsoft Windows Server 2003 32-bit Editions with a minimum of Service Pack All Windows-compatible processors supported
1
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Page 9 of 96
Features - DB2 iDataAgent
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 1 All Windows-compatible processors supported
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Red Hat Enterprise Linux 4.x with glibc 2.3.x Intel Pentium or compatible processors
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Microsoft Windows Server 2003 32-bit Editions with a minimum of Service Pack All Windows-compatible processors supported
1
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Red Hat Enterprise Linux 4.x with glibc 2.3.x Intel Pentium or compatible processors
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 Sparc5 or higher recommended
Microsoft Windows Server 2003 x64 Editions with a minimum of Service Pack 1 All Windows-compatible processors supported
AIX 5.3 with technology level 6 (or higher) and runtime library xlC.rte 8.0.0.0 Power PC (Includes IBM System p)
or higher
Red Hat Enterprise Linux 4.x with glibc 2.3.x Intel Pentium or compatible processors
Microsoft Windows Server 2003 32-bit Editions with a minimum of Service Pack All Windows-compatible processors supported
Page 10 of 96
Features - DB2 iDataAgent
CLUSTER - SUPPORT
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
HARD DRIVE
WINDOWS
888 MB on Calypso install path including Job Results and Log files
88 MB on Job Results
23.5 MB on Log File path (without debug)
LINUX
568 MB on Calypso install path including Log Files and excluding Job Results
1 MB on Calypso Job Results.
34 MB on Log Files (without debug)
AIX
2228.30 MB on Calypso install path including Job Results
1.97 MB on Job Results
906.10 MB on Log location with debug
MEMORY
WINDOWS
32 MB RAM minimum required beyond the requirements of the operating system and running applications
PERIPHERALS
DVD-ROM drive
MISCELLANEOUS
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install
information specific to the File System iDataAgents, refer to:
z System Requirements - Microsoft Windows File System iDataAgent
z System Requirements - AIX File System iDataAgent
z System Requirements - HP-UX File System iDataAgent
z System Requirements - Linux File System iDataAgent
z System Requirements - Solaris File System iDataAgent
On Solaris computers, the operating system must have been installed with at least the user level software option selected.
Page 11 of 96
Features - DB2 iDataAgent
NETWORK
TCP/IP Services configured on the computer.
SELINUX
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development
package must be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
where: policy_module(<name>,<version>)
<file_name> is the name of the Unix file, created to save the where:
policy module statement. It is a good idea to use the same
<name> is the name of the policy module. You can give any unique name to the policy module,
name for policy module and the file.
such as a process or application name.
For example: When you are creating a policy module for
<version> is the version of the policy module. It can be any number, such as 1.0.0.
backup_IDA application, you can use the following file name:
backup_IDA.te For Example: While creating a policy module for the backup_IDA application, you can use the
following content.
policy_module(backup_IDA,1.0.0)
<directory>/<file_name>.fc The content of the file should be as follows:
where: Note that the following list of files is not exhaustive. If the process fails to launch,
check /var/log/messages. Also, if required, add it to the following list of files.
<directory> is /usr/share/selinux/devel
/opt/<software installation directory>/Base/libCTreeWrapper.so -- gen_context
<file_name> is the name of the Unix file, created to save the (system_u:object_r:texrel_shlib_t,s0)
policy module statement. It is a good idea to use the same
/opt/<software installation directory>/Base/libCVMAGuiImplgso -- gen_context
name for policy module and the file.
(system_u:object_r:texrel_shlib_t,s0)
For example: When you are creating a policy module for
/opt/<software installation directory>/Base/libdb2locale.so.1 -- gen_context
backup_IDA application, you can use the following file name: (system_u:object_r:texrel_shlib_t,s0)
backup_IDA.fc
/opt/<software installation directory>/Base/libdb2osse.so.1 -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDb2Sbt.so -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2trcapi.so.1 -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDrDatabase.so -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libIndexing.so -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libSnooper.so -- gen_context
(system_u:object_r:texrel_shlib_t,s0)
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel
directory.
Page 12 of 96
Features - DB2 iDataAgent
On Linux, if you have installed libstdc++.so.6, make sure to install the compat-stdlibc++ rpm containing libstdc++.so.5 also.
DISCLAIMER
Minor revisions and/or service packs that are released by application and operating system vendors are supported by our software but may not be individually listed in our System
Requirements. We will provide information on any known caveat for the revisions and/or service packs. In some cases, these revisions and/or service packs affect the working of our software.
Changes to the behavior of our software resulting from an application or operating system revision/service pack may be beyond our control. The older releases of our software may not support
the platforms supported in the current release. However, we will make every effort to correct the behavior in the current or future releases when necessary. Please contact your Software
Provider for any problem with a specific application or operating system.
Additional considerations regarding minimum requirements and End of Life policies from application and operating system vendors are also applicable
Page 13 of 96
Features - DB2 iDataAgent
INSTALL REQUIREMENTS
The DB2 iDataAgent is installed on the computer from which the iDataAgent secures data. (This computer is referred to as the Client computer in this install
procedure.)
Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in System Requirements - DB2 iDataAgent and
in System Requirements - Microsoft Windows File System iDataAgent.
Before you review the following list, ensure that the DB2 development tool from the DB2 software is installed on the client.
The following procedure describes the steps involved in installing the Windows File System and DB2 iDataAgents. If you choose to install multiple components
simultaneously, refer to the appropriate procedures for installation requirements and steps specific to the component. Note that when you install multiple
components, the sequence of the install steps may vary.
GENERAL
z Review Install Considerations before installing the software.
z Agents should be installed only after the CommServe and at least one MediaAgent have been installed in the CommCell. Also, keep in mind that the
CommServe® software and MediaAgent must be installed and running (but not necessarily on the same computer), before you can install the Agent.
z Close all applications and disable any programs that run automatically, including anti-virus, screen savers and operating system utilities. Some of the
programs, including many anti-virus programs, may be running as a service. Stop and disable such services before you begin. You can re-enable them after
the installation.
z Ensure there is an available license on the CommServe software for the Agent.
z Verify that you have the Software Installation Disc that is appropriate to the destination computer’s operating system.
INSTALL PROCEDURE
GETTING STARTED
1. Place the Software Installation Disc for the Windows platform into the disc drive.
After a few seconds, the installation program is launched.
If the installation program does not launch automatically:
z Click the Start button on the Windows task bar, and then click Run.
z Browse to the installation disc drive, select Setup.exe, click Open, then click OK.
NOTES
z If you are installing on Windows Server Core editions, mount to Software Installation Disc through command line, go to the AMD64 folder and run
Setup.exe.
2. Choose the language you want to use during installation. Click the down arrow and
select the desired language from the drop-down list, and click Next to continue.
Page 14 of 96
Features - DB2 iDataAgent
4. Read the license agreement, then select I accept the terms in the license
agreement.
Click Next to continue.
z DB2 iDataAgent
When you select the DB2 iDataAgent for install, the appropriate Windows File System
iDataAgent is automatically selected for install.
Page 15 of 96
Features - DB2 iDataAgent
For firewall options and configuration instructions, see Firewall Configuration and
continue with the installation.
If firewall configuration is not required, click Next to continue.
7. Enter the fully qualified domain name of the CommServe Host Name. This should be
TCP/IP network name. e.g., computer.company.com.
NOTES
z The CommServe client name is the name of the computer. This field is
automatically populated.
z Do not use space and the following characters when specifying a new name for the
CommServe Host Name:
\|`~!@#$%^&*()+=<>/?,[]{}:;'"
z If a computer has already been installed, this screen will not be displayed; instead
the installer will use the same Server Name as previously specified.
z If you do not specify the CommServe Host Name, a window will be prompted to
continue in decouple mode. Click Yes to continue to Decoupled Install. Click No to
specify a CommServe Name and continue with the installation.
Click Next to continue.
8. Enter the username and password associated with an external domain user account
or a CommCell user account to authorize the installation of this agent.
NOTES
z This window will be displayed when the Require Authentication for Agent
Installation option is selected in the CommCell Properties. For more
information, see Authentication for Agent Installs.
Click Next to continue.
10. Select Add programs to the Windows Firewall Exclusion List, if you wish to add
CommCell programs and services to the Windows Firewall Exclusion List.
NOTES:
z If Windows Firewall is enabled on the computer, this option is selected by default
and must be enabled to proceed with the installation.
z If Windows Firewall is disabled on the computer, you can select this option to add
the programs and services to enabled CommCell operations across the firewall, if
the firewall is enabled at a later time.
Page 16 of 96
Features - DB2 iDataAgent
You can either select this option during install or add the programs and services
after installation. For adding the programs and services after installation, see
Configure Windows Firewall to Allow CommCell Communication.
Click Next to continue.
11. Specify the location where you want to install the software.
NOTES
z Do not install the software to a mapped network drive.
z Do not use the following characters when specifying the destination path:
/:*?"<>|#
It is recommended that you use alphanumeric characters only.
z If you intend to install other components on this computer, the selected installation
directory will be automatically used for that software as well.
z If a component is already installed in this computer, this screen may not be
displayed. The software will be automatically installed in the same location that
was previously specified.
Click Browse to change directories.
Click Next to continue.
Page 17 of 96
Features - DB2 iDataAgent
14. Select the storage policy through which you want to back up/archive the agent.
NOTES
z A storage policy directs backup data to a media library.
z If desired, you can change your storage policy selection at any time after you have
installed the client software.
z This screen may appear more than once, if you have selected multiple agents for
installation. You will be prompted to configure the storage policy association for
each of the selected agents.
Click Next to continue.
16. Specify the location for storing the DB2 Retrieve files and then click Next.
Retrieve Path is a staging location of logs during Restore. The size requirement is
determined by the number of logs that are needed to perform Roll forward operation.
17. Specify the location for storing information containing errors regarding the audit error
path and then click Next.
When Logs are archived/retrieved, the Audit Log files are created in the location
specified by you. A maximum size of 10MB will be ideal for this location.
Page 18 of 96
Features - DB2 iDataAgent
z The Summary on your screen should reflect the components you selected for
install, and may look different from the example shown.
Click Next to continue or Back to change any of the options.
The install program now starts copying the software to the computer. This step may
take several minutes to complete.
19. The System Reboot message may be displayed. If so, select one of the following:
z Reboot Now
If this option is displayed without the Skip Reboot option, the install program has
found files required by the software that are in use and need to be replaced. If
Reboot Now is displayed without the Skip Reboot option, reboot the computer at
this point. The install program will automatically continue after the reboot.
z Exit Setup
If you want to exit the install program, click Exit Setup.
SETUP COMPLETE
20. Click Next to continue.
NOTES
z Schedules help ensure that the data protection operations for the Agent are
automatically performed on a regular basis without user intervention. For more
information, see Scheduling.
POST-INSTALL CONSIDERATIONS
GENERAL
z Review Install Considerations after installing the software.
z Install post-release updates or Service Packs that may have been released after the release of the software. When you are installing a Service Pack,
Page 19 of 96
Features - DB2 iDataAgent
ensure that it is the same version as the one installed in the CommServe Server. Alternatively, you can enable Automatic Updates for quick and easy
installation of updates in the CommCell component.
Page 20 of 96
Features - DB2 iDataAgent
WHERE TO INSTALL
Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in the following:
It is recommended to install the software on the global zone to protect non-changing or static data on non-global zones. If the data is dynamic or contains
application data, install the software on the non-global zone.
INSTALL REQUIREMENTS
The following procedure describes the steps involved in installing DB2 and Unix File System iDataAgents. (This computer is referred to as the Client computer in
this install procedure.)
The DB2 iDataAgent is installed on the computer from which the iDataAgent secures data. Before you review the following list, ensure that the DB2
development tool from the DB2 software is installed on the client.
GENERAL
z Review Install Considerations before installing the software.
z Agents should be installed only after the CommServe and at least one MediaAgent have been installed in the CommCell. Also, keep in mind that the
CommServe and MediaAgent must be installed and running (but not necessarily on the same computer), before you can install the Agent.
z Ensure there is an available license on the CommServe for the Agent.
z Verify that you have the Software Installation Disc that is appropriate to the destination computer’s operating system.
INSTALL PROCEDURE
Page 21 of 96
Features - DB2 iDataAgent
GETTING STARTED
1. If you are installing the software on a Unix Server, do the following: Place the software installation disc for the Unix platform into the disc drive.
You can also install the product using a disc drive mounted on another computer on the network.
z On Solaris, double-click the cvpkgadd program from the File Manager window.
z On other Unix platforms, open the Terminal window, navigate to the software installation disc and then enter ./cvpkgadd.
4. Enter the number corresponding to the setup task you want to perform. Please select a setup task you want to perform from the
list below:
NOTES
Advance options provide extra setup features such as
z For Install data protection agents on this computer option, follow the steps creating custom package, recording/replaying user
described in this procedure. selections and installing External Data Connector
software.
z Advance options provide additional setup features such as record and play setup,
creating a custom package and External Data Connector Agent software. 1) Install data protection agents on this computer
2) Advance options
To create a custom package and for record and play setup, follow the steps
described in Custom Package - Unix. 3) Exit this menu
To install the External Data Connector Agent, follow the steps described in External Your choice: [1]
Data Connector - Unix.
5. If your computer is 32-bit, press Enter. This machine supports both 32 bit and 64 bit binaries. By
default, we will install 32 bit binary set that has full
If your computer is 64-bit, see Install Unix Agents on 64-bit Platform for step-by-step support for all the modules included in this package.
procedure. Please note that 64 bit binary set currently only support
limited modules.
1) All platforms (32 bit)
2) FS and MA only (64 bit)
Your choice: [1]
6. This prompt is displayed only when you are installing on AIX, HP-UX, Linux, or Solaris Certain Calypso packages can be associated with a virtual
computers. IP, or in other words, installed on a "virtual machine"
belonging to some cluster. At any given time the virtual
Press Enter to continue machine's services and IP address are active on only one
of the cluster's servers. The virtual machine can "fail-
NOTES over" from one server to another, which includes stopping
services and deactivating IP address on the first server
z When you install on non-clustered computer, you must select the number and activating the IP address/services on the other
associated with the option Install on a physical machine. server.
You now have a choice of performing a regular Calypso
install on the physical host or installing Calypso on a
virtual machine for operation within a cluster.
Most users should select "Install on a physical machine"
here.
1) Install on a physical machine
2) Install on a virtual machine
3) Exit
Your choice: [1]
7. If you have only one network interface, press Enter to accept the default network We found one network interface available on your machine.
We will associate it with the physical machine being
interface name and continue.
installed, and it will also be used by the CommServe to
If you have multiple network interfaces, enter the number corresponding to the connect to the physical machine. Note that you will be
able to additionally customize Datapipe Interface Pairs
network interface that you wish to use as default, and then press Enter to continue. used for the backup data traffic later in the Calypso Java
NOTES GUI.
z The interface name and IP addresses depend on the computer in which the Please check the interface name below, and make
connections if necessary:
software is installed and may be different from the example shown.
Physical Machine Host Name: [angel.company.com]
8. Specify the client name for the computer. Please specify the client name for this machine.
Page 22 of 96
Features - DB2 iDataAgent
Press Enter to accept the default name and continue, or It does not have to be the network host name: you can
Enter a new client name for the computer and then press Enter to continue. enter any word here without spaces. The only requirement
is that it must be unique on the CommServe.
Physical Machine Client name: [angel]
A confirmation screen will mark your choice with an "X". Type "d" for Done, and Select the Calypso module that you would like to install
press Enter to continue. [ ] 1) Media Agent [1301] [CVGxMA]
[ ] 2) FileSystem IDA [1101] [CVGxIDA]
NOTES >) >>>>> NEXT PAGE >>>>>>
z To select multiple component, enter the number by adding a space. [a=all n=none r=reverse q=quit d=done >=next <=previous ?
z Your screen may look different from the example shown. =help]
z Components that either have already been installed, or which cannot be installed, Enter number(s)/one of "a,n,r,q,d,>,<,?" here: 2
will not be shown.
z In addition, the list of modules that appear depends on the specific Unix File
System in which the package is installed. (e.g., CVGxWA will appear only when
the installation package is run on a Solaris computer.)
11. Type the appropriate number to install the latest software scripts and press Enter to Installation Scripts Pack provides extra functions and
continue. latest support and fix performed during setup time. Please
specify how you want to get this pack.
NOTES
If you choose to download it from the website now, please
z Select Download from the software provider website to download the latest make sure you have internet connectivity at this time.
software scripts from your software provider website. This process may take some time depending on the internet
connectivity.
Make sure you have internet connectivity when you are using this option. 1) Download from the software provider website.
z Select Use the one in the installation media, to install the software scripts from 2) Use the one in the installation media
the disc or share from which the installation is performed.
3) Use the copy I already have by entering its unix path
z Select Use the copy I already have by entering its unix path, to specify the
path if you have the software script in an alternate location. Your choice: [1] 2
12. Enter Yes to download and install the latest service packs and post packs from the Keep Your Install Up to Date - Latest Service Pack
software provider. Latest Service Pack provides extra functions and latest
support and fix for the packages you are going to install.
NOTES You can download the latest service pack from software
provider website.
z Internet connectivity is required to download updates.
If you decide to download it from the website now, please
z This step is applicable for multi instancing. make sure you have internet connectivity at this time.
This process may take some time depending on the internet
Press Enter to continue.
connectivity.
Do you want to download the latest service pack now? [no]
Press <ENTER> to continue ...
13. Specify the location where you want to install the software. Please specify where you want us to install Calypso
binaries.
NOTES
It must be a local directory and there should be at least
z The amount of free space required depends on the components selected for install, 98MB of free space available. All files will be installed
in a "calypso" subdirectory, so if you enter "/opt", the
and may look different from the example shown. files will actually be placed into "/opt/calypso".
Press Enter to accept the default path and continue, or Installation Directory: [/opt]
Enter a path and then press Enter to continue.
..
Press Enter again to confirm the path.
Calypso will be installed in /opt/calypso.
Press ENTER to continue ...
14. Specify the location for the log files. Please specify where you want to keep Calypso log files.
Page 23 of 96
Features - DB2 iDataAgent
15. Indicate whether you would like to launch processes with inherent database access Most of Calypso processes run with root privileges, but
rights. some are launched by databases and inherit database access
rights. To make sure that registry and log files can be
Press Enter to assign a new group, or written to by both kinds of processes we can either make
such files world-writeable or we can grant write access
Type No and then press Enter to continue. only to processes belonging to a particular group, e.g. a
"calypso" or a "dba" group.
We highly recommend now that you create a new user group
and enter its name in the next setup screen. If you choose
not to assign a dedicated group to Calypso processes, all
temporary and configuration files will be created with -
rw-rw-rw permissions.
If you're planning to backup Oracle DB you should use
"dba" group.
Would you like to assign a specific group to Calypso?
[yes]
16. If you indicated Yes in the previous step, you will be prompted for the group name Please enter the name of the group which will be assigned
that must be used to launch processes. to all Calypso files and on behalf of which all Calypso
processes will run.
Enter the group name and then press Enter to continue.
In most of the cases it's a good idea to create a
Press Enter again to continue. dedicated "calypso" group. However, if you're planning to
use Oracle iDataAgent or SAP Agent, you should enter
Oracle's "dba" group here.
Group name: dba
REMINDER
If you are planning to install Calypso Informix, DB2,
PostgreSQL, Sybase or Lotus Notes iDataAgent, please make
sure to include Informix, DB2, etc. users into group
"dba".
Press <ENTER> to continue ...
17. Type a network TCP port number for the Communications Service (CVD) and press Every instance of Calypso should use a unique set of
Enter. network ports to avoid interfering with other instances
running on the same machine.
Type a network TCP port number for the Client Event Manager Service (EvMgrC) and The port numbers selected must be from the reserved port
number range and have not been registered by another
press Enter. application on this machine.
NOTES
Please enter the port numbers.
z For more information about Network TCP Ports, see Network TCP Port
Port Number for CVD : [8600]
Requirements.
z For more information about these services, see Services. Port Number for EvMgrC: [8602]
z If the port number you entered already exists, a message will be displayed Port
#### is already reserved in /etc/services. To work around this issue, enter
different port number.
18. If this computer and the CommServe is separated by a firewall, type Yes and then Is there a firewall between this client and the CommServe?
press Enter to continue. [no]
For firewall options and configuration instructions, see Firewall Configuration and
continue with the installation.
If you do not wish to configure the firewall services, type No and then press Enter to
continue.
19. Type the name of the CommServe computer and press Enter to continue. Please specify hostname of the CommServe below. Make sure
the hostname is fully qualified, resolvable by the name
NOTES services configured on this machine.
z Ensure that the CommServe is accessible before typing the name; otherwise the CommServe Host Name:
installation will fail.
z If you enter a short name which resolves to the same IP address as the fully
qualified CommServe name, you will be asked if you would prefer to use the fully
qualified name.
20. Enter the username and password information for an external domain user account Enter your CommCell user name and password:
or a CommCell user account. This authorizes the installation of an agent on the
User Name :
CommCell.
Password :
NOTES
Press <ENTER> to continue ...
z This is only displayed when the Authentication for Agent feature is enabled in
the CommCell Properties. Users must belong to a User Group with Agent
Management capabilities to enable this feature. For more information, see
Authentication for Agent Installs.
Click Enter to continue.
KERNEL PARAMETERS
21. Enter the appropriate number of streams, and then press Enter to continue, or Please enter the total number of streams that you plan to
Press Enter to accept the default number of streams and continue. run at the same time. We need to make sure that you have
enough semaphores and shared memory segments configured
NOTES in /etc/system.
Page 24 of 96
Features - DB2 iDataAgent
z The number of streams specified ensures that concurrent backup/restore streams Number of streams: [10]
would have sufficient system resources. For more information on the subject, see
Configuring Kernel Parameters for Macintosh and Configuring Kernel Parameters
for Solaris.
This prompt is relevant only when you install/upgrade on a Macintosh or Solaris
computer as appropriate.
22. Indicate whether you would like modifications to be made to the /etc/system We now need to modify the /etc/system configuration file
on this computer. It is done to make sure that there will
configuration file.
be enough shared memory and semaphores available for
Type Yes, and then press Enter to automatically update the file and continue, or Calypso programs.
Press Enter to accept the default No and continue (if you do not want to Please review the changes below and answer "yes" if you
automatically update the file). want us to apply them to the /etc/system file. Otherwise,
the installation will proceed, the changes will be saved
This prompt is displayed only when you install/upgrade on a Solaris (8 or 9) or to some other file, and you will have to apply them
Macintosh computer. manually.
set shmsys:shminfo_shmmni=8570 (was 7930)
set shmsys:shminfo_shmseg=8420 (was 7780)
set semsys:seminfo_semmns=10320 (was 9680)
set semsys:seminfo_semmni=8570 (was 7930)
set semsys:seminfo_semmsl=8570(was 7930)
Do you want us to apply these changes now? [no]
Changes saved into /etc/system.gal.1744
Press <ENTER> to continue.
23. If you indicated No in the previous step, the file to which the changes have been Although a ’no’ answer can be selected to this question
saved is displayed. during install, the user should make sure the min
requirements (below) for shared memory are met, otherwise
Make sure that these values are established later to ensure that all the requirements the backups may fail (the message in logs is ’could not
for this setup is satisfied. start the pipeline’).
NOTES set shmsys:shminfo_shmmax=4199304
set shmsys:shminfo_shmmin=1
z The settings that are displayed are the maximum or minimum required settings. set semsys:shminfo_shmmni=640
Value ’640’, which is provided for various shared memory segment or semaphore set semsys:shminfo_shmseg=640
requirements, is a maximum value based on 10 streams. set semsys:seminfo_semmns=640
set semsys:seminfo_semmni=640
Press Enter to continue. set semsys:seminfo_semmsl=640
set maxusers=256
This prompt is displayed only when you install/upgrade on a Solaris (8 or 9)
computer, in cases where the install detects that the computer does not have the
maximum or minimum required shared memory settings.
z This screen will be displayed only if Client Groups are configured for the CommCell. [ ] 1) Unix
For more information, see Client Computer Groups. [ ] 2) DR
[ ] 3) DKS
[a=all n=none r=reverse q=quit d=done >=next <=previous ?
=help]
Enter number(s)/one of "a,n,r,q,d,>,<,?" here: 2
NOTES IMPORTANT:
z Schedules help ensure that the data protection operations for the Agent are In addition to installing Calypso on this computer, you
will also need to create a Job Schedule for each
automatically performed on a regular basis without user intervention. For more iDataAgent that has been installed on this client
information, see Scheduling.
Page 25 of 96
Features - DB2 iDataAgent
computer.
Job Schedules are required to allow the Calypso
iDataAgents to perform automated backup and restore
operations.
Job Schedule creation can be accomplished through the
Calypso CommCell Console administration interface.
+---------------------+
NOTES 1) SP_StandAloneLibrary2_2
2) SP_Library3_3
z A storage policy directs backup data to a media library. Each library has a default 3) SP_MagLibrary4_4
4) fornax_fornax_HWCmp
storage policy. 5) ranger_ranger_HWCmp
z When you install an Agent, the install program creates a default subclient for most 6) fornax_fornax_ClntCmp
Agents. 7) fornax_fornax_MACmp
8) fornax_fornax_NoCmp
z If desired, you can change your storage policy selection at any time after you have
installed the client software. Storage Policy: [3]
z If this screen appears more than once, it is because you have selected multiple
agents for installation and are configuring storage policy association for each of the
installed agents.
29. Type the path for storing information containing errors regarding the audit error path Please enter path to the DB2 Audit Error Directory.
and then press Enter. DB2 Logs Directory: /BU_area/db2/log1
When Logs are archived/retrieved, the Audit Log files are created in the location
specified by you. A maximum size of 10MB will be ideal for this location.
NOTE
z If the path that you enter does not exist, you will be asked if you want to create
this path. In such a case, accept the yes default and then press Enter.
30. Type the path for storing the DB2 Retrieve files and then press Enter. Please enter path to the DB2 Retrieve Directory.
DB2 Retrieve Directory: /BU_area/db2/ret
Retrieve Path is a staging location of logs during Restore. The size requirement is
determined by the number of logs that are needed to perform Roll forward operation.
NOTE
z If the path that you enter does not exist, you will be asked if you want to create
this path. In such a case, accept the yes default and then press Enter.
31. If you want to integrate the software with DB2 now, accept yes and press Enter. If In order to complete integration of Calypso with DB2, we
you want to do this later, type No and press Enter. need to create links to some Calypso binaries in each of
the DB2 instance directories. We can either do it now, or
if you prefer, you can
run /space/opt/calypso /iDataAgent/Db2_install.sh script
later yourself.
32. Specify the DB2 Instance User name that was selected when the DB2 instance was To integrate Calypso with a DB2 server we need to create a
set of links under lib subdirectory of the DB2
installed. This is the first bit of information required to integrate the product with the
installation directory.
appropriate DB2 server.
Please specify the DB2 Instance User Name that was
Type this name or accept the default and then press Enter. selected when DB2 Instance was installed.
DB2 Instance User Name: [db2inst1]
33. You are notified in which DB2 directory the product links will be created. Calypso links will be created
in /BU_area/db2as/sqllib/lib.
Press Enter.
Press <ENTER> to continue ...
34. Decide if you want to configure another DB2 instance. Would you like to configure another DB2 instance?
If so, type yes, press Enter, and skip back two steps. Otherwise, accept no, press Configure? [no]
Enter and go to the next step.
Page 26 of 96
Features - DB2 iDataAgent
35. The install program now starts copying the software to the computer. The progress of .....
the operation is displayed. .....
.....
.....
Successfully copied xx files
36. If you have multiple instances of the database, ensure that the items listed are IMPORTANT
satisfied. Press Enter.
If you are planning to use Calypso <package> with several
instances of the database, each running on behalf of
different UNIX users, you must make sure that:
37. A series of processing messages appears. The next-to-last message should indicate Updating registry tree under /etc/CommVaultRegistry ...
that DB2 has been installed. done.
Preconfiguring DB2 DataAgent on the CommServe ... done.
As prompted at the end, press Enter. Creating Calypso links
under /BU_area/db2as/sqllib/lib ...done.
Successfully installed CVGxDB2.
Press ENTER to continue ...
SETUP COMPLETE
38. This prompt is displayed only when you are installing on HP-UX, Linux, or Solaris Certain Calypso packages can be associated with a virtual
computers. Enter the number corresponding to the Exit option and then press Enter IP, or in other words, installed on a "virtual machine"
belonging to some cluster. At any given time the virtual
to continue. machine's services and IP address are active on only one
of the cluster's servers. The virtual machine can "fail-
The installation is now complete. over" from one server to another, which includes stopping
services and deactivating IP address on the first server
and activating the IP address/services on the other
server.
Currently you have Calypso installed on physical node
stone.company.com.
Now you have a choice of either adding another package to
the existing installation or configure Calypso on a
virtual machine for use in a cluster.
1) Add another package to stone.company.com
2) Install Calypso on a virtual machine
3) Exit
Your choice: [1]
POST-INSTALL CONSIDERATIONS
GENERAL
z Review Install Considerations after installing the software.
z Install post-release updates or Service Packs that may have been released after the release of the software. When you are installing a Service Pack,
ensure that it is the same version as the one installed in the CommServe Server. Alternatively, you can enable Automatic Updates for quick and easy
installation of updates in the CommCell component.
Back to Top
Page 27 of 96
Features - DB2 iDataAgent
INSTALL REQUIREMENTS
The software in a Unix cluster can be installed from the active node in the cluster group using the following procedure. Note that for a passive node in a Unix
cluster, you need to install the software separately on the passive node in the cluster group.
For an overview of deploying the software components in a clustered environment, see Clustering Support.
The following procedure provides step-by-step instructions for installing the DB2 iDataAgent on a Unix cluster. If you choose to install multiple components
simultaneously, the sequence of the install steps may vary.
Review the following Install Requirements before installing software on a Unix cluster:
GENERAL
z Review Install Considerations before installing the software.
z Agents should be installed only after the CommServe and at least one MediaAgent have been installed in the CommCell. Also, keep in mind that the
CommServe and MediaAgent must be installed and running (but not necessarily on the same computer), before you can install the Agent.
z Ensure there is an available license on the CommServe for the Agent.
z Verify that you have the Software Installation Disc that is appropriate to the destination computer’s operating system.
CLUSTER
z Refer to Installing the Software on the Cluster for important overview information about installing MediaAgent or Agent software in a Unix clustered
environment.
z Check the following on the cluster computer in which you wish to install the software:
{ Cluster software is installed and running.
{ Active and passive nodes are available.
z It is required that the DB2 application is installed on both active and passive nodes.
z Ensure that the DB2 database is created on the virtual machine.
z Make sure that DB2 Archive Directory, DB2 Audit Error Directory, and DB2 Retrieve Directory reside on a shared drive which can be accessed by all the
nodes.
If these directory paths are currently residing on a Virtual machine, then while installing the DB2 iDataAgent on a passive node, make sure that the passive
node is made active by failover so that these paths on the Virtual Machine can be accessed during the installation on the passive node.
HP-UX
z If you are installing on a HP-UX computer, you must manually mount the installation disc as described in Mount the Software Installation Disc.
Page 28 of 96
Features - DB2 iDataAgent
INSTALL PROCEDURE
Use the following steps to install the DB2 iDataAgent on both the active node and passive node.
GETTING STARTED
1. Place the software installation disc for the Unix platform into the disc drive.
You can also install the product using a disc drive mounted on another computer on the network.
z On Solaris, double-click the cvpkgadd program from the File Manager window.
z On other Unix platforms, open the Terminal window, navigate to the software installation disc and then enter ./cvpkgadd.
4. Enter the number corresponding to the setup task you want to perform. Please select a setup task you want to perform from the
list below:
NOTES
Advance options provide extra setup features such as
z For Installing data protection agents on this computer option, follow the steps creating custom package, recording/replaying user
described in this procedure. selections and installing External Data Connector
software.
z Advance options provide additional setup features such as record and play setup,
creating a custom package and External Data Connector Agent software. 1) Install data protection agents on this computer
2) Advance options
To create a custom package and for record and play setup, follow the steps
described in Custom Package - Unix. 3) Exit this menu
To install the External Data Connector Agent, follow the steps described in External Your choice: [1]
Data Connector - Unix.
5. If your computer is 32-bit, press Enter. This machine supports both 32 bit and 64 bit binaries. By
default, we will install 32 bit binary set that has full
If your computer is 64-bit, see Install Unix Agents on 64-bit Platform for step-by-step support for all the modules included in this package.
procedure. Please note that 64 bit binary set currently only support
limited modules.
1) All platforms (32 bit)
2) FS and MA only (64 bit)
Your choice: [1]
CLUSTER SELECTION
6. Type 2 and press Enter to install on a virtual machine. Certain Calypso packages can be associated with a virtual
IP, or in other words, installed on a "virtual machine"
belonging to some cluster. At any given time the virtual
machine's services and IP address are active on only one
of the cluster's servers. The virtual machine can "fail-
over" from one server to another, which includes stopping
services and deactivating IP address on the first server
and activating the IP address/services on the other
server.
You now have a choice of performing a regular Calypso
install on the physical host or installing Calypso on a
virtual machine for operation within a cluster.
Most users should select "Install on a physical machine"
here.
1) Install on a physical machine
2) Install on a virtual machine
3) Exit
Your choice: [1]
7. Type the name of the virtual machine that you want to configure or its corresponding Please enter the hostname or IP address of the virtual
IP address and press Enter. machine being installed. It can be either short or long;
the only requirement is that it must be resolvable by the
name services configured on this machine
WARNING: You should follow this path ONLY if this host
participates in a cluster and you really want to install
Calypso on the virtual machine. This is NOT how most
people will use Calypso.
If you got into this screen by mistake, hit ^C and restart
cvpkgadd.
Virtual Machine Host Name:
8. This prompt appears if you entered the short form of the virtual machine host name It looks like name "example.company.com" resolves to the
in the previous step. If you want to use the long form of the host name, accept the same IP as "example". Generally, it's better to use longer
name to address a host: less chances for name-to-IP
yes default; if not, type no. Then press Enter. resolution problems on CommServe or other IDA/MA.
Page 29 of 96
Features - DB2 iDataAgent
9. If you have already installed the software on the virtual machine for the active node, When installing new Calypso packages on a virtual machine,
accept the yes default to install for the passive node, press Enter, and go to the next you should start with the active node, that is the host
where the virtual machine is currently running.
step.
This node appears to be passive, so we will assume that
Type no and press Enter to perform the install for the virtual machine of the active you have already installed Calypso for example.company.com
node. on the active node.
NOTES
Is this correct? [yes]
z This prompt appears only when installing on a passive node.
10. Type the name of the virtual client and press Enter. Please specify the client name for this machine.It does
not have to be the network host name: you can enter any
word here without spaces. The only requirement is that it
must be unique on the CommServe.
Virtual Machine Client Name: [hpuxmc1]
11. Specify the network interface that you want to associate with the physical machine Even though it is a virtual machine that you are
installing now, we still have to ask you to provide
and press Enter.
hostname and client name for the physical node.
NOTES Network interfaces with the following IPs are available on
your system. Please select the one that you want to be
z This prompt appears only when the Unix File System iDataAgent is not installed on associated with Calypso physical machine. The interface
the physical node. should be static, and should not get disabled in case of
cluster failover.
1) mackrel71
2) mackrel
3) mackrel1
Interface number: [1] 2
12. Verify the name of the physical interface and make any required changes. Then press Please verify the physical interface name below. Make it
as complete (with fully qualified domain name) as
Enter.
possible.
Physical Hostname: [mackrel]
13. Enter a node name for the physical machine and press Enter. Even though you are installing Calypso on a machine, we
still need to ask you to provide a node name for the
physical machine.
It does not have to be the network host name: you can
enter any word here without spaces. The only requirement
is that it must be unique on the CommServe.
Physical Machine Node Name: [mackrel]
A confirmation screen will mark your choice with an "X". Type "d" for Done, and Select the Calypso module that you would like to install
press Enter to continue. [ ] 1) Media Agent [1301] [CVGxMA]
[ ] 2) FileSystem IDA [1101] [CVGxIDA]
NOTES
[X] 3) DB2 iDataAgent [1207] [CVGxDB2]
z To select multiple components, enter the number by adding a space. >) >>>>> NEXT PAGE >>>>>>
z Your screen may look different from the example shown.
z Components that either have already been installed, or which cannot be installed,
will not be shown. [a=all n=none r=reverse q=quit d=done >=next <=previous ?
=help]
z In addition, the list of modules that appear depends on the specific Unix File
Enter number(s)/one of "a,n,r,q,d,>,<,?" here: 2
System in which the package is installed. (e.g., CVGxWA will appear only when
the installation package is run on a Solaris computer.)
16. Type the appropriate number to install the latest software scripts and press Enter to Installation Scripts Pack provides extra functions and
continue. latest support and fix performed during setup time. Please
specify how you want to get this pack.
NOTES
If you choose to download it from the website now, please
z Select Download from the software provider website to download the latest make sure you have internet connectivity at this time.
This process may take some time depending on the internet
software scripts from your software provider website.
connectivity.
Make sure you have internet connectivity when you are using this option. 1) Download from the software provider website.
z Select Use the one in the installation media, to install the software scripts from 2) Use the one in the installation media
the disc or share from which the installation is performed.
Page 30 of 96
Features - DB2 iDataAgent
z Select Use the copy I already have by entering its unix path, to specify the 3) Use the copy I already have by entering its unix path
path if you have the software script in an alternate location.
Your choice: [1] 2
17. Enter Yes to download and install the latest service packs and post packs from the Keep Your Install Up to Date - Latest Service Pack
software provider. Latest Service Pack provides extra functions and latest
support and fix for the packages you are going to install.
NOTES You can download the latest service pack from software
provider website.
z Internet connectivity is required to download updates.
If you decide to download it from the website now, please
z This step is applicable for multi instancing. make sure you have internet connectivity at this time.
This process may take some time depending on the internet
Press Enter to continue. connectivity.
Do you want to download the latest service pack now? [no]
Press <ENTER> to continue ...
18. Specify the location where you want to install the software. Please specify where you want us to install Calypso
binaries.
NOTES
It must be a local directory and there should be at least
z The amount of free space required depends on the components selected for install, 170MB of free space available. All files will be installed
in a "calypso" subdirectory, so if you enter "/opt", the
and may look different from the example shown. files will actually be placed into "/opt/calypso".
Press Enter to accept the default path and continue, or Installation Directory: [/opt]
Enter a path and then press Enter to continue.
..
Press Enter again to confirm the path.
Calypso will be installed in /opt/calypso.
Press ENTER to continue ...
19. Specify the location for the log files. Please specify where you want to keep Calypso log files.
20. Indicate whether you would like to launch processes with inherent database access Most of Calypso processes run with root privileges, but
some are launched by databases and inherit database access
rights.
rights. To make sure that registry and log files can be
Press Enter to assign a new group, or written to by both kinds of processes we can either make
such files world-writeable or we can grant write access
Type No and then press Enter to continue. only to processes belonging to a particular group, e.g. a
"calypso" or a "dba" group.
We highly recommend now that you create a new user group
and enter its name in the next setup screen. If you choose
not to assign a dedicated group to Calypso processes, all
temporary and configuration files will be created with -
rw-rw-rw permissions.
If you're planning to backup Oracle DB you should use
"dba" group.
Would you like to assign a specific group to Calypso?
[yes]
21. If you indicated Yes in the previous step, you will be prompted for the group name Please enter the name of the group which will be assigned
that must be used to launch processes. to all Calypso files and on behalf of which all Calypso
processes will run.
Enter the group name and then press Enter to continue.
In most of the cases it's a good idea to create a
Press Enter again to continue. dedicated "calypso" group. However, if you're planning to
use Oracle iDataAgent or SAP Agent, you should enter
For installs on a Solaris computer, proceed to the next step. Otherwise, skip to Oracle's "dba" group here.
Storage Policy Selection. Group name: dba
REMINDER
If you are planning to install Calypso Informix, DB2,
PostgreSQL, Sybase or Lotus Notes iDataAgent, please make
sure to include Informix, DB2, etc. users into group
"dba".
Press <ENTER> to continue ...
22. Type a network TCP port number for the Communications Service (CVD) and press Every instance of Calypso should use a unique set of
Enter. network ports to avoid interfering with other instances
running on the same machine.
Type a network TCP port number for the Client Event Manager Service (EvMgrC) and The port numbers selected must be from the reserved port
number range and have not been registered by another
press Enter. application on this machine.
NOTES Please enter the port numbers.
z For more information about Network TCP Ports, see Network TCP Port
Port Number for CVD : [8600]
Requirements.
z For more information about these services, see Services. Port Number for EvMgrC: [8602]
Page 31 of 96
Features - DB2 iDataAgent
z If the port number you entered already exists, a message will be displayed Port
#### is already reserved in /etc/services. To work around this issue, enter
different port number.
23. If this computer and the CommServe is separated by a firewall, type Yes and then Is there a firewall between this client and the CommServe?
press Enter to continue. [no]
For firewall options and configuration instructions, see Firewall Configuration and
continue with the installation.
If you do not wish to configure the firewall services, type No and then press Enter to
continue.
24. Type the name of the CommServe computer and press Enter to continue. Please specify hostname of the CommServe below. Make sure
the hostname is fully qualified, resolvable by the name
NOTES services configured on this machine.
z Ensure that the CommServe is accessible before typing the name; otherwise the CommServe Host Name:
installation will fail.
z If you enter a short name which resolves to the same IP address as the fully
qualified CommServe name, you will be asked if you would prefer to use the fully
qualified name.
25. Enter the username and password information for an external domain user account Enter your CommCell user name and password:
or a CommCell user account. This authorizes the installation of an agent on the
User Name :
CommCell.
Password :
NOTES
Press <ENTER> to continue ...
z This is only displayed when the Authentication for Agent feature is enabled in
the CommCell Properties. Users must belong to a User Group with Agent
Management capabilities to enable this feature. For more information, see
Authentication for Agent Installs.
Click Enter to continue.
KERNEL PARAMETERS
26. Enter the appropriate number of streams, and then press Enter to continue, or Please enter the total number of streams that you plan to
Press Enter to accept the default number of streams and continue. run at the same time. We need to make sure that you have
enough semaphores and shared memory segments configured
NOTES in /etc/system.
z The number of streams specified ensures that concurrent backup/restore streams Number of streams: [10]
would have sufficient system resources. For more information on the subject, see
Configuring Kernel Parameters for Macintosh and Configuring Kernel Parameters
for Solaris.
This prompt is relevant only when you install/upgrade on a Macintosh or Solaris
computer as appropriate.
27. Indicate whether you would like modifications to be made to the /etc/system We now need to modify the /etc/system configuration file
on this computer. It is done to make sure that there will
configuration file. be enough shared memory and semaphores available for
Type Yes, and then press Enter to automatically update the file and continue, or Calypso programs.
Press Enter to accept the default No and continue (if you do not want to Please review the changes below and answer "yes" if you
automatically update the file). want us to apply them to the /etc/system file. Otherwise,
the installation will proceed, the changes will be saved
This prompt is displayed only when you install/upgrade on a Solaris (8 or 9) or to some other file, and you will have to apply them
Macintosh computer. manually.
set shmsys:shminfo_shmmni=8570 (was 7930)
set shmsys:shminfo_shmseg=8420 (was 7780)
set semsys:seminfo_semmns=10320 (was 9680)
set semsys:seminfo_semmni=8570 (was 7930)
set semsys:seminfo_semmsl=8570(was 7930)
Do you want us to apply these changes now? [no]
Changes saved into /etc/system.gal.1744
Press <ENTER> to continue.
28. If you indicated No in the previous step, the file to which the changes have been Although a ’no’ answer can be selected to this question
saved is displayed. during install, the user should make sure the min
requirements (below) for shared memory are met, otherwise
Make sure that these values are established later to ensure that all the requirements the backups may fail (the message in logs is ’could not
for this setup is satisfied. start the pipeline’).
NOTES set shmsys:shminfo_shmmax=4199304
set shmsys:shminfo_shmmin=1
z The settings that are displayed are the maximum or minimum required settings. set semsys:shminfo_shmmni=640
Value ’640’, which is provided for various shared memory segment or semaphore set semsys:shminfo_shmseg=640
requirements, is a maximum value based on 10 streams. set semsys:seminfo_semmns=640
set semsys:seminfo_semmni=640
Press Enter to continue. set semsys:seminfo_semmsl=640
set maxusers=256
This prompt is displayed only when you install/upgrade on a Solaris (8 or 9)
computer, in cases where the install detects that the computer does not have the
maximum or minimum required shared memory settings.
Page 32 of 96
Features - DB2 iDataAgent
z This screen will be displayed only if Client Groups are configured for the CommCell. [ ] 1) Unix
For more information, see Client Computer Groups. [ ] 2) DR
[ ] 3) DKS
[a=all n=none r=reverse q=quit d=done >=next <=previous ?
=help]
Enter number(s)/one of "a,n,r,q,d,>,<,?" here: 2
NOTES IMPORTANT:
z Schedules help ensure that the data protection operations for the Agent are In addition to installing Calypso on this computer, you
will also need to create a Job Schedule for each
automatically performed on a regular basis without user intervention. For more iDataAgent that has been installed on this client
information, see Scheduling. computer.
Job Schedules are required to allow the Calypso
iDataAgents to perform automated backup and restore
operations.
Job Schedule creation can be accomplished through the
Calypso CommCell Console administration interface.
+---------------------+
NOTES 1) SP_StandAloneLibrary2_2
2) SP_Library3_3
z A storage policy directs backup data to a media library. Each library has a default 3) SP_MagLibrary4_4
4) fornax_fornax_HWCmp
storage policy.
5) ranger_ranger_HWCmp
z When you install an Agent, the install program creates a default subclient for most 6) fornax_fornax_ClntCmp
Agents. 7) fornax_fornax_MACmp
8) fornax_fornax_NoCmp
z If desired, you can change your storage policy selection at any time after you have
installed the client software. Storage Policy: [3]
z If this screen appears more than once, it is because you have selected multiple
agents for installation and are configuring storage policy association for each of the
installed agents.
Page 33 of 96
Features - DB2 iDataAgent
z Make sure that the DB2 Archive Directory resides on a shared drive that can be
accessed from all the nodes.
34. Type the path for storing information containing errors regarding the audit error path Please enter path to the DB2 Audit Error Directory.
and then press Enter. DB2 Logs Directory: /BU_area/db2/log1
When Logs are archived/retrieved, the Audit Log files are created in the location
specified by you. A maximum size of 10MB will be ideal for this location.
NOTE
z If the path that you enter does not exist, you will be asked if you want to create
this path. In such a case, accept the yes default and then press Enter.
z Make sure that the DB2 Audit Error Directory resides on a shared drive that can be
accessed from all the nodes.
35. Type the path for storing the DB2 Retrieve files and then press Enter. Please enter path to the DB2 Retrieve Directory.
DB2 Retrieve Directory: /BU_area/db2/ret
Retrieve Path is a staging location of logs during Restore. The size requirement is
determined by the number of logs that are needed to perform Roll forward operation.
NOTE
z If the path that you enter does not exist, you will be asked if you want to create
this path. In such a case, accept the yes default and then press Enter.
z Make sure that the DB2 Retrieve Directory resides on a shared drive that can be
accessed from all the nodes.
36. If you want to integrate the software with DB2 now, accept yes and press Enter. If In order to complete integration of Calypso with DB2, we
you want to do this later, type No and press Enter. need to create links to some Calypso binaries in each of
the DB2 instance directories. We can either do it now, or
if you prefer, you can
run /space/opt/calypso /iDataAgent/Db2_install.sh script
later yourself.
37. Specify the DB2 Instance User name that was selected when the DB2 instance was To integrate Calypso with a DB2 server we need to create a
installed. This is the first bit of information required to integrate the product with the set of links under lib subdirectory of the DB2
installation directory.
appropriate DB2 server.
Please specify the DB2 Instance User Name that was
Type this name or accept the default and then press Enter. selected when DB2 Instance was installed.
DB2 Instance User Name: [db2inst1]
38. You are notified in which DB2 directory the product links will be created. Calypso links will be created
in /BU_area/db2as/sqllib/lib.
Press Enter.
Press <ENTER> to continue ...
39. Decide if you want to configure another DB2 instance. Would you like to configure another DB2 instance?
If so, type yes, press Enter, and skip back two steps. Otherwise, accept no, press Configure? [no]
Enter and go to the next step.
40. The install program now starts copying the software to the computer. The progress of .....
the operation is displayed. .....
.....
.....
Successfully copied xx files
41. If you have multiple instances of the database, ensure that the items listed are IMPORTANT
satisfied. Press Enter.
If you are planning to use Calypso <package> with several
instances of the database, each running on behalf of
different UNIX users, you must make sure that:
42. A series of processing messages appears. The next-to-last message should indicate Updating registry tree under /etc/Registry ... done.
that DB2 has been installed. Preconfiguring DB2 DataAgent on the CommServe ... done.
Creating Calypso links
As prompted at the end, press Enter. under /BU_area/db2as/sqllib/lib ...done.
Page 34 of 96
Features - DB2 iDataAgent
SETUP COMPLETE
43. This menu may be displayed only when you are installing on HP-UX, Linux, or Solaris Select the Calypso module that you would like to install.
computers. If this is the last package that you wish to install/upgrade, enter the
1) FileSystem iDataAgent
number corresponding to the Exit option and then press Enter to continue. 2) Exit
NOTES Module number: [1]
z Only modules that are not installed/upgraded appear in the list.
z Your screen may appear different from the example shown.
z If you are installing on AIX, FreeBSD, IRIX or Tru64 computers, if this module was
the last possible module to install, you are automatically exited from the program.
Otherwise, type the number for the Exit option and then press Enter. The
installation is completed.
44. This prompt is displayed only when you are installing on HP-UX, Linux, or Solaris Calypso is currently configured on virtual machine
computers. Enter the number corresponding to the Exit option and then press Enter hpuxmc1.company.com.
to continue. Now you have an option of installing Calypso on physical
machine, another virtual machine or you can add a new
The installation is now complete. package to hpuxmc1.company.com.
1) Add a new package to hpuxmc1.company.com
2) Install Calypso on the physical machine
3) Install Calypso on another virtual machine
4) Exit
Your choice: [1]
Make sure to install the CVGxDB2 module on the passive node if it was not available during the installation. Install the software on passive node, see
Manually Installing the Software on a Passive Node.
POST-INSTALL CONSIDERATIONS
GENERAL
z Review Install Considerations after installing the software.
z Install post-release updates or Service Packs that may have been released after the release of the software. When you are installing a Service Pack,
ensure that it is the same version as the one installed in the CommServe Server. Alternatively, you can enable Automatic Updates for quick and easy
installation of updates in the CommCell component.
Page 35 of 96
Features - DB2 iDataAgent
Backup - DB2
Topics | How To | Related Topics
Overview
Backup Considerations
OVERVIEW
Plan your backup jobs for this agent by reviewing the following information:
z Full Backups
z Delta Backups
z Incremental Backups
z SnapProtect Backup
DELTA BACKUPS
For the DB2 iDataAgent, Delta backup works as described in Incremental Backups. See Incremental Backups for information on DB2 Delta backups.
BACKUP ARGUMENTS
Some database iDataAgents run backups using a system-generated script that is run behind the scenes from a command line. The CommCell Console serves as
a front-end user interface for specifying various backup arguments and parameters that are passed to the backup script that is run. Depending on your agent,
you can specify, for example, the application-specific Backup Level, whether the backups will be online or offline, as well as buffer and bundle sizes, among
other settings. Although the backup arguments/parameters vary among iDataAgents, they all function in a similar manner. These arguments are set at the
subclient level from the respective iDataAgent's Subclient Properties dialog box tab.
Before you change any configuration parameter, ensure that no applications are currently using the affected
Page 36 of 96
Features - DB2 iDataAgent
database. Also, be sure to consult your database administrator regarding business requirements for the database.
z Backups in General - Update the database configuration parameters when DB2 agent is installed on a cluster or multiple instances of Calypso are
installed.
{ From the DB2 console, type the following command to set the LOGARCHOPT1 parameter:
Example:
Example:
On a Cluster setup, you need to update the LOGARCHOPT1 and VENDOROPT database configuration parameters on a
virtual machine name instead of physical client name.
Updating VENDOROPT and LOGARCHOPT1 is optional, if the DB2 instance is running on non cluster configuration and default simpana instance
(Instance001).
z Online Backups - To back up any type of DB2 data online, enable the LOGRETAIN database configuration parameter by entering the following command:
z Delta/Incremental Backups - To run delta or incremental DB2 backups, enable the TRACKMOD database configuration parameter by entering the
following command:
From the DB2 Console, type the following command to set the TRACKMOD parameter:
You need to set the TRACKMOD database configuration parameter ON and run a full offline database backup to
perform a successful delta/incremental backup.
z Log Backups - To back up DB2 log files, enable the USEREXIT database configuration parameter by entering the following command:
To back up DB2 log files for DB2 version 8.2 or later using the SBT interface, enter the following commands to set the required parameters:
db2 update database configuration for <database name> using USEREXIT OFF
db2 update database configuration for <database name> using LOGARCHMETH1 VENDOR:<install path><shared library file>
where:
<shared library file> identifies the name of the shared library file libDB2Sbt.* (where * identifies the file extension, which will vary per the operating
system)
for example:
db2 update database configuration for <database name> using Logretain recovery
db2 update database configuration for <database name> using LOGARCHMETH1 “VENDOR:/opt/Calypso/Base/libDb2Sbt.so”
Page 37 of 96
Features - DB2 iDataAgent
Whenever you change the TRACKMOD database configuration parameter, be sure to run a full offline database backup. Otherwise, the TRACKMOD parameter
will not be updated.
With the SBT interface, log files are staged to an archive path, and an On Demand backup of the log files is performed when a certain threshold is reached.
Alternatively, the user can submit a backup request for any number of log files from the CommCell Console.
The USEREXIT/SBT interface program takes the logs from the DB2 directory and transfers them first to the threshold directory that was defined during the
DB2 iDataAgent install and then to tape. If you subsequently use the Delete option, the logs are deleted from the threshold directory; otherwise, the logs
are kept in this directory. By default, the threshold directory can hold 1000 logs. If the threshold directory attempts to hold more than 1000 logs, a
command line backup for the logs starts automatically, and the logs are transferred to tape.
You can control the threshold value by adding the sDb2ThresholdALFN <number> registry key to the Db2Agent registry, where <number> indicates the
number of logs you want to hold in the threshold directory before the logs will automatically start backing up to tape. Otherwise, by default, the threshold
directory can hold 1000 logs.
BACKUP CONSIDERATIONS
Before performing any backup procedures for this agent, review the following information:
z If you perform a backup of the default subclient without changing its default properties, the backup would include all the objects in the database, including
any new objects that may have been created.
If you have created subclients for databases, and if you have included the log files in these subclients, you can create a complete backup of the database by
backing up these subclients. If you have created a group of online subset subclients for the database, you must back up all of these subclients to create a
complete backup. If you have created separate subclients for log files, and if they are not included with the subclients defined for databases or subsets, then
the subclients for log files must also be backed up to create a complete backup.
z Multiple streams are supported for data protection and recovery operations with this agent; however, before utilizing multiple streams, you should
understand how their use affects operations. For more information, see Streams.
z When Oracle and DB2 iDataAgents are installed on the same client, make sure that both Oracle and DB2 users are part of the primary user groups.
Command line backups enable you to perform backup operation on multiple clients simultaneously. In order to run the backups from command line, you need
an input xml file which contains the parameters for configuring the backup options. This input xml file can be obtained from one of the following ways:
z Download the input xml file template and save it on the computer from where the backup will be performed.
z Generate the input xml file from the CommCell Console and save it on the computer from where the backup will be performed.
z From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:
qoperation execute -af qoperation_db2_backup.xml -backupLevel <FULL| INCREMENTAL| DIFFERENTIAL> -subclientName <SubclientName> -clientName
<DB2CleintName> -instanceName <DB2InstanceName> -backupsetName <DB2BackupSetName>
qoperation execute -af qoperation_db2_backup.xml -backupLevel FULL -subclientName default -clientName dbserveaix2 -instanceName db2inst5 -
backupsetName TESTDB
Page 38 of 96
Features - DB2 iDataAgent
Once the job completes, logout from the CommServe using the qlogout command.
At the Command Prompt, type the appropriate online/offline backup command for the specific platform.
Examples:
z For a DB2 instance on a 32-bit AIX/Solaris or HP-UX or 32bit/64bit Linux or 31bit Linux on System Z:
db2 backup database <db_name> online load '<software install path>/Base/libDb2Sbt.so' include logs
db2 backup db <database name> incremental delta load '<software install path>/Base/libDb2Sbt.so'
From the DB2 command prompt, type the following backup command.
Example:
z On Unix client:
z On Windows client:
where <database_name> is the name of the DB2 database and <software_install_path> is the install path for the agent software (e.g., level1/install).
Start a Backup
Schedule Backups
Page 39 of 96
Features - DB2 iDataAgent
START A BACKUP
Before You Begin
z Depending on your agent, you can perform the following types of backup operations: Full, Incremental, Differential or Synthetic Full.
{ Read Full Backups before performing a Full Backup.
{ Read Incremental Backups before performing a Incremental Backup.
{ Read Differential Backups before performing a Differential Backup.
{ Read Synthetic Full Backups before performing a Synthetic Full Backup.
1. From the CommCell Browser, expand Client Computers by double-clicking Client Computers | iDA File System | defaultBackupSet. The default and
other subclients (if available) are displayed on the right-hand windowpane.
2. To back up the default subclient, right-click the subclient, and click Backup.
In certain circumstances a non-full backup may automatically be converted to a full backup. For a listing of these circumstances, see When a Non-Full
Backup is Automatically Converted to a Full Backup.
5. Click OK. You can track the progress of the backup job from the Job Controller window. If you are using a stand-alone drive, you are prompted to load a
specific cartridge into the drive. If you are using a library, you will not receive this prompt. The system loads the tapes automatically. Your cartridges
should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job, if necessary.
6. When the backup has completed, the Job Controller displays Completed.
After running a backup, you may want to verify the backup data. You can do this by viewing the Backup History. For more information, see Backup Job
History.
z you have some particularly valuable data that you need to secure immediately.
z your data is not routinely secured through a backup schedule and you want to back up your data.
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent.
Page 40 of 96
Features - DB2 iDataAgent
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click OK. You can track the progress of the backup job from the Job Controller window.
6. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
prompt. The system loads the tapes automatically.
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Starting a backup on a backup set, instance or agent level causes the system to start individual backup jobs for
each subclient contained therein. If the subclients are associated with the same storage policy, then their jobs will
run sequentially unless that storage policy is configured to accommodate multiple data streams.
SCHEDULE BACKUPS
You can schedule backups to occur with the following procedure. You will be prompted to create a schedule for the data protection operation after selecting
your data protection options.
z All Agents
{ Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent. Note this does not
apply to archive operations.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
3. From the Backup Options dialog box, select the type of backup that you want to initiate. In certain circumstances a non-full backup may automatically be
converted to a full backup. For a listing of these circumstances, see When a Non-Full Backup is Automatically Converted to a Full Backup.
5. From the Schedule Details (Schedule Details) dialog box, create a schedule for this operation. For step-by-step instructions, see Create a Job Schedule.
Click OK to continue.
Page 41 of 96
Features - DB2 iDataAgent
Starting a data protection operation on a backup set, instance or agent level causes the system to start individual
data protection operations for each subclient contained therein. If the subclients are associated with the same
storage policy, then their operations will run sequentially unless that storage policy is configured to accommodate
multiple data streams.
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent. Note this does not apply
to archive operations.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click the Advanced button to open the Advanced Backup Options dialog box.
6. Click on the Advanced Backup Options (Startup) tab, and select Startup in suspended state and click OK.
7. From the Backup Options dialog box, click OK. You can track the progress of the backup job from the Job Controller window.
8. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
prompt. The system loads the tapes automatically.
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Starting a data protection operation on a backup set, instance or agent level causes the system to start individual
data protection operations for each subclient contained therein. If the subclients are associated with the same
storage policy, then their operations will run sequentially unless that storage policy is configured to accommodate
multiple data streams.
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent. Note this does not apply
to archive operations.
Page 42 of 96
Features - DB2 iDataAgent
{ To backup a user-defined backup set or instance, right-click the backup set you want to backup, click All Tasks, and click Backup All Subclients.
{ To backup the default backup set, right-click the agent or instance node, click All Tasks, and click Backup Default Backup Set.
{ For Lotus Notes iDataAgent, to backup a partition, right-click the partition you want to backup, click All Tasks, and click Backup Default Backup Set.
{ For Agents that do not have backup set or instance levels, to backup all subclients, right-click the agent icon, click All Tasks, and click Backup All
Subclients.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click the Advanced button to open the Advanced Backup Options dialog box.
6. Click on the Advanced Backup Options (Media) tab, and select Start new media and click OK.
If you would like jobs with other Job IDs to use this new media, also select the Allow other schedule to use media set option.
7. From the Backup Options dialog box, click OK. You can track the progress of the backup job from the Job Controller window.
8. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
prompt. The system loads the tapes automatically.
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Starting a data protection operation on a backup set, instance or agent level causes the system to start individual
data protection operations for each subclient contained therein. If the subclients are associated with the same
storage policy, then their operations will run sequentially unless that storage policy is configured to accommodate
multiple data streams.
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent. Note this does not apply
to archive operations.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click the Advanced button to open the Advanced Backup Options dialog box.
6. Click on the Advanced Backup Options (Media) tab, and select Mark media full after successful operation and click OK.
7. From the Backup Options dialog box, click OK. You can track the progress of the backup job from the Job Controller window.
8. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
Page 43 of 96
Features - DB2 iDataAgent
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Starting a data protection operation on a backup set, instance or agent level causes the system to start individual
data protection operations for each subclient contained therein. If the subclients are associated with the same
storage policy, then their operations will run sequentially unless that storage policy is configured to accommodate
multiple data streams.
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent. Note this does not apply
to archive operations.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click the Advanced button to open the Advanced Backup Options dialog box.
6. Click on the Advanced Backup Options (Startup) tab, and select Change Priority and then enter a value. Click OK to continue.
7. From the Backup Options dialog box, click OK. You can track the progress of the backup job from the Job Controller window.
8. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
prompt. The system loads the tapes automatically.
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Starting a data protection operation on a backup set, instance or agent level causes the system to start individual
data protection operations for each subclient contained therein. If the subclients are associated with the same
storage policy, then their operations will run sequentially unless that storage policy is configured to accommodate
multiple data streams.
z VaultTracker
z VaultTracker Enterprise
Page 44 of 96
Features - DB2 iDataAgent
z Be sure all of the subclients are backed up, or scheduled to be backed up as needed, in order to secure all of the data for the agent.
2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that
level/node. Click Yes.
5. Click the Advanced button to open the Advanced Backup Options dialog box.
6. Click on the Vault Tracking tab, and select the vault tracking options you want to use and click OK.
7. From the Backup Options dialog box, click OK. You can track the progress of the backup job from the Job Controller window.
8. If you are using a stand-alone drive, you are prompted to load a specific cartridge into the drive. If you are using a library, you will not receive this
prompt. The system loads the tapes automatically.
Your cartridges should be appropriately labeled. This will enable you to locate the correct cartridge for a restore job,
if necessary.
Back To Top
Page 45 of 96
Features - DB2 iDataAgent
Overview
z General Option
z Restore Arguments Option
z Recover Database Option
Restore Destinations
OVERVIEW
The following page describes the agent-specific restore options. Additional restore options are accessible from the Related Topics menu.
z Restoring and recovering entire DB2 system databases and DB2 user databases
z Restoring and recovering portions of DB2 databases (i.e., selected table spaces)
z Restoring history files
z Restoring log files
Recovery involves two processes: restoring the physical files and then recovering the database. The user can either select backup images to be restored or
have the system select the backup image. After the necessary files are restored, the database is recovered (and, in some cases, rolled forward) by applying the
appropriate log files.
Additionally, the DB2 iDataAgent supports specific procedures for doing the following:
z Administering table space containers (see DB2 Restore Options below for comprehensive information)
Page 46 of 96
Features - DB2 iDataAgent
z Rerunning failed restore jobs containing multiple images based on the type of backup image (i.e., full, delta, or incremental) that failed during the previous
restore
z Restoring databases created within a user-defined directory
z Restoring databases with specific parameters containing a non-default value
Depending on your restore options, restores can be performed in-place, out-of-place or cross-platform. (See Restore Destinations below for comprehensive
information.) Also, DB2 restore jobs can be run from a third-party command line, and they cannot be suspended unless they are in a pending state.
For the DB2 iDataAgent, restore operations can be performed from the client and backup set levels in the CommCell Browser.
When there is a problem with DB2 database or the client system (operating system, hardware, hard drives, etc.), full system restores may be required. See
Restore Data - DB2 iDataAgent - Full System Restore for more information.
z Before performing any restore procedures for this agent, review the following information.
{ Restore Order of DB2 Backup Images within a Cycle
For example, assume that Backup Cycle A includes the following backup images (F represents a full backup image, D represents a delta backup image, and I
represents an incremental backup image).
Using the rules in the previous bullet list, the backup images in Backup Cycle A would be restored in the following order.
Note that Delta Backup Image 5 (i.e., D5) is the last backup image in Backup Cycle A. Therefore, it is restored first and then last when the backup images in
the cycle are restored. Note also that Full Backup Image 1 (i.e., F1) is restored second, and that the remaining backup images are restored in the appropriate
order.
The information in this section is important if you try to restore a full backup image along with one or more associated incremental backup images and/or delta
backup images but one of these backup images fails to restore. In such a case, you must follow the appropriate steps to implement a successful restore. For
more information, see the appropriate how-to topic.
The following options are provided from the Restore Options dialog box in the CommCell Browser.
GENERAL OPTION
The General tab allows you to select the data to restore and the destination(s) for the restore. It also provides an option to administer table space containers.
You should use this option if your system has lost containers (because of a crash, for example) or if one or more current containers are full.
Page 47 of 96
Features - DB2 iDataAgent
The Restore Arguments tab allows you to administer the type of restore, the backup images available for restore, and the DB2 Report File. For each full backup
image that you select to restore, be sure to select all associated incremental or delta backup images as well. Whenever this tab is enabled, the Recover
Database tab is disabled.
If the database to be recovered is dropped or deleted, you cannot use this option. In such a case, click Advanced
and use the Roll-Forward option.
These options will be disabled if you use the Recover Database tab.
You do not need (and are not able) to use the Roll-Forward tab if you use the Recover Database tab to have the DB2
iDataAgent select the backup image for restore. You can use the Roll-Forward tab if you use the Restore Arguments
tab to select the backup images for restore.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click Advanced, and then click the Log Files tab.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click Advanced, and then click the Log Files tab.
6. Select the Start and End check boxes to specify the point in time (date and time) for
restore of log files.
7. Click OK.
Page 48 of 96
Features - DB2 iDataAgent
iDataAgent | <Instance>.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click Advanced, and then click the Log Files tab.
7. Click OK.
REDIRECT OPTION
The Redirect tab allows you to rename one or more table spaces or table space containers upon restore. Renaming these items as they are restored allows
them to be restored without overwriting existing table spaces or table space containers.
5. Click Browse to select the new location to redirect the table spaces during restore
operation.
6. Click OK.
2. Right-click the <BackupSet>, point to All Tasks and then click Restore.
3. Click Advanced, and then click the Redirect tab.
5. From the Table Space box select the required table space to be redirected, the
associated container name is displayed in the Container Name box.
6. Click Add to create a new container for the selected table space to redirect.
7. Click Browse to select the new location to redirect the table space during restore
operation.
8. Click OK.
Use the following steps to restore table space of an automatic storage database to another path.
2. Right-click the <BackupSet>, point to All Tasks and then click Restore.
3. Click the Recover Database tab, and then clear the Recover DB check box.
6. Click Browse to select the new path or click Add Paths to type the new path.
Page 49 of 96
Features - DB2 iDataAgent
7. Click OK.
ROLL-FORWARD OPTION
The Roll-Forward tab allows you to recover the DB2 database by reapplying the log files containing transactions that are not part of any database backup
image. The roll-forward capability is invoked after a database or table space image is restored. Before the database can be "rolled forward," you must perform
log archiving by doing one or both of the following: having the logretain database configuration parameter set to "RECOVERY"; and/or enabling the userexit
database configuration parameter.
Whenever log files are restored with the roll-forward option activated, DB2 searches for the following target restore paths per the following order: DB2's own
directory path for log file restores; the DB2 Retrieve Path that was specified during the installation of the DB2 iDataAgent; the DB2 Archive Path that was
specified during the installation of the DB2 iDataAgent; and the path identified (if any) in the Overflow Directory field within the Roll-Forward tab.
If DB2 is unable to find any of these paths, the appropriate error is reported in a file within the DB2 Audit Error Path that was specified during installation of the
DB2 iDataAgent.
Use the following steps to reapply all of the logs to the database after a restore.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click Advanced, and then click the Roll-Forward tab.
6. Click Browse to select the Overflow Directory. If the required log file is not present
in the location specified by the logpath database configuration parameter, DB2
searches the overflow directory.
7. Select the Alternate Log Path check box, and then click Browse to select another
location within the DB2 directory for the log files.
8. Click OK.
Use the following steps to reapply logs till a point-in-time to the database after a restore.
Use the following steps to keep the database in a pending state till the logs are reapplied.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click Advanced, and then click the Roll-Forward tab.
4. Select the Leave in Roll-forward Pending State check box to leave the database
in a roll-forward pending state.
5. Click OK.
Page 50 of 96
Features - DB2 iDataAgent
where:
Timestamps are displayed in the Restore Options (Restore Arguments) dialog box in the CommCell Browser.
For example:
============================================================
restore db db_one incremental taken at 20030224125749
restore db db_one incremental taken at 20030224124314
restore db db_one incremental taken at 20030224125211
restore db db_one incremental taken at 20030224125749
=============================================================
In this example, note that the timestamp for the database image included in the command appears twice in the output — in the first line and in the last line.
This indicates that this (delta or incremental) backup image was the last backup image in the backup cycle and therefore was restored first and then last
among all of the backup images in the cycle.
You can view backup image restore failures by checking the system logs. For information on system logs, see Log
Files. Also, you can view details on all the backup images included in a restore by checking the output of the
db2ckrst command.
See Restore Order of DB2 Backup Images within a Cycle for a discussion of restoring multiple DB2 backup images
within a backup cycle.
3. Select Restore Data check box and click Entire Database option.
4. Click OK to start the restore.
Page 51 of 96
Features - DB2 iDataAgent
z The operating system on the destination client should be the same as that in the source client.
z The DB2 application on the destination client should be the same (or later) version as that in the source client.
z The DB2 user should have sufficient rights to restore the database. See Configuring User Accounts for more information.
2. Right-click the <BackupSet>, point to All Tasks, and then click Restore.
3. Click the Recover Database tab.
9. In the Target Database path, type the location of the target database.
Alternatively, click browse to select the path.
If the original host is damaged, you can restore the DB2 database to a different instance on the same host or to a different host. Whenever you perform a
cross-machine restore, ensure that the destination computer has sufficient disk space to accommodate the restored database.
RESTORE DESTINATIONS
By default, the DB2 iDataAgent restores data to the client computer from which it originated; this is referred to as an in-place restore. You can also restore the
data to another Client computer in the CommCell. Keep in mind the following considerations when performing such restores:
Page 52 of 96
Features - DB2 iDataAgent
z The destination client must reside in the same CommCell as the client whose data was backed up.
z Note that when you perform restores other than in-place restores, the restored data assumes the rights (i.e., permissions) of the parent directory.
The following section enumerates the types of restore destinations that are supported by the DB2 iDataAgent. See Restore/Recover/Retrieve Destinations -
Support for a list of Agents supporting each restore destination type.
IN-PLACE RESTORE
z Same path/destination
OUT-OF-PLACE RESTORE
Keep in mind that out-of-place restore operations are also subject to the conditions described in Cross-Platform Restores.
z Same path/destination
z Different path/destination
CROSS-PLATFORM RESTORES
z Same Operating System - Different Version
Command line restores enable you to perform restore operations on multiple clients at the same time. It also allows you to reuse the command line scripts for
additional restores.
When performing command line restores, note that backups taken from the CommCell Console can be restored using Command Line and vice versa. However,
backups taken from a previous version of the CommCell Console can be restored only from the Command Line.
In order to run the restores from command line, you need an input xml file which contains the parameters for configuring the restore options. This input xml
file can be obtained using one of the following ways:
z Download the input xml file template and save it on the computer from where the restore will be performed.
z Generate the input xml file from the CommCell Console and save it on the computer from where the restore will be performed.
z From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:
Example
qoperation execute -af qoperation_db2_recover.xml -clientName dbserveaix2 -instanceName db2inst5 -backupsetName TESTDB
3. Once the job completes, logout from the CommServe using the qlogout command.
Page 53 of 96
Features - DB2 iDataAgent
Use the following steps to restore a DB2 database. You must deactivate the database before performing a DB2 database restore.
1. At the Command Prompt, type the appropriate restore command for the specific platform.
{ For a DB2 instance on 32-bit AIX/Solaris, or 32-bit or 64-bit Linux, or 31-bit/64-bit Linux on System Z, run the following command:
db2 restore db <database name> incremental automatic load '<software install path>/Base/libDb2Sbt.so' taken at <backup image
date> without prompting
{ For a DB2 instance on 64-bit AIX/Solaris or 64bit Linux on System Z, run the following command:
db2 restore db <database name> incremental automatic load '<software install path>/Base64/libDb2Sbt.so' taken at <backup image
date> without prompting
{ For a DB2 instance on a 32bit/64bit Windows platform, run the following command:
db2 restore db <database name> incremental automatic load '<software install path>/Base/Db2Sbt.dll' taken at <backup image date>
without prompting
where <software install path> is the install path for the agent software (e.g., level1/install); and <backup image date> is the date of the backup image in
the following format: "YYYYMMDDHHMMSS" (e.g., 20070612120426).
1.. At the Command Prompt, type the appropriate restore command for the specific On Unix client:
platform.
db2 restore db <db_name> load '<software install
path>/Base(or Base64)/libDb2Sbt.so' open <n>
sessions taken at <backup_image>
On Windows client:
db2 "restore db <db_name> load '<software install
path>\Base\Db2Sbt.dll' open <n> sessions taken at
<backup_image>"
2. Roll forward the DB2 database db2 rollforward db <database name> to end of logs
and complete
1. At the Command Prompt, type the restore command. db2 restore db pubs load <source software install
path>/Base/libDb2Sbt.so taken at 20080627113811 on
<destination software install path> into emp
2. Set the CvSrcDbName option for the LOGARCHOPT1 parameter to the source database db2 update db cfg for emp using LOGARCHOPT1
name. "'CvSrcDbName=pubs,CvClientName=<client
name>,CvInstanceName=<CommServe instance name>"'
3. Roll forward the DB2 database db2 rollforward db emp to end of logs and stop
Page 54 of 96
Features - DB2 iDataAgent
1. Set the CvSrcDB2InstanceName option to the source database name in the db2 update db cfg for emp01 using VENDOROPT
VENDOROPT parameter (in this example, db2inst3). "'CvSrcDB2InstanceName=db2inst3,CvClientName=supernova,
CvInstanceName=Instance001"'
2.. At the Command Prompt, type the restore command. db2 restore db pubs load <source software install
path>/Base/libDb2Sbt.so taken at 20080627113811 on
<destination software install path> into emp01
3. Set the CvSrcDbName option to the source database name and the db2 update db cfg for emp01 using LOGARCHOPT1
CvSrcDB2InstanceName option to the source DB2 instance name in the LOGARCHOPT1 "'CvSrcDbName=pubs,CvSrcDB2InstanceName=db2inst3,
parameter. CvClientName=supernova, CvInstanceName=Instance001"'
4. Roll forward the DB2 database db2 rollforward db emp to end of logs and stop
1. Set the CvSrcClientName option to the source client name and the db2 update db cfg for emp01 using VENDOROPT
CvSrcDB2InstanceName option to the source database name in the VENDOROPT "'CvSrcClientName=supernova,CvSrcDB2InstanceName=db2inst3,
parameter (in this example, db2inst3). CvClientName=neutronstar,CvInstanceName=Instance001"'
2. At the Command Prompt, type the restore command. db2 restore db pubs load <source software install
path>/Base/libDb2Sbt.so taken at 20080627113831 on
<destination software install path> into emp
3. Set the CvSrcDbName option to the source database name, the CvSrcClientName db2 update db cfg for emp using LOGARCHOPT1
option to the source client name, and the CvSrcDB2InstanceName option to the
"'CvSrcDbName=pubs,CvSrcClientName=supernova,
source instance name in the LOGARCHOPT1 parameter.
CvSrcDB2InstanceName=db2inst3,CvClientName=neutronstar,
CvInstanceName=Instance001"'
4. Roll forward the DB2 database db2 rollforward db emp to end of logs and stop
Back to Top
Restore a DB2 Database or DB2 DPF Database Partition Created in a User-defined Directory
Restore a DB2 Database or DB2 DPF Database Partition with Specific Parameters Containing a Non-default Value
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
1. From the Restore Arguments tab of the Restore Options dialog box, enable the Incremental Restore (from one Full backup image) option.
2. Select only the full backup image that failed to restore from the Available Images field.
3. Click Advanced.
4. From the Roll-Forward tab of the Advanced Restore Options dialog box, select the Leave in Roll-Forward Pending State option.
Page 55 of 96
Features - DB2 iDataAgent
6. From the Restore Arguments tab, disable the Incremental Restore (from one Full backup image) option.
7. Select the next (non-full) backup image in the backup cycle from the Available Images field.
9. Repeat the previous two steps until all the other backup images in the cycle have been restored.
1. From the Restore Arguments tab of the Restore Options dialog box, disable the Incremental Restore (from one Full backup image) option.
2. Select the backup image that failed to restore from the Available Images field.
4. Select the next backup image in the backup cycle from the Available Images field.
6. Repeat the previous two steps until all the other backup images in the cycle have been restored.
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
1. Refer to Browse and Restore or Basic Restore as appropriate to restore the database.
2. Click Advanced.
3. Ensure that you redirect all the associated tablespaces by using the Redirect tab within the Advanced Restore Options dialog box.
RESTORE A DB2 DATABASE OR DB2 DPF DATABASE PARTITION WITH SPECIFIC PARAMETERS
CONTAINING A NON-DEFAULT VALUE
Before You Begin:
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
DBHEAP, UTIL_HEAP, and/or APP_CTL_HEAP_SZ configuration parameters contain a value other than the default value:
2. Set the DBHEAP, UTIL_HEAP, and/or APP_CTL_HEAP_SZ configuration parameters for this database to the (non-default) value of each of these parameters
for the source database.
3. Restore the source database backup image to the dummy database. Refer to Browse and Restore or Basic Restore as appropriate.
Basic Restore
Topics | How To | Related Topics
Overview
Page 56 of 96
Features - DB2 iDataAgent
OVERVIEW
There are two functions that help you retrieve backed up data from the backup media: Browse and Restore. Browse operations allow you to view the data that
has been backed up for a client computer without actually restoring the data. Restore operations retrieve the data from the backup media and restore it to the
desired location.
In the CommCell Browser, the Browse and various Restore commands appear in the right-click menus at the agent, instance and/or backup set levels,
depending on agent.
Using the Restore commands, i.e., restoring without browsing, is most appropriate when you want to restore the latest backup job for an agent, instance or
backup set and want to retain the current file structure.
In certain situations and for supported agents, Restore operations can run without utilizing the Browse feature. For example, if you know the path/name of the
volume of the data that you want to restore, you can restore it without browsing. In these agents, this procedure is most appropriate when the number of
paths for the data that you want to restore is small or when the data that you want to restore is at a single volume. If you want to restore data from many
different paths or volumes, you should probably select the data from the Browse window.
Basic Restore
BASIC RESTORE
Before You Begin:
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
1. From the CommCell Browser, right-click the agent, instance or backup set that contains the data you want to restore, click All Tasks and then click the
available Restore command (command names vary by agent).
2. In the Restore dialog box, type the starting path of the data you want to restore.
3. From the Restore Options and Advanced Restore Options dialog boxes, select the restore options that you want to use. When you accept all the
default settings, you will be restoring the selected data to its original location. See Restore Backup Data for complete information on the agent-specific
restore options.
4. After completing your selections, you can either start an immediate restore or schedule the restore.
{ If you want to schedule the job, click the Job Initiation tab from the Restore Options dialog box, click Schedule, and enter your selections in
the Schedule Details (Schedule Details) dialog box. Clicking OK from this dialog box saves your schedule. See Scheduled Data Recovery Operations for
an overview of this feature.
{ If you want to run the job now, accept or click Run Immediately in the same tab and then click OK.
You can monitor the progress of the restore job in the Job Controller. While the job is running, you can right-click the job in the Job Controller and select Detail
to view information on the job.
After the data has been restored, you will see a job completion message in the Job Controller and Event Viewer.
Page 57 of 96
Features - DB2 iDataAgent
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
1. From the CommCell Browser, right-click the agent, instance or backup set that contains the data you want to restore, click All Tasks and then click the
available Restore command (command names vary by agent).
2. In the Restore dialog box, type the starting path of the data you want to restore.
3. From the Restore Options and Advanced Restore Options dialog boxes, select the Time Range tab.
4. In the Advanced Restore Options (Time Range) dialog box, clear the Show Deleted Items option, if required.
In the Specify Restore Time area select the Time Zone for the time range options. Select the Exclude Data Before option and select the start date and
time from which you wish to restore data, and select the Browse Data Before option and select the end date and time until which you wish to restore
data.
Back To Top
OVERVIEW
There are two functions that help you retrieve backed up data from the backup media: browse and restore. In the CommCell Browser, the browse and
variously-named restore commands appear, depending on agent, in the right-click menus at the agent, instance and/or backup set levels.
Browse operations allow you to view data that has been backed up by the agent on the client computer and select all or some of that data. Depending on the
agent, there are several options available to customize your browse. See Browse Data for comprehensive information on Browse operations.
Restore operations allow you to retrieve data from backup media and restore it to the desired location. Restoring without browsing is most appropriate when
you want to restore the latest backup job for an agent, instance or backup set and want to retain the current file structure. See Basic Restore for more
information on restoring without using browse.
The Browse and Restore procedure is a sequential procedure that combines the two procedures. When you select a Browse command from the CommCell
Browser, you can define and run one of many potential browse sequences. At the end of the browse, when you are looking at the resulting information
presented in the Browse window, you can continue with a restore procedure simply by selecting data and clicking the Recover All Data button. As with the
browse, depending on the agent, there are several options available to customize your restore.
z Review the general and agent-specific restore requirements accessed from Restore Backup Data prior to performing any restore operation.
Page 58 of 96
Features - DB2 iDataAgent
1. From the CommCell Browser, right-click the agent, instance, backup set, or Legal hold set (for Legal Hold data) that contains the data you want to restore,
click All Tasks and then click the available Browse command (command names vary by agent).
2. Run a browse operation. See Browse Data for a list of customized browse operations and their step-by-step instructions. If you accept all defaults, you will
be browsing the latest backups for the selected data.
3. From the Browse window, Select Objects From the Browse Window for Restore.
4. From the agent's Restore Options and Advanced Restore Options dialog boxes, select the restore options that you want to use. For agents with
multiple tabs, do not click OK until you have used all of the desired tabs. When you accept all the default settings, you will be restoring the selected data
to its original location. See Restore Backup Data for access to complete information on the agent-specific Restore Destination options and procedures
available.
5. When restoring encrypted data, refer to Data Encryption for comprehensive feature information and procedures for using the Encryption tab of the
Advanced Restore Options dialog box.
6. After completing your selections, you can either start an immediate restore or schedule the restore.
{ If you want to schedule the job, click the Job Initiation tab from the Restore Options dialog box, click Schedule, schedule the job, and then click OK.
{ If you want to run the job now, accept or click Run Immediately in the same tab and then click OK.
While the job is running, you can right-click the job in the Job Controller and select Detail to view information on the job. After the data has been
restored, you will see a job completion message in the Job Controller and Event Viewer.
Back To Top
Page 59 of 96
Features - DB2 iDataAgent
Instances - DB2
Topics | How To | Related Topics
Overview
Configurable Properties
OVERVIEW
You must create a DB2 instance from the CommCell Browser as soon as you install the DB2 iDataAgent. This allows you to perform a backup on the DB2
database.
See Instances for an overview of Instances. Given below is a list of what you need to provide before creating a DB2 instance.
Providing the latter two storage policies allows you to view and track the status of jobs in the Job Controller and Event Viewer.
Software compression for DB2 Command Line Backups can be enabled or disabled at the instance level. Software compression for data can be more granularly
managed through the subclient level.
Each DB2 iDataAgent consumes one license during installation. Note that each license can accommodate multiple
instances and databases.
After creating the DB2 instance, you must Create Backup Sets for the instance.
CONFIGURABLE PROPERTIES
Once installed, the agent is configured and is therefore able to manage the data or volumes on the client computer. However, you can change certain aspects
of the instance configuration to manage the data in the manner that best suits your needs.
You can view or change the instance configuration from the Instance Properties dialog box. The following information can be configured.
USER ACCOUNTS
You can change the Windows or Unix user accounts that are used by the system to access the application and in effect perform all data protection and recovery
operations for the iDataAgent.
See the DB2 iDataAgents section in User Accounts and Passwords for more information.
USER SECURITY
Page 60 of 96
Features - DB2 iDataAgent
By default, the db2 administrator user account is used for performing backups and restores. However, if you want to use a non-db2 admin user, make sure that
the user has the following privileges:
z On Unix clients, the user should be part of the user group assigned during the iDataAgent install.
z On Windows clients, the user should be part of the local administrator group.
z The user should be part of the SYSMAINT_GROUP and SYSCTRL_GROUP authorities.
You can change the user account at the Instance and Backup Set levels.
4. In the User Account box, type the name of the user account to be used for
accessing the DB2 application.
5. In the Enter Password box, type the password for the user account.
6. In the Confirm Password box, retype the password, and then click OK.
7. Click OK.
When you modify the user account for an instance, the new user account will be used for the subsequent new backup sets created within the instance. The
existing backup sets however will continue to use the earlier user account unless modified manually.
Use the following steps to change the user account for a specific backup set:
Page 61 of 96
Features - DB2 iDataAgent
4. Click Change.
5. In the User Account box, type the user account to be used for accessing the DB2
application.
6. In the Enter Password box, type the password for the user account.
7. In the Confirm Password box, retype the password, and then click OK.
8. Click OK.
Back to Top
Create an Instance
Modify an Instance
Delete an Instance
CREATE/MODIFY AN INSTANCE
Before you Begin
z For the Oracle, Oracle RAC or SAP for Oracle iDataAgent, if you have custom SQL settings, you must turn off these settings to ensure that the instance
browse works correctly and that the instance status is correctly fetched. To do this, create and edit the cvlogin.sql file with the appropriate contents at
ORACLE_HOME/sqlplus/admin. For example, run the following command:
1. To create an instance, from the CommCell Browser, locate the correct client computer node, and right-click the agent node for which you want the new
instance created, click All Tasks, and then click New Instance from the shortcut menu.
To modify an existing instance, from the CommCell Browser, right-click the instance you want to modify, and then click Properties from the shortcut
menu.
2. From the General tab, enter the name (up to 32 characters) for the instance. In addition, provide the required access information for this instance.
For various iDataAgents, you can add/modify an application/database user account. See the appropriate section as follows in User Accounts and
Passwords for more information:
Page 62 of 96
Features - DB2 iDataAgent
{ DB2 iDataAgent
{ Documentum iDataAgent
{ Informix iDataAgent
{ Microsoft SQL Server iDataAgent
{ Oracle iDataAgents (Oracle, Oracle RAC, SAP for Oracle)
{ Sybase iDataAgent
{ MySQL iDataAgent
{ PostGreSQL iDataAgent
3. If your agent uses the Details tab, enter the required database connect string and other optional parameters.
{ For the Oracle, Oracle RAC and SAP for Oracle iDataAgents, see the Oracle iDataAgents section in User Accounts and Passwords for more
information.
4. From the Storage Device tab, select storage policy copies to be used for, as applicable, data backups, command line data backups and log backups. Within
these tabs you can click Data Paths to display the details of the data paths associated with the primary storage policy copy of the selected storage policy.
5. If your agent uses the Software Compression tab, and you want to enable software compression for the selected backups, click the tab and select the
option appropriate to your environment.
6. If you want to enable data encryption, from the Encryption tab select encryption settings for third-party or RMAN command line backups.
8. A message advises you to schedule backups for your new instance. It is recommended you elect to set a schedule now. You can also associate this
instance with an All Agent Types schedule policy (which is automatically created by the system, or can be a user defined Data Protection schedule policy).
If you have already associated a schedule policy at a previous level (Agent, Client, or Client Computer Group) the schedules defined in the Schedule Policy
will be automatically applied to the new instance. See Schedule Policy for more information.
{ For agents that offer an OK option, click OK to acknowledge the message. This procedure is now complete.
{ For agents that offer Yes and No options to this message, click No if you don't want to create a backup schedule at this time, and this procedure is
complete. If you click Yes, a dialog box prompts you to back up all subclients of this instance.
9. Click Yes. The Backup Options dialog box appears, which allows you to create the necessary schedules.
10. From the Backup Options dialog box, select the type of backup that you want to schedule.
12. After selecting the backup type and any advanced options, click OK. The Schedule Details dialog box appears.
13. From the Schedule Details tab of the Schedule Details dialog box, select the scheduling options that you want to apply, then click OK.
NOTES
z A default subclient is created for the Oracle instance, which includes all the objects in the instance. When you are done with this procedure, open the
Subclient Properties dialog box for the default subclient and verify that the Resync Catalog option available in the Backup Arguments tab is selected.
This would help you to successfully perform a full system restore in the event of destroyed or damaged client.
z After creating the instance for DB2, you can now create one or more Backup Sets for this instance.
MODIFY AN INSTANCE
Required Capability: See Capabilities and Required Actions
1. From the CommCell Browser, right-click the instance you want to modify, and then click Properties from the shortcut menu.
2. Click the General tab of the Instance properties box to change the required access information for this instance.
3. If your agent uses the Accounts tab, use this tab to specify the Windows account used by the system. For MySQL iDataAgent, use this tab to specify the
MySQL Server user account.
4. If your agent uses the Restore View Names tab, use this tab to enter or modify a list of text patterns for the view through which the system displays a
database's data documents when you browse.
5. If your agent has the Security tab, you can view CommCell resource associations to enable or disable user groups that can perform system operations on
associated resources.
6. For an Oracle instance, click the Details tab to change the database connect string and other optional parameters.
7. For an Oracle RAC instance, go to the next step. Otherwise, go to Step 12.
Page 63 of 96
Features - DB2 iDataAgent
8. Click the Details tab, and type or select values for the fields at the bottom of the dialog box as appropriate. For the DB2 DPF instance, to associate a
database partition with a different client, click the affected partition in the DB2 Partition Clients field, click Modify, and click from the list in the Edit
Directory Share Name Pair dialog box the name of the new client for the partition. Then click OK.
9. Click the Oracle instance (Client/Instance/Status) that you want to modify. Then click Modify.
10. In the Update Instance dialog box, update the desired field values by typing or browsing as appropriate. Then click OK.
11. Repeat the previous two steps for each Oracle instance that you want to modify.
12. From the Storage Device tab(s), select storage policy copies to be used for, as applicable, data backups, command line data backups and log backups.
Within these tabs you can click Data Paths to display the details of the data paths associated with the primary storage policy copy of the selected storage
policy.
For the MySQL iDataAgent, select the storage policy for the log backups from the Log Backups tab.
13. If your agent uses the Software Compression tab, and you want to enable software compression for the selected backups, click the tab and select the
appropriate option.
14. If you want to enable data encryption, from the Encryption tab select encryption settings for third-party or RMAN command line backups.
16. A message advises you to schedule backups for your new instance. It is recommended you elect to set a schedule now. If you click No, this procedure is
now complete. If you click Yes, a dialog box prompts you to back up all subclients of this instance.
17. Click Yes. The Backup Options dialog box appears, which allows you to create the necessary schedules.
18. From the Backup Options dialog box, select the type of backup that you want to schedule.
20. After selecting the backup type and any advanced options, click OK. The Schedule Details dialog box appears.
21. From the Schedule Details tab of the Schedule Details dialog box, select the scheduling options that you want to apply, then click OK.
DELETE AN INSTANCE
Before You Begin
z For most agents except Oracle and SQL Server, you cannot delete an instance if there is only one instance present for an agent. To delete the final instance
for most agents except the ones identified, you must first remove the agent software from the client computer. For Oracle RAC, which does not involve
agent software, you can delete the instance under the RAC pseudo-client.
z When you delete a specific instance positioned in the level below the corresponding agent or pseudo-client in the CommCell Console, the following actions
occur:
{ The corresponding backup data for that instance becomes immediately unavailable, thus making it inaccessible for restore purposes. In effect, the backup
data is deleted.
{ All child levels contained within the level are deleted in the CommCell Browser.
{ All job schedules and job histories that pertain to any of the levels within the deleted instance are deleted.
z If you delete an Oracle iDataAgent instance included within an Oracle RAC instance (node), the backup data is not deleted, and it is available for restore by
another eligible client.
z You cannot delete an instance if it is being backed up. Attempts to delete an instance under such conditions cause the deletion to fail. If a backup is in
progress, either wait for the backup to complete or kill the backup job using the Job Manager. Once the backup is no longer in progress, you can delete the
instance level.
-client
1. From the CommCell Browser, right-click the instance that you want to delete, click All Tasks and then click Delete.
2. Click Yes to confirm the deletion. (Clicking No cancels the deletion and retains the node.)
3. Type the requested phrase in the Enter Confirmation Text dialog box and click OK. This should delete the instance.
1. Right-click the Oracle RAC instance, click Properties, and click Details.
2. Click the instance that you want to delete within Client/Instance/Status and click Delete.
3. Repeat the previous step for each Oracle iDataAgent instance (except the last one remaining) within the Oracle RAC instance that you want to delete.
Page 64 of 96
Features - DB2 iDataAgent
With the exceptions noted above, you can no longer access the corresponding backup data for restore purposes.
1. From the CommCell Browser, locate the correct client computer node, right-click the iDataAgent, Agent or instance node (depending on your agent's
functionality) for which you want the backup set/archive set created, select All Tasks and then click Create New Backup Set or Create New Archive
Set.
2. For most agents, from the Create New Backup Set or Create New Archive Set dialog box, enter a New Backup Set Name or New Archive Set
Name (up to 32 characters) of the backup set/archive set that you want to create. For the DB2 or DB2 DPF iDataAgent, from the same dialog box, click
the desired database (backup set) name under Available DB Names and move this name under Selection.
NOTES
{ For DB2 or DB2 DPF, to prevent archive log backup failures, ensure that the name that you select is the actual name of the database and not the alias
name for the database. If the database name and the corresponding alias name are different, both names are displayed under Available DB Names; if
both names are the same, the name that is displayed is the database name. To find out about database names and their aliases, run the following
command as a DB2 or DB2 DPF instance owner on the DB2 or DB2 DPF client: db2 list db directory.
3. Where applicable, if you want to designate this backup set/archive set as the default backup set/archive set, select Make this the Default backup set or
Make this the Default Archive Set; otherwise, leave the check box cleared.
4. For most agents, verify that the storage policy copy associated with the default subclient is the storage policy that you want. If you want to select a
different storage policy, click the storage policy box and select the one you want from the list. If the agent supports a system-state subclient, repeat this
step for that subclient. For the DB2 or DB2 DPF iDataAgent, to establish a storage policy for all the log files, click the storage policy in the list provided.
5. Where applicable, if you want to create additional subclients within this backup set/archive set:
{ Click Add.
{ Follow Create a New Subclient procedure.
{ Repeat this step for each additional subclient that you want to define within this backup set/archive set.
{ When all subclients have been added, click OK.
{ A message will advise you to schedule backups for your new backup set. It is recommended that you elect to set a schedule now. You can also
associate this backup set/archive set with an All Agent Types schedule policy (which is automatically created by the system, or can be a user-defined
Data Protection schedule policy). If you have already associated a schedule policy at a previous level (Agent, Client, or Client Computer Group) the
schedules defined in the Schedule Policy will be automatically applied to the new backup set/archive set. See Schedule Policy for more information.
If you want to associate this backup set/archive set with an All Agent Types schedule policy, click Associate with Generic Schedule Policy, and
then select that schedule policy from the drop-down list box. Click OK.
If you have selected to define a schedule for this backup set/archive set:
Click Schedule.
If applicable, from the Backup Options dialog box, select the type of backup that you want to schedule.
If you want to set Advanced Backup/Archive Options, click Advanced.
After selecting the backup type and any advanced options, click OK. The Schedule Details dialog box appears.
From the Schedule Details tab, select the scheduling options that you want to apply, then click OK.
If you don't want to create a backup/archive schedule at this time, click Do Not Schedule, and then click OK.
A content example for NetWare File System is SYS:\public, and an example for NDS content is
OU=prospects.O=engineering.[Root].
When backing up data through third-party command line functions rather than the CommCell Console, the specific storage policy for the backups of the
affected non-Oracle RAC agents is established and maintained through the Creating New Instance screen for the appropriate iDataAgent. For the Oracle RAC
iDataAgent, the storage policy is established when you create the associated pseudo-client or when you modify the pseudo-client instance.
Page 65 of 96
Features - DB2 iDataAgent
1. From the CommCell Browser, right-click the supported server/instance icon, click All Tasks, and then click New Instance.
2. Within the Creating New Instance dialog box, click the Storage Device tab on server/instance properties.
3. From the Command Line Backup tab, select from the list of existing storage policies
1. From the CommCell Browser, if you are creating a RAC pseudo-client, right-click Client Computers, click New Client, click RAC Client in the Add New
Client dialog box, and then click OK. If you are modifying the pseudo-client instance, right-click the instance and then click Properties.
3. From the Command Line Backup tab, select from the list of existing storage policies.
4. Use the other tabs as appropriate to configure the subclient and then click OK to save your settings.
Encryption must be enabled at the client level prior to configuring any instances residing on that client. See Configure the Client for Data Encryption.
1. From the CommCell Console, right-click the instance and click Properties.
2. From the respective Encryption tab, select an option based on the criteria described in the Encryption tab help.
3. Click OK to save your settings and close the properties dialog box.
For third-party Command Line data recovery operations to succeed when using pass-phrase security, you must
export the pass-phrase to the destination client.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon.
{ From the agent level, right-click the agent icon, click All Tasks from the short-cut menu, click New Instance, and go to the next step.
{ From the instance level, right-click the instance icon, click Properties from the short-cut menu, and go to Step 3.
{ From the backup set level, right-click the backup set icon, click Properties from the short-cut menu, and go to Step 4.
2. Use the Creating New Instance dialog box to create and configure the instance. Thereafter, from the General tab, click the Change button associated
with the User Account information. Then go to Step 5.
3. From the General tab of the Instance Properties dialog box, click the Change button associated with the User Account information. Then go to Step 5.
4. From the General tab of the Backup Set Properties dialog box, ensure that the Connect as a Different User option is selected. Then click the Change
button associated with the User Account information.
5. Enter the required information in the Set DB2 User Account dialog box.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon.
{ From the agent level, right-click the agent icon, click All Tasks from the short-cut menu, and click New Instance (Oracle SID).
Page 66 of 96
Features - DB2 iDataAgent
{ From the instance level, right-click the instance icon and click Properties from the short-cut menu.
2. From the General tab, click the Change button associated with the User Account information.
1. From the CommCell Browser, expand the tree if necessary to view the QR agent icon. Then right-click the icon and click Properties.
3. From the Oracle sub-tab, either click Add Instance or select an Oracle instance to edit and then click Edit Instance.
4. From the Add Oracle Instance to QR Agent dialog box, click Change.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon. From the agent level, right-click the agent icon, click All Tasks
from the short-cut menu, click New Instance, and go to the next step. From the instance level, right-click the instance icon, click Properties from the
short-cut menu, and go to Step 3.
2. Use the New Instance dialog box to create and configure the instance.
3. From the General tab of the Instance Properties dialog box, do one of the following, as appropriate.
{ For Informix, type the name of the user account in the INFORMIX USER field.
{ For Oracle or SAP for Oracle, type the name of the user account in the ORACLE USER field.
Back to Top
Page 67 of 96
Features - DB2 iDataAgent
Overview
OVERVIEW
Each DB2 backup set is actually an existing DB2 database. After installing the DB2 iDataAgent, you must create at least one DB2 backup set; however, you can
create the backup set only if a DB2 database exists in the instance. If there is a DB2 database in that instance, you can create a corresponding backup set with
the same name as the database. If not, you cannot create a DB2 backup set. Once you create a DB2 backup set, a default subclient is automatically created.
You can view or change the backup set configuration from the BackupSet Properties dialog box. The following information can be configured.
USER ACCOUNTS
You can change the Windows user account used by the system to access the DB2 database and in effect perform all data protection and recovery operations for
the affected iDataAgent. In effect, you are connecting as a different user.
Page 68 of 96
Features - DB2 iDataAgent
1. From the CommCell Browser, right-click the icon for any supported backup set or archive set that is not currently the default and then click Properties.
2. From the General tab of the Backup Set/Archive Set Properties dialog box, select the appropriate option to Make this the default backup set or Make
this the default archive set.
1. From the CommCell Browser, locate the correct client computer node, right-click the iDataAgent, Agent or instance node (depending on your agent's
functionality) for which you want the backup set/archive set created, select All Tasks and then click Create New Backup Set or Create New Archive
Set.
2. For most agents, from the Create New Backup Set or Create New Archive Set dialog box, enter a New Backup Set Name or New Archive Set
Name (up to 32 characters) of the backup set/archive set that you want to create. For the DB2 or DB2 DPF iDataAgent, from the same dialog box, click
the desired database (backup set) name under Available DB Names and move this name under Selection.
NOTES
{ For DB2 or DB2 DPF, to prevent archive log backup failures, ensure that the name that you select is the actual name of the database and not the alias
name for the database. If the database name and the corresponding alias name are different, both names are displayed under Available DB Names; if
both names are the same, the name that is displayed is the database name. To find out about database names and their aliases, run the following
command as a DB2 or DB2 DPF instance owner on the DB2 or DB2 DPF client: db2 list db directory.
3. Where applicable, if you want to designate this backup set/archive set as the default backup set/archive set, select Make this the Default backup set or
Make this the Default Archive Set; otherwise, leave the check box cleared.
4. For most agents, verify that the storage policy copy associated with the default subclient is the storage policy that you want. If you want to select a
different storage policy, click the storage policy box and select the one you want from the list. If the agent supports a system-state subclient, repeat this
step for that subclient. For the DB2 or DB2 DPF iDataAgent, to establish a storage policy for all the log files, click the storage policy in the list provided.
5. Where applicable, if you want to create additional subclients within this backup set/archive set:
{ Click Add.
{ Follow Create a New Subclient procedure.
{ Repeat this step for each additional subclient that you want to define within this backup set/archive set.
{ When all subclients have been added, click OK.
{ A message will advise you to schedule backups for your new backup set. It is recommended that you elect to set a schedule now. You can also
associate this backup set/archive set with an All Agent Types schedule policy (which is automatically created by the system, or can be a user-defined
Data Protection schedule policy). If you have already associated a schedule policy at a previous level (Agent, Client, or Client Computer Group) the
schedules defined in the Schedule Policy will be automatically applied to the new backup set/archive set. See Schedule Policy for more information.
If you want to associate this backup set/archive set with an All Agent Types schedule policy, click Associate with Generic Schedule Policy, and
then select that schedule policy from the drop-down list box. Click OK.
If you have selected to define a schedule for this backup set/archive set:
Click Schedule.
If applicable, from the Backup Options dialog box, select the type of backup that you want to schedule.
If you want to set Advanced Backup/Archive Options, click Advanced.
After selecting the backup type and any advanced options, click OK. The Schedule Details dialog box appears.
From the Schedule Details tab, select the scheduling options that you want to apply, then click OK.
If you don't want to create a backup/archive schedule at this time, click Do Not Schedule, and then click OK.
A content example for NetWare File System is SYS:\public, and an example for NDS content is
OU=prospects.O=engineering.[Root].
Page 69 of 96
Features - DB2 iDataAgent
iDataAgent database:
1. From the CommCell Browser, right-click the backup set or archive set whose configuration you want to change, and then click Properties from the
shortcut menu.
2. From the General tab, change one or more of the following fields as appropriate for your agent:
{ Backup Set Name - The field accepts 32 characters.
{ Archive Set Name - The field accepts 32 characters.
{ Storage Policy for All Log Files
{ User Account - For the DB2 or DB2 DPF iDataAgent, you can add/modify an application/database user account. See the DB2 iDataAgents section in
User Accounts and Passwords for more information.
{ Make this the default Backup Set - When selected and committed, this option will make this the default backup set on this client computer.
{ Make this the default Archive Set - When selected and committed, this option will make this the default archive set on this client computer.
{ Use Change Journal (Recommended) or Use Classic File Scan which includes (Check archive bit during backups and/or Preserve File Access
Time) settings which determine the way subclients within the backup set conduct incremental and differential backups (For an explanation of this field,
see Setting the Archive Bit Attribute.)
{ Use Data Classification - Specifies that the Data Classification scan is used to determine whether files have been modified for all subclients within the
backup set.
{ Select to have data on compressed volumes decompressed before being sent to the backup media. See Decompress Data before Backup for more
information. (NetWare File System only.)
3. If your agent uses the Backup tab, click Edit Rules for the appropriate subclient type. You can elect to have the system automatically convert the type of
backup under the listed conditions. Click OK to save your backup rules configuration changes. Without setting this option, if one of these conditions exists
your backup will not take place. Subclient Backup Conversion Rules are defined for default subclients and for SQL Server file/file group subclients.
4. Click OK.
z Exchange Mailbox
If you disable the auto-discovery feature, newly created mailboxes will not be backed up unless they are
manually discovered and assigned to a subclient.
1. From the CommCell Browser, right-click the subclient whose associated storage policy you want to change, then click Properties from the shortcut menu.
2. Click the Storage Device tab of the Subclient Properties dialog box.
3. From the Storage Policy list of the Data Storage Policy tab, select a data storage policy to associate with this subclient. If necessary, click the Create
Storage Policy button to create a new storage policy to which the subclient can then be associated.
4. From the Changing a Storage Policy window select the next type of backup operation. Click OK.
5. If applicable for your agent, you can change the number of data streams from the Number of Data/Database Backup Streams field.
6. If applicable for your agent, click the Log Storage Policy tab and select a storage policy to associate with this transaction log subclient from the
Transaction Log Storage Policy list. Also, you can set the Number of Transaction Log Backup Streams from this tab.
7. Click OK to save your changes and close the Subclient Properties Storage Device tab.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon.
{ From the agent level, right-click the agent icon, click All Tasks from the short-cut menu, click New Instance, and go to the next step.
{ From the instance level, right-click the instance icon, click Properties from the short-cut menu, and go to Step 3.
Page 70 of 96
Features - DB2 iDataAgent
{ From the backup set level, right-click the backup set icon, click Properties from the short-cut menu, and go to Step 4.
2. Use the Creating New Instance dialog box to create and configure the instance. Thereafter, from the General tab, click the Change button associated
with the User Account information. Then go to Step 5.
3. From the General tab of the Instance Properties dialog box, click the Change button associated with the User Account information. Then go to Step 5.
4. From the General tab of the Backup Set Properties dialog box, ensure that the Connect as a Different User option is selected. Then click the Change
button associated with the User Account information.
5. Enter the required information in the Set DB2 User Account dialog box.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon.
{ From the agent level, right-click the agent icon, click All Tasks from the short-cut menu, and click New Instance (Oracle SID).
{ From the instance level, right-click the instance icon and click Properties from the short-cut menu.
2. From the General tab, click the Change button associated with the User Account information.
1. From the CommCell Browser, expand the tree if necessary to view the QR agent icon. Then right-click the icon and click Properties.
3. From the Oracle sub-tab, either click Add Instance or select an Oracle instance to edit and then click Edit Instance.
4. From the Add Oracle Instance to QR Agent dialog box, click Change.
1. From the CommCell Browser, expand the tree if necessary to view the desired level icon. From the agent level, right-click the agent icon, click All Tasks
from the short-cut menu, click New Instance, and go to the next step. From the instance level, right-click the instance icon, click Properties from the
short-cut menu, and go to Step 3.
2. Use the New Instance dialog box to create and configure the instance.
3. From the General tab of the Instance Properties dialog box, do one of the following, as appropriate.
{ For Informix, type the name of the user account in the INFORMIX USER field.
{ For Oracle or SAP for Oracle, type the name of the user account in the ORACLE USER field.
1. From the CommCell Browser, expand the tree to view the appropriate level icon for the affected agent.
{ From the agent, instance/partition, or backup set/archive set level, right-click the appropriate icon, click All Tasks, and click New Subclient from the
short-cut menu.
{ From the subclient level, right-click the subclient icon and click Properties from the short-cut menu.
2. From the Subclient Properties dialog box, create and/or configure the subclient as appropriate. Then click the Pre/Post Process tab.
4. From the User Account dialog box, select one of the account options. If you select Impersonate User, type the appropriate user name and password.
Page 71 of 96
Features - DB2 iDataAgent
1. From the CommCell Browser, right-click the icon for the appropriate backup set or archive set and then click Properties.
2. From the General tab of the Backup Set/Archive Set Properties dialog box, type the desired name in the Backup Set or Archive Set field.
3. If you want to make this renamed backup set/archive set the default backup set/archive set, select the corresponding check box (where applicable).
z Each agent that utilizes backup sets/archive sets requires the default backup set/archive set in its configuration; therefore, you cannot delete a default
backup set/archive set using this procedure. If you want to delete a default backup set/archive set, you must uninstall the agent software that contains it.
z The system does not allow you to delete a backup set/archive set if one of its subclients is being backed up/archived. Any attempt to delete a backup
set/archive set under such a condition causes the deletion to fail. If a data protection operation is in progress, do one of the following:
{ Wait for the data protection job to complete.
{ Kill the data Protection job using the Job Manager.
z When you delete a backup set/archive set, several actions occur:
{ The backup set/archive set, its corresponding subclients, and any data that may have been backed up/archived from the backup set/archive set are
logically deleted. Once the backup set/archive set is deleted, you can no longer access the corresponding data for restore/recovery purposes.
{ All job schedules and job histories that pertain to the subclients of the deleted backup set/archive set are deleted.
1. From the CommCell Browser, right-click the user-defined backup set/archive set that you want to delete, select All Tasks and then click Delete.
2. A confirmation message is displayed, asking if you want to delete the backup set/archive set with all of its subclients. Click Yes to continue the deletion, or
click No to cancel the deletion and retain the backup set.
3. If you clicked Yes in the previous step, then the Enter Confirmation Text dialog will appear, indicating that all the data in the backup set/archive set will
be permanently removed. To confirm this action and continue with the deletion, type erase and reuse media in the entry space provided on this dialog.
Click OK. The system will delete the selected backup set/archive node, the subclient nodes contained within it, and remove them from the CommCell
Browser along with any associated data.
1. From the CommCell Browser, right-click the desired file system backup set node, and then click Properties from the shortcut menu.
2. From the General tab, select the Preserve File Access Time option.
Page 72 of 96
Features - DB2 iDataAgent
Subclients - DB2
Topics | How To | Related Topics
Overview
Subclient Content
Configurable Properties
OVERVIEW
The following table shows subclient creation and configuration details specific to the DB2 iDataAgent.
Before you back up data, you must define the data that you want to back up and how this data should be backed up. This is done by creating one or more
subclients for the database(s) that you are backing up. For the DB2 iDataAgent, a subclient defines whether:
z Entire database(s) or only a subset of objects within the database(s) will be backed up
z Data intended for backup will be backed up with the DB2 database online or offline
z Log files should be included in the database backup for online backups
z Prebackup or postbackup processes will be run
Depending on your needs, you can create multiple subclients for backing up an entire database, individual table spaces, multiple table spaces, and log files with
the database either online or offline.
SUBCLIENT CONTENT
The DB2 iDataAgent is designed to back up and restore DB2 databases, which include DB2 database files along with the associated table spaces, history files
and log files. After you install a DB2 iDataAgent, a default subclient is created by the system only after you first create and configure a DB2 instance and then
an associated backup set from the CommCell Console. Since each DB2 backup set is designed to represent a single DB2 database, the default subclient that is
created for a backup set will include the entire DB2 database for that backup set. However, you can use the CommCell Console to create user-defined
subclients to distribute some of the database content by configuring the Subclient Properties (Content) tab. Any content that you do not distribute to the
user-defined subclients will remain in the default subclient. Since multiple DB2 databases can be backed up from the client, you can create multiple backup sets
on the client and therefore multiple user-defined subclients for these backup sets.
When you configure subclient content, you click the Subclient Properties (Content) tab for the subclient to view the eligible data for inclusion in the
subclient content. You then select an option to include either the entire database or one or more table spaces in the database within the subclient content. If
you opt to include just one or more table spaces, you then click the desired table spaces to configure the content for the subclient. Once you do this, the
subclient content may be displayed as follows:
Page 73 of 96
Features - DB2 iDataAgent
In this example, PUBS is the name of the database (and the backup set), and two of the three table spaces in the database (TEMPSPACE1 and USERSPACE1) have
been included in the subclient content.
To include log files in the subclient content, you should ensure that the appropriate option in the Subclient Properties (Backup Arguments) tab is selected
(this is done by default). However, it is recommended that you configure separate user-defined subclients for log file content.
A useful way to distribute subclient content for this iDataAgent is to create separate user-defined sublients for frequently used table spaces and also for log
files. For example, if the SYSCATSPACE and USERSPACE1 table spaces shown above undergo frequent changes, you can create a separate subclient for each
table space. For example:
Content:
SYSCATSPACE
Content:
USERSPACE1
It is recommended that you create a separate user-defined subclient for the DB2 log files on the client. For example:
Content:
Distributing the client data using subclients in this way can help improve backup performance by distributing the workload on the client into logical groupings.
FILTERING
Data protection filtering is not applicable for this agent.
CONSIDERATIONS
For more information, see Things to Consider when Creating and Configuring DB2 Subclients.
CONFIGURABLE PROPERTIES
Once installed, the agent is configured and is therefore able to manage the data or volumes on the client computer. However, you can change certain aspects
of the subclient configuration to manage the data in the manner that best suits your needs.
You can view or change the subclient configuration from the Subclient Properties dialog box. The following information can be configured.
ACTIVITY CONTROL
You can enable or disable all operations for this CommCell object and all objects below it. For more information, see Activity Control.
BACKUP ARGUMENTS
Some database iDataAgents run backups using a system-generated script that is run behind the scenes from a command line. The CommCell Console serves as
a front-end user interface for specifying various backup arguments and parameters that are passed to the backup script that is run. Depending on your agent,
you can specify, for example, the application-specific Backup Level, whether the backups will be online or offline, as well as buffer and bundle sizes, among
other settings. Although the backup arguments/parameters vary among iDataAgents, they all function in a similar manner. These arguments are set at the
subclient level from the respective iDataAgent's Subclient Properties dialog box tab.
BACKUP STREAMS
You can set the number of backup streams. For more information, see Streams.
CONTENT/DATABASES
You can define the content of the subclient. Most agents include a configure button that displays a dialog where you can add or modify the data included as
Page 74 of 96
Features - DB2 iDataAgent
DATA ENCRYPTION
You can enable or disable the encryption of data for transmission over unsecure networks and for storage on media. For more information, see Data Encryption.
DATA PATHS
You can view the data paths associated with the primary storage policy copy of the selected storage policy or incremental storage policy. You can also modify
the data paths for the subclient including their priority. For additional information, see Configuring Alternate Data Paths for Subclients.
PRE/POST PROCESSES
You can add, modify or view Pre/Post processes for the subclient. These are batch files or shell scripts that you can run before or after certain job phases. For
more information, see Pre/Post Processes.
STORAGE POLICIES
You can associate the subclient to a storage policy. For more information, see Storage Policies.
SUBCLIENT NAME
You can rename a user-defined subclient.
USER ACCOUNTS
The following pertains to DB2 on Windows:
You can define an account with permissions to execute Pre/Post commands for the agent's archive, backup, or volume creation jobs.
See DB2 iDataAgent: Other User Accounts in User Accounts and Passwords for more information.
z DB2 has a configuration requirement to indicate whether the database should be online or offline during backups in addition to specifying the subclient
name, content and storage policy association.
z Logs are used to recover database transactions that have been lost due to an operating system or disk failure. This recovery is done by applying the logs to
an online backup. DB2 archives log files once they become full. Because of their importance in recovering data, it is suggested that you create separate
subclients for backing up log files.
z DB2 subclients include one or more table spaces. As databases are added to the table spaces, the subclients are updated automatically. This process is
referred to as an Automatic Subclient Update.
z Caution Against Re-configuring Default Subclient Content
We recommend that you do not re-configure the content of a default subclient because this would disable its capability to serve as "catch-all" entity for client
data. As a result, the likelihood that some data will not get backed up or scanned for archiving would increase.
Back to Top
Page 75 of 96
Features - DB2 iDataAgent
Rename a Subclient
Set the Network Bandwidth and Network Agents for a Data Protection Operation
1. From the CommCell Browser, right-click the subclient whose associated storage policy you want to change, then click Properties from the shortcut menu.
2. Click the Storage Device tab of the Subclient Properties dialog box.
3. From the Storage Policy list of the Data Storage Policy tab, select a data storage policy to associate with this subclient. If necessary, click the Create
Storage Policy button to create a new storage policy to which the subclient can then be associated.
4. From the Changing a Storage Policy window select the next type of backup operation. Click OK.
5. If applicable for your agent, you can change the number of data streams from the Number of Data/Database Backup Streams field.
6. If applicable for your agent, click the Log Storage Policy tab and select a storage policy to associate with this transaction log subclient from the
Transaction Log Storage Policy list. Also, you can set the Number of Transaction Log Backup Streams from this tab.
7. Click OK to save your changes and close the Subclient Properties Storage Device tab.
1. From the CommCell Browser, expand the tree to view the appropriate level icon for the affected agent.
{ From the agent, instance/partition, or backup set/archive set level, right-click the appropriate icon, click All Tasks, and click New Subclient from the
short-cut menu.
{ From the subclient level, right-click the subclient icon and click Properties from the short-cut menu.
2. From the Subclient Properties dialog box, create and/or configure the subclient as appropriate. Then click the Pre/Post Process tab.
4. From the User Account dialog box, select one of the account options. If you select Impersonate User, type the appropriate user name and password.
z We recommend not configuring a pre/post process for a subclient that is currently running a data protection or archive operation.
z Verify that there are no pre/post processes already assigned for the subclient.
Page 76 of 96
Features - DB2 iDataAgent
z Review the Overview and Agent-Specific Guidelines for your agent before configuring pre/post processes for data protection/archive operations.
z Pre-process commands for the iDataAgents will be executed only when the necessary resources (e.g., media, library, drive, etc.) are available.
1. From the CommCell Browser, right-click the subclient for which you want to configure a pre/post process, and then click Properties from the shortcut
menu.
3. For an agent other than the Oracle RAC iDataAgent, click inside the space that corresponds to one of the following phases and type the full path of the
process that you want executed during that phase. Alternatively, click Browse to locate the process (applicable only for paths that do not contain any
spaces). For the Oracle RAC iDataAgent, click Browse for the corresponding process, click the name of the control node client in the Select Client for
Browse dialog box, and click OK. Then browse for and click the process.
{ PreBackup
{ PreScan
{ PreArchive
{ PreCopy
{ PreSnap
{ PostBackup
{ PostScan
{ PostArchive
{ PostCopy
{ PostSnap
Click OK.
4. If you want to run a Post Process for all attempts to run that job phase, then select the corresponding checkbox.
5. For subclients on Windows platforms, if Run As displays Not Selected, or if you want to change the account that has permission to run these commands,
click Change.
a. In the User Account dialog box, select Use Local System Account, or select Impersonate User and enter a user name and password. Click OK.
b. If you selected Local System Account, click OK to the message advising you that commands using this account have rights to access all data on the
client computer.
6. Click OK to save your changes and close the Pre/Post Process tab of the Properties dialog box.
z Subclients - DB2
z Subclients - DB2 DPF
z Subclients - Informix
z Subclients - Oracle
z Subclients - Oracle RAC
z Do not change the backup arguments of a subclient that is being backed up.
z For the DB2 and DB2 DPF iDataAgents, you will need to indicate whether the database should be online or offline during backups.
z Review Performance Tuning - Oracle or Performance Tuning - Oracle RAC for details on setting configuration parameters to optimize backup and restore
operations for your site.
1. From the CommCell Browser, right-click the subclient whose backup arguments you want to configure, then click Properties from the shortcut menu.
2. Click the appropriate tab of the Subclient Properties dialog box for your iDataAgent:
{ DB2, DB2 DPF - (Backup Arguments)
{ Oracle, Oracle RAC - (Backup Arguments)
Page 77 of 96
Features - DB2 iDataAgent
{ Informix (Content)
3. Select the desired backup argument settings that you want configured for this subclient.
z Review Subclients.
z Do not configure the content of a subclient while the parent node or any sibling subclient has a data protection or archive operation currently running on it.
z Exchange Mailbox iDataAgents and Exchange Mailbox/Public Folder Archiver Agents: If you change the contents of the default backup set or archive set then
the auto-discover feature will be disabled. If you disable the auto-discovery feature, newly created mailboxes will not be backed up/archived unless they are
manually discovered and assigned to a subclient.
z NAS NDMP iDataAgents: You must ensure there is no overlap in content between all subclients. Overlap in subclient content will result in loss of data. An
existing subclient's contents are not automatically changed when another subclient is added with overlapping contents.
z SharePoint Server iDataAgent: The Site Content Database, the Site Collection Database, the Site Database, and the Site Index for the virtual server must all
be assigned to the same subclient.
z Lotus Notes Document iDataAgent: Review Assigning Restore View Names to Newly-discovered Databases
z QR Agent: Follow these guidelines when adding a volume to a QR Agent subclient:
{ The volume must correspond to a physical disk or RAID array.
{ A volume created by volume management software other than VxVM is not valid subclient content.
{ Subclients may have overlapping content; however, if two or more subclients overlap, they all must use the same snapshot engine. If the QR policies
associated with the subclients are configured to use different snap engines, they must be reconfigured to use the same snap engine in this scenario.
z Caution Against Re-configuring Default Subclient Content
We recommend that you do not re-configure the content of a default subclient because this would disable its capability to serve as "catch-all" entity for client
data. As a result, the likelihood that some data will not get backed up or scanned for archiving would increase.
1. From the CommCell Browser, right-click the subclient for which you want to configure content, click All Tasks (if applicable) and then click Properties.
Click the drop-down list arrow to display the root volumes on the file server. To change the root volume, click one in the list. If you want to refine
the content path further, use the space to the right of (or below) the root volume list to enter additional path information. Note the following:
For NetApp, the root volume is the mount path of each volume.
Example: for volume FS1 the root volume will be /vol/FS1.
For EMC Celerra, the root volume is the mount point created for a volume.
Example: for volume FS1 with mount point /FS1 the root volume will be /FS1.
For Hitachi, no root volumes are shown in the drop down list. Type the full path of the root volume.
Example: for volume FS1 with mount point /mnt/FS1 the root volume will be /mnt/FS1.
For BlueArc, the root volume is a combination of a descriptor of the path and the volume name.
Example: for volume FS1 with a mount point of / the root volume will be /__VOLUME__/FS1.
Page 78 of 96
Features - DB2 iDataAgent
Optionally, for NetApp NAS NDMP, click Browse to enter the content.
{ For Exchange Mailbox and Exchange Mailbox/Public Folder Archiver Agents follow the procedure to Discover and Assign New Mailboxes or Assign
Mailboxes to Another Subclient.
{ For Lotus Notes Database and Document iDataAgents follow the procedure to Discover and Assign New Databases or Assign Databases to a Subclient.
{ For DB2, DB2 DPF, Exchange Database, Novell GroupWise, SharePoint Server, SQL Server Database, Sybase, and MySQL iDataAgents, click the
Subclient Properties (Content) tab and configure content for the subclient as described below for your agent:
For the DB2 iDataAgent, specify whether you want to include the entire database or a subset of this data as content for the subclient. For the DB2
DPF iDataAgent, specify whether you want to include all the affected database partitions or a subset of this data as content for the subclient.
For Exchange and GroupWise iDataAgents: Click Configure. From the Add/Modify Subclients dialog box click the subclient entry for the database
element/Storage Group that you want to add to the new subclient and select the name of the destination subclient from the list that appears.
Alternatively, you can select and assign a range of databases/storage groups using the Change all selected databases/storage groups to list.
Note that you must have at least one database element/Storage Group assigned to this subclient in order to save the configuration.
A database/Storage Group that is not configured for a subclient does not appear in the list. This can be the case if the subclient containing the
database/Storage Group was deleted. If this happens, click Discover to display all databases/Storage Groups.
For the SharePoint Server iDataAgent, follow the procedure to Discover and Assign New Data Types.
For the Sybase iDataAgent, follow the procedure to Manually Discover Databases.
For the MySQL iDataAgent, follow the procedure to Configure MySQL Databases.
{ For the Informix iDataAgent, click the Subclient Properties (Content) tab and define the contents of the subclient. Specifically, establish the backup
mode for the data to be backed up, set the backup level, and decide whether to back up the emergency boot file and/or the ONCONFIG file.
{ For the Oracle, SAP for Oracle, or Oracle RAC iDataAgent, click the Subclient Properties (Content) tab and define the contents of the subclient. To
configure this subclient for specialized types of backups, follow the appropriate procedure below:
Create Subclient for Backing Up Archived Redo Log Files
Create Subclient for Backing Up Offline Databases
Create Subclient for Backing Up Online Databases
Create Subclient for Performing Selective Online Full Backups
{ For SAN iDataAgents, click the Subclient Properties (Content) tab and configure content for the subclient as described below for your agent:
Image Level on Unix iDataAgent: Click Add. From the Add Content Path dialog box, select the volume(s) that you want to back up (use CTRL + click
to select multiple volumes). Click OK. The selected volumes are added to the Contents of subclient list. These volumes are automatically
configured to be CXBF devices. Alternatively, use Volume Explorer per specific scenarios to configure CXBF devices.
To configure an unmounted block device or raw device as content, first use Volume Explorer to configure the device as a CXBF device. Then select
the configured CXBF device as subclient content. You can ignore the warning that is displayed.
For more information, see When to Use Volume Explorer. For a step-by-step procedure, see Configure a CXBF Device in Volume Explorer.
Image Level and Image Level ProxyHost on Windows iDataAgents: Click Add. Then in the Add Content dialog box, type the full path of the volume
or mount point that you want to include as subclient content, then click Add. Optionally, click Browse to select the content. Click OK. The volume
or mount point is added to the Contents of subclient list. Add additional content by repeating this step.
ProxyHost iDataAgent: Select a backup host from the Backup Host list. This is the computer to which the BCV is connected. Click Add. In the
Content field of the Add/Edit Content for Subclient dialog box, type the primary host path of the content that you want to back up, or click Browse
to find and select this data. In the Backup Host BCV Path field of the Add/Edit Content for Subclient dialog box, type the path through which the
backup host accesses this data on the BCV, or click Browse to find and select this path. Click OK. The primary host data path and corresponding
backup host BCV path are added as a single entry in the Contents of subclient list. To add additional entries, repeat these steps. Refer to Notes
below for more information.
{ For Quick Recovery Agents, click the Subclient Properties (Content) tab and configure the following options:
Click Add Volume. From the Adding Volume dialog box, select volume(s) that you want to add to the subclient content (use CTRL + click to select
multiple volumes). You can add/edit additional advanced options for the selected volume by select Advanced on the Adding Volume dialog box.
Click OK.
Click Add App to select an application and associated volumes. Click OK.
Any instances you intend to protect and recover with the QR Agent must be configured in the QR Agent properties Authentication tab. They will not
appear in the Add App dialog box if they are not configured. Only volumes containing datafiles and archive log files will be detected by Add App.
Volumes containing control files and redo log files will not be detected.
For a clustered Exchange Server, if you are not using VSS to perform an online quiesce, sufficient permissions are required in order to be able to
perform an offline quiesce; in such cases, ensure that the User Name specified has Exchange Administrator rights.
NOTES
Page 79 of 96
Features - DB2 iDataAgent
z Content examples for NetWare are OU=prospects.O=engineering.[Root], (for NDS content), and SYS:\public (for File System content).
z Content examples for adding an NFS-mounted file system to subclient content of a Unix File System iDataAgent:
{ /mountpointA to include the entire file system at mountpointA
{ /mountpointA/projects for only the projects directory within the file system at mountpointA.
z Informix subclients include one or more dbspaces. As databases are added to the dbspaces, the subclients are updated automatically.
z Exchange Mailbox iDataAgents and Exchange Mailbox/Public Folder Archiver Agents: Initially, all unconfigured mailboxes are assigned to the default
subclient. You can create a new subclient and reassign mailboxes to this new subclient (within the same backup set/archive set). Once assigned, the
mailboxes become part of the content of the new subclient.
z SharePoint Server iDataAgent: Initially, all unconfigured data types are assigned to the default subclient. You can create a new subclient and reassign data
types to this new subclient. Once assigned, they become part of the content of the new subclient.
z ProxyHost iDataAgent: The primary host data path is backed up by the subclient and is the path through which the backup host accesses this data on the
BCV. A primary host path and its corresponding backup host path are listed in the following format:
For example, assume that you want to back up the D:\data directory from your primary host and D:\ is mirrored by a BCV, which is mapped to the backup
host as F:\. Consequently, the path to this data on the backup host is F:\data. When you add this directory to a subclient, it is listed in the Contents of
subclient pane as D:\data --> F:\data.
The primary host path in the Content field is used for browse and restore purposes. However, it is the data in the
Backup Host BCV Path which is actually backed up. If these two paths do not accurately correspond, the path that
appears when data is browsed for restore does not accurately reflect the data that will be restored. In the example
given above, assume that D:\data is entered in the Content field, while F:\data1 is accidentally entered in the
Backup Host BCV Path. If you browse and select D:\data to be restored, it is actually D:\data1 that is restored.
(Remember, F:\Data1 is the path on the backup host that corresponds to D:\data1 on the primary host.)
z Encryption must be enabled at the client level prior to configuring any subclients residing on that client. See Configure the Client for Data Encryption.
z If you are attempting to configure for third-party Command Line operations, do not use this procedure. See Configure Third-party Command Line Operations
for Encryption.
1. From the CommCell Console, right-click the subclient and click Properties.
2. From the Subclient Properties (Encryption) tab, select an option based on the criteria described in the Encryption tab help.
z Review Subclients.
z Do not create a subclient while the parent node or any sibling subclient has a data protection or archive operation currently running on it.
z In cases where a new subclient is created with the same name as a deleted subclient, the system will append a Unix time stamp to the deleted subclient's
name in data protection job history reports and views to distinguish the two subclients. For example, subclientname_1104257351.
z Informix iDataAgents: If you will be using the Informix ONBAR utility to create backup and restore scripts, you need not create subclients. Otherwise, if you
will be using the CommCell Console to back up and restore Informix database objects (subsets/dbspaces), then you will need to create a subclient.
z ProxyHost iDataAgents: If you are using a BCV, you must prepare a batch file or a shell script file on the backup host containing commands to synchronize
and split the BCV. The Resource Pack includes information on configurations for these batch files or shell scripts, as well as examples that apply to specific
applications and hardware (e.g., Exchange databases in an EMC Symmetrix environment). See Resource Pack for more information on the Resource Pack.
The ProxyHost iDataAgent also requires that you set permissions for the batch/shell script file on the backup host.
z SQL Server Database iDataAgents: When running on Windows Server 2003 and VSS is enabled, the New Subclient command is not available.
Page 80 of 96
Features - DB2 iDataAgent
z PostgreSQL iDataAgents: Once you configure the PostgreSQL instance, the system automatically generates the default backup sets and default subclients.
However, you can use the CommCell Console to create user-defined subclients for dump backup sets to distribute some of the database content. You cannot
create user-defined subclients for FS backup sets.
1. From the CommCell Browser, right-click the node (agent/backup set/archive set/instance) for which you want to create a new subclient, click All Tasks (if
applicable), and then simply click New Subclient for most agents.
{ For the SQL Server iDataAgent, expand New Subclient and click either Database to include individual databases or File/File Group to include
database elements.
2. Click the General tab or General (Quick Recovery Agent) tab of the Subclient Properties dialog box and type the name (up to 32 characters) of the
subclient that you want to create.
{ For supported agents identified in Support Information - Snapshot Engines, you can select a QSnap option to snap data and then perform a data
protection operation on the data.
{ For Image Level on Unix and Image Level ProxyHost on Unix, use the Incremental Support Using field to configure either a CXBF subclient or a
checksum subclient and to enable incremental support for either subclient type.
{ For QR Agents, you must also select a QR Policy from the QR Policy list.
{ For the Windows iDataAgents that support VSS, you can optionally Enable VSS on a Subclient.
3. Select other options from the General tab as appropriate for the agent.
4. Click the Content or Databases tab of the Subclient Properties dialog box and Configure Subclient Content as appropriate for your agent.
5. For all agents (except QR), click the Storage Device (Data Storage Policy) tab of the Subclient Properties dialog box, then select a data storage policy to
associate with this subclient from the storage policy list.
{ For the DB2 and DB2 DPF iDataAgents, you can also change the number of data backup streams. For the DB2 DPF iDataAgent, the default stream
threshold should be equal to the total number of database partitions for the subclient.
{ For SQL Server iDataAgents, you can also click the Storage Device (Log Storage Policy) tab of the Subclient Properties dialog box, then select a log
storage policy to associate with this subclient from the storage policy list and select the number of backup streams for transaction log backup jobs.
{ For 1-Touch for Unix, it is strongly recommended that the storage policy that you select for the subclient configured for 1-Touch use a MediaAgent on a
different computer. If you do this, and if the system crashes, the media will not have to be exported to another MediaAgent in order to recover the
system.
6. For Oracle and DB2 iDataAgents, click the Backup Arguments (Oracle) or Backup Arguments (DB2, DB2 DPF) tab of the Subclient Properties dialog box
and Configure Backup Arguments as appropriate for your agent. Note that the backup arguments for Informix are located on the Content tab.
7. For Migration Archiver Agents, click the Archiving Rules or Rules tab of the Subclient Properties dialog box and configure archiving rules as appropriate
for your agent. In order to perform rules-based migration archiving operations, the Disable All Rules checkbox must be cleared.
If the File Archiver for Windows supports Data Classification, several filter-like configuration fields are defined as archiving rules and are available from the
Subclient Properties (Rules) tab. If you want to define content and archiving rules based on file attributes other than volumes, size, and modified time
(i.e., if you want to customize your rules), click the Advanced tab and configure as appropriate. Also, stub management options can be configured from
the Stub Rule tab. See Configure Archiving Rules - File Archiver Agents for step-by-step instructions.
8. For ProxyHost and Image Level ProxyHost iDataAgents, click the Pre/Post Process tab of the Subclient Properties dialog box. In the PreScan field, type the
path to the batch file/shell script file that contains those commands that are to run before each backup of the subclient, or click Browse to locate and
select this file. For ProxyHost and Image Level ProxyHost, the file must reside on the backup host or primary host.
10. Click OK to save the subclient configuration. For QR Agents, this procedure is now complete. For all other agents, continue on to the next step.
11. The Backup Schedule dialog box advises you to schedule data protection operations for your new subclient. It is recommended you elect to set a schedule
now. You can also associate this subclient with an All Agent Types schedule policy (which is automatically created by the system, or can be a user defined
Data Protection schedule policy). If you have already associated a schedule policy at a previous level (Backup Set/Instance, Agent, Client, or Client
Page 81 of 96
Features - DB2 iDataAgent
Computer Group) the schedules defined in the Schedule Policy will be automatically applied to the new subclient. See Schedule Policy for more
information.
{ If you want to associate this subclient with an All Agent Types schedule policy, click Associate with Generic Schedule Policy, and then select that
schedule policy from the drop-down list box. Click OK.
{ If you want to associate this subclient with a specific schedule policy, click Associate to schedule policy, and then select the schedule policy from the
drop-down list box. Click OK.
{ If you have selected to define a schedule for this subclient:
Click Schedule.
From the Backup/Archive Options dialog box, select the type of data protection operation that you want to schedule.
If you want to set Advanced Backup/Archive Options, click Advanced.
After selecting the data protection type and any advanced options, click OK. The Schedule Details dialog box appears.
From the Schedule Details tab, select the scheduling options that you want to apply, then click OK.
{ If you don't want to create a data protection schedule at this time, click Do Not Schedule, and then click OK.
-defined subclient:
1. From the CommCell Browser, right-click the user-defined subclient that you want to delete, and then click Delete from the shortcut menu.
Level Capability
CommCell Administrative Management with CommCell level association
Client Computer Group Administrative Management with Client Computer Group level association
Client Agent Management with Client level association
Agent Agent Management with Agent level association
Subclient Agent Management with Subclient level association
1. From the CommCell Browser, right-click the CommServe, client computer group, client computer, agent, or subclient, and then click Properties from the
short-cut menu.
2. From the Activity Control tab of the associated Properties dialog box, select or clear option(s), as desired.
3. Click OK.
Disabled data management and/or data recovery operations are displayed with client and/or agent icon changes in the
CommCell Browser. For a comprehensive list of all icons in the CommCell Console, see CommCell Console Icons.
Page 82 of 96
Features - DB2 iDataAgent
z Do not enable/disable software compression for a subclient that is being backed up/archived.
1. From the CommCell Browser, right-click the subclient for which you wish to enable software compression and then click Properties.
2. Click the Storage Device tab and from the Data Storage Policy tab, select the storage policy from the Storage Policy list.
If applicable for the selected agent, click the Log Storage Policy tab and select a storage policy from the Transaction Log Storage Policy list.
3. Then click the Storage Device (Data Transfer Option) tab and choose the appropriate compression option for this subclient.
z We recommend not removing a pre/post process for a subclient that is currently running a data protection or archive operation.
z Review the Overview and Agent-Specific Guidelines for your agent before removing pre/post processes for data protection/archive operations.
1. From the CommCell Browser, right-click the subclient for which you want to remove a pre/post process, and then click Properties from the shortcut
menu.
2. Click the Pre/Post Process tab of the Subclient Properties dialog box.
3. Click the text inside the space that corresponds to one of the following phases for which you want a pre/post process removed, then press the Delete key:
{ PreScan
{ PreArchive
{ PreCopy
{ PreSnap
{ PostBackup
{ PostScan
{ PostArchive
{ PostCopy
{ PostSnap
4. Repeat Step 3 for any additional processes that you want to remove.
5. Click OK.
RENAME A SUBCLIENT
Before You Begin
z You can rename a subclient at any time. However, we recommend that you don't rename a subclient while a data protection or archive operation is running
on that subclient.
z In cases where a subclient is renamed using the same name as a deleted subclient, the system will append a Unix time stamp to the deleted subclient's
name in data protection job history reports and views to distinguish the two subclients. For example, subclientname_1104257351.
1. From the CommCell Browser, right-click the subclient that you want to rename, and then click Properties from the shortcut menu.
2. From the Subclient Properties (General) tab, or the QR Agent Subclient Properties (General) tab, type the new name in the Subclient Name field, and
then click OK.
Page 83 of 96
Features - DB2 iDataAgent
The CommCell Browser updates the subclient with its new name. The new name will also be reflected in any associated schedules and reports.
SET THE NETWORK BANDWIDTH AND NETWORK AGENTS FOR A DATA PROTECTION OPERATION
Before you Begin
z Do not modify the network bandwidth and network agents for a subclient or instance that is being backed up.
1. From the CommCell Browser, right-click a subclient and then click Properties.
For the DB2, DB2 DPF, Informix, Oracle, Oracle RAC, SAP, or Sybase iDataAgent, right-click an instance and then click Properties.
{ To control network bandwidth settings, use the Throttle Network Bandwidth section in the General tab of the Subclient Properties dialog box.
{ To control the number of network agents, you must create a nQRNetworkAgents registry key.
3. Enter a number of Network Agents that must be used to perform data protection operations on the subclient/instance.
4. Click the Throttle Network Bandwidth (MB/HR) option and then enter the throughput as needed. Note that throttling is done on a per Network Agent
basis.
1. From the CommCell Browser, right-click the subclient whose data paths you want to view, then click Properties from the shortcut menu.
2. Click the Storage Device tab of the Subclient Properties dialog box.
3. From the Data [or Logs] Storage Policy tab, click Show Data Paths to view the data paths used by the subclient to access the storage media for data
protection operations. Click Close to exit the Data Paths dialog box.
1. From the CommCell Browser, right-click the subclient whose content you want to view, then click Properties.
2. From the Subclient Properties dialog box, click the Content tab (or Databases tab for Lotus Notes) to view the contents of the subclient.
Back To Top
Page 84 of 96
Features - DB2 iDataAgent
Overview
Supported Features
OVERVIEW
You can view the backup and restore history of iDataAgents, BackupSets/Instances, and subclients.
The Backup Job History Filter dialog box allows you view detailed, historical information about backup jobs. Once you have chosen your filter options, they
are displayed in the Backup Job History window.
For information on Job Details displayed in the Job History, see Viewing Job Information.
z Browse the data backed up by the backup set or instance from the Backup Job History window. This is provided as right-click option for each job. (This
menu option, when selected, initiates the Browse Options dialog box preset with the values needed to browse the data.)
z Browse the snapshots created during SnapProtect backup
z View items that failed during the backup job
z View details of the backup job
z View files that were not indexed during a backup job that performed content indexing
z View associated media
z View events of the backup job
z View a list of items that were backed up
z View a list of items that were moved to media for a SnapProtect backup job
z View the log files of the backup job.
z View the RMAN log of an Oracle backup job.
z View the BRTools log of a SAP for Oracle job. You can view the BRTools log for only those jobs that were initiated from the CommCell Console.
From these windows you can conduct searches based on a particular string, allowing to find particular files quickly and easily.
It is not recommended that this option is used to view a very large list of items that were backed up (such as lists that
total over 100,000 items). It is suggested that the Browse option is used to find a list of backed up items in such cases.
See View the Items That Were Protected During a Data Protection Operation for step-by-step instructions.
Filters can be used in conjunction with the "Items That Failed" list on the data protection Job History Report to eliminate backup or archive failures by excluding
items which consistently fail that are not integral to the operation of the system or applications. Some items fail because they are locked by the operating
system or application and cannot be opened at the time of the data protection operation. This often occurs with certain system-related files and database
Page 85 of 96
Features - DB2 iDataAgent
application files.
Also, keep in mind that you will need to run a full backup after adding failed files to the filter in order to remove them.
A listing of files and folders that failed is not available for the Quick Recovery Agent, or the Image Level and Image
Level ProxyHost iDataAgents. These agents do not perform a file level backup/copy.
Certain application related files can never be backed up by the File System iDataAgent due to the nature of the
data. For example, Microsoft SQL Server database files cannot be backed up by the File System iDataAgent. In this
and other similar circumstances, consider entering files such as these as exclusions in the corresponding subclient
filter.
See View the Items That Failed For a Data Protection Operation for step-by-step instructions.
If you have installed the SQL Server iDataAgent, do not use the stored procedure sp_delete_backuphistory,
sp_delete_database_backuphistory and sp_delete_backup_and_restore_history provided by Microsoft clean up
backup history. By default backup history is automatically pruned from the CommServe database and the Microsoft SQL
Server, as necessary.
SUPPORTED FEATURES
z NAS iDataAgents do not support the ability to view items that failed.
z The Image Level and Image Level ProxyHost iDataAgents do not support the ability to Browse the data of a selected backup job in Backup Job History.
Files that were not indexed, (perhaps because the file’s content could not be read) are added to the Content Indexing Failures list, and are viewable from the
View Content Index (Failed Items) option in the Job History window. For step-by-step instruction, see View the Items that Failed to Content Index.
Back to Top
View the Items That Were Protected During a Data Protection Operation
View the Items that were Moved to Media during SnapProtect Backup
Page 86 of 96
Features - DB2 iDataAgent
View the Items that Were Not Indexed During Content Indexing
1. From the CommCell Browser, right-click the entity (client computer, iDataAgent, backup set or subclient) whose backup history you want to view, click
View, and then click View Backup History.
2. From the Backup History filter window select the filter options, if any, that you want to apply, and then click OK. The system displays the Backup Job
History window.
3. Click OK.
VIEW THE ITEMS THAT WERE PROTECTED DURING A DATA PROTECTION OPERATION
This option is available for File System-like agents.
1. From the CommCell Browser, right-click the entity whose history of data protection operations you want to view, click View, and then click the necessary
options to view a job history.
2. From the Job History Filter dialog box, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the operation whose list of protected items you want to view, and then select View backup file list/View
Backed Up Messages. The Backup file List window displays a list of the backed up files/messages that were included in the backup job. You can use
the Search option to find items in the window.
1. From the CommCell Browser, right-click the entity whose history of data protection operations you want to view, click View, and then click to view a job
history.
2. From the Job History Filter dialog box, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the operation whose list of failed items you want to view, and then select View Failed Items. The Unsuccessful
Backup Files window (for DataArchiver Agents, Items On Which Archive Failed) displays those items that failed. If no items failed, a message to that
effect is displayed.
4. Click Close.
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job history you want to view, click View, and then click
job history.
2. From the Job History Filter dialog box, select the filter options that you want to apply and click OK.
Page 87 of 96
Features - DB2 iDataAgent
3. From the Data Management Job History window, right-click the job whose job details you want to view, and then click View Job Details.
4. The Job Details dialog box appears, displaying detailed job history in General, Details, Phase Details and Attempts tabs for the selected job.
5. Click OK.
If viewing the details of a job with a pending or failed status, the Reason for Job Delay field will contain an Error
Code, which, if clicked, will launch the customer support website displaying troubleshooting article(s) related to the
specific issue.
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job history you want to view, click View, and then select
the appropriate history.
2. From the Job History window select the filter options, if any, that you want to apply, and then click OK.
3. From the job history widow, right-click the backup whose media or mount paths you want to view, and then click View Media.
4. The Media Used By Job ID window displays a list of media or mount paths used by the operation.
5. Click OK.
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job history you want to view, click View, and then click
Job History.
2. From the Job History Filter dialog box, select the filter options that you want to apply and click OK.
3. From the Data Management Job History window, right-click the job whose job details you want to view, and then click View Events.
4. The All Found Events window gets displayed. If no events where found for the back up, a message is displayed to that effect.
5. Click Close.
VIEW THE ITEMS THAT WERE MOVED TO MEDIA DURING SNAPPROTECT BACKUP
This option is available for the SnapProtect Backup.
1. From the CommCell Browser, right-click the entity whose history of data protection operations you want to view, click View, and then click the necessary
options to view a job history.
2. From the Job History Filter dialog box, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the operation whose list of items moved to media you want to view, and then select View Backup Copy file
listing. The Backup file List window displays a list of the backed up files that were included in the backup copy job. You can use the Search option to
find items in the window.
z To view the files moved to media for a backup copy job, right-click the SnapProtect backup job corresponding to the
Backup Copy job and select View Backup Copy file listing.
z View backup items will not display anything for a Backup Copy job.
Page 88 of 96
Features - DB2 iDataAgent
1. From the CommCell Browser, right-click the entity whose job history you want to view, and then click to view a job history.
2. From the job history filter window select the filter options, if any, that you want to apply, and then click OK.
3. From the job history window, right-click the job whose log files you want to view, and then click View Logs.
4. The contents of the log file related to the selected job history are displayed in the Log File for Job n window.
1. From the CommCell Browser, right-click the entity whose operations you want to view, click View, and then click the necessary options to view a job
history.
2. From the Job History Filter dialog box, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the job for which you want to view the successfully content indexed items, select View Content Index, and click
Successful Items.
4. Click Close.
1. From the CommCell Browser, right-click the entity whose operations you want to view, click View, and then click the necessary options to view a job
history.
2. From the Job History Filter dialog box, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the job for which you want to view the list of items failed to content index, select View Content Index, and click
Failed Items.
4. Click Close.
1. From the CommCell Browser, right-click the subclient whose backup history you want
to view, click View, and then click View Backup History.
Additionally, you can view the backup history for a client computer, iDataAgent, or
backup set . However, the dialogs displayed may be different.
Note, if viewing the backup history for a client computer, right-click the comptuer
name and select Job History.
2. From the Backup History filter window select the filter options, if any, that you want
to apply, and then click OK. The system displays the Backup Job History window.
Note: If viewing the job history for a client computer, ensure that the Backup radio
button is selected.
Page 89 of 96
Features - DB2 iDataAgent
3. The Backup Job History window displays with the specified filter options.
5. From the Backup Options dialog box, select the job options appropriate for the job
you want to restart.
6. If you need to run the backup operation immediately, select Immediate from the
Job Initiation tab. Go to step 11.
7. If you need to schedule the restore operation, select Schedule from the Job Initiation
tab and click Configure.
8. From the Schedule Details dialog box that appears, select the appropriate
scheduling options.
Click Options to view the Advanced Schedule Options dialog box.
Page 90 of 96
Features - DB2 iDataAgent
z Repeat: Select the value for which you want to run the job repeatedly on the day
in which the job is scheduled to run.
z Time Zone: Select a specific time zone from which the job schedule time will be
based.
Click OK to close the Advanced Schedule Options dialog box.
Back to Top
Page 91 of 96
Features - DB2 iDataAgent
Overview
Supported Features
OVERVIEW
The Restore History Filter dialog box allows you to view detailed, historical information about restore jobs.
For information on Job Details displayed in the Job History, see Viewing Job Information.
Once you have chosen your filter options, they are displayed in the Restore Job History window. From this window you can right-click a restore job to:
z View Restore Items; items in the job that were Successful, Failed, Skipped or All. These items, if any, will be listed in the Restored Files window.
z View Job Details of the restore job. The job details will be listed in the Job Details window.
z View Events of the restore job. The job events will be listed in the All Found Events window.
z View Log files of the restore job. The job log files will be listed in the Log File window.
z View the RMAN Log of an Oracle restore job. The RMAN Log will be listed in the Oracle Restore Log window.
z View the BRTools log of a SAP for Oracle restore job. You can view the BRTools log for only those jobs that were initiated from the CommCell Console.
Successfully restored files will be listed with RESTORED appended to the file path. If files are not restored/recovered due to errors, the file paths will be
appended with FAILED. Under some circumstances, the system may not restore/recover certain files because they are older versions of the same files already
present in the files system; these files are appended with the word OLDER.
SUPPORTED FEATURES
Consider the following.
z NAS iDataAgents do not support the ability to view failed/successful item lists.
z Restore Job History will not display Oracle rman_util jobs at the instance level.
Back to Top
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job restore history you want to view, click View, and then
click Restore History.
Page 92 of 96
Features - DB2 iDataAgent
2. From the Job History filter window, select the filter options, if any, that you want to apply, and then click OK.
3. From the Job History window, right-click the job whose restored items you want to view; click View Restore Items, and select from the type of items to
view: Successful, Failed, Skipped or All.
4. The Restored Files window will display the selected type of restored items for the job.
5. Click OK.
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job history you want to view, click View, and then click
Job History.
2. From the Job History Filter dialog box, select the filter options that you want to apply and click OK.
3. From the Data Management Job History window, right-click the job whose job details you want to view, and then click View Events.
4. The All Found Events window gets displayed. If no events where found for the back up, a message is displayed to that effect.
5. Click Close.
1. From the CommCell Browser, right-click the entity (e.g., subclient, client computer, etc.) whose job history you want to view, click View, and then select
the appropriate history.
2. From the Job History window select the filter options, if any, that you want to apply, and then click OK.
3. From the job history widow, right-click the backup whose media or mount paths you want to view, and then click View Media.
4. The Media Used By Job ID window displays a list of media or mount paths used by the operation.
5. Click OK.
1. From the CommCell Browser, right-click the entity whose job history you want to view, and then click to view a job history.
2. From the job history filter window select the filter options, if any, that you want to apply, and then click OK.
3. From the job history window, right-click the job whose log files you want to view, and then click View Logs.
4. The contents of the log file related to the selected job history are displayed in the Log File for Job n window.
Back to Top
Page 93 of 96
Features - DB2 iDataAgent
WHAT DATABASE PARAMETERS DO YOU NEED TO CONFIGURE TO MANAGE DB2 ARCHIVE LOGS?
You need to configure the LOGARCHMETH1 and LOGARCHOPT1 parameters to manage DB2 Archive Logs using Calypso VENDOR Library interface.
b. By default, Calypso archives the logs in ARCHIVE_PATH specified during Calypso installation.
c. The logs will be moved to media when Logs backup is scheduled from CommCell console or when the number of Logs in Archive Path exceed the
configured threshold.
It is possible to backup the logs directly to the media without copying to archive log path. You need to set sDb2ThresholdALFN registry key to 1.
CAN I PERFORM DB2 DATABASE BACKUPS AS A USER WITH NO OPERATING SYSTEM PASSWORD?
Yes. Update-46055(db2PasswordLessUser) provided with the service pack 11a allows you to successfully perform your DB2 database backups as a password
less Operating System user. However, this Update is applicable only for Unix based DB2 backups.
WHY DO WE SEE LOG RESTORE JOBS DURING ONLINE DATABASE FULL BACKUP?
z DB2 includes all transaction logs that are required to make the full Backup image consistent into the same backup image. If transaction is spread across
many logs and the logs are already archived to media, DB2 sends a request to restore them to storage manager. We could see all the restore jobs during
Online FULL backup due to this reason.
z Use db2pd to determine what transaction is holding up the log.
z You should also review MAX_LOG and NUM_LOG_SPAN parametres and set correct value to prevent this from occurring
WHEN DO I HAVE TO TAKE A FULL OFFLINE BACKUP FOR SUCCESSFUL DATA PROTECTION OPERATIONS USING
CALYPSO?
When a database is in a roll forward recovery mode for the first time (i.e., when the LOGARCHMETH1 parameter value is set to either LOGRETAIN, USEREXIT,
Page 94 of 96
Features - DB2 iDataAgent
DISK, TSM, or VENDOR), perform a full offline backup for the database. In case of a HADR setup, perform the full offline backup on the primary database.
qoperation execscript -sn QS_querydb2backup -si '<Clientname>' -si '<InstanceName>' -si '<DB2DatabaseName>' -si '<DATA>'
QScript[QS_querydb2backup] CS[CSName] DB[CommServ] SP[QS_querydb2backup]
Qscript Output:
qoperation execscript -sn QS_querydb2backup -si '<Clientname>' -si '<InstanceName>' -si '<DB2DatabaseName>' -si '<LOGS>'
QScript[QS_querydb2backup] CS[CSName] DB[CommServ] SP[QS_querydb2backup]
Qscript Output:
You need to execute the parameters in same sequence as mentioned in the above commands.
CAN WE PROTECT DATA ON NON-GLOBAL ZONES IF THE FILE SYSTEM IDATAAGENT IS INSTALLED ONLY ON THE
GLOBAL ZONE?
Yes. We can protect file system data on non-global zones if the File System iDataAgent is installed only on the global zone. However, in order to enable
consistent backups of application specific data on the non-global zones, you will need to install the corresponding application specific iDataAgent on the non-
global zone.
HOW ARE COMMAND LINE BACKUP IMAGES DISPLAYED IN THE COMMCELL CONSOLE?
When you run DB2 command line offline/online backup jobs, the backup image is always displayed as online in the CommCell Console.
WHAT ARE THE FOLDERS/FILES CREATED AND CHANGES DONE DURING INSTALL OF THIS AGENT?
WHAT DO I DO WHEN MY DB2 V10 ONLINE GUI BACKUP FAILS BECAUSE THE SPECIFIED DB2 CONFIGURATION
PARAMETER IS DISCONTINUED?
Page 95 of 96
Features - DB2 iDataAgent
If you upgraded DB2 V9 to V10 or are using DB2 V10 in R90 with Service Pack 8 or lower, you need to install Service Pack 9.
In DB2 V10 and higher, database configurations parameters (LOGRETAIN & USEREXIT) have been replaced with LOGARCHMETH1. You need to install SP9 in
order to support DB2 V10 and higher.
CAN WE USE USER EXIT METHOD INSTEAD OF LOGARCHMETH1 VENDOR METHOD TO BACKUP DB2 LOG FILES?
Yes. You can use use USER EXIT method instead of LOGARCHMETH1 Vendor method to backup DB2 log files. However, this method is not commonly used and
hence is deprecated.
1. From the DB2 Console, type the command to set the USEREXIT parameter. db2 update database configuration for <database
name> using USEREXIT on
Page 96 of 96