Use this preinstallation checklist to prepare the computer where you will install the DB2 Agent and to gather all the information that you will need during the installation.
Verify System Requirements
Verify that the computer where you will install the agent satisfies the minimum requirements. For more information, see System Requirements.
Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell environment has the required licenses to use the DB2 Agent. For more information, see License Requirements.
Determine the Installation Location
Based on your environment, install the DB2 Agent on an appropriate computer.
Environment |
Where to install the software |
---|---|
Non-clustered |
On the computer where the DB2 server resides |
Clustered |
On the physical nodes of the cluster where the DB2 server resides Note that cluster installations are not supported on FreeBSD and Macintosh computers. |
Gather Installation Data
Gather and record the information that you will need during the installation.
You can install the DB2 Agent using either the CommCell Console or the installation package created by the Download Manager. Any item that applies to only one of these installation methods is noted.
Commvault Package to Install
-
For installations using the CommCell Console, install the DB2 package, which is under the Database category.
-
For installations using the installation package, install the DB2 package.
Note
The File System Core package and the File System package are automatically installed with the package that you selected. The File System Agent is not displayed in the CommCell Console and does not consume any licenses.
To configure the File System Agent on your client, right-click the client computer, point to All Tasks, and then click Create File System Agent. The File System Agent will consume a license, and you can back up the file system content on your client computer.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the Windows File System Agent.
Client Computer Details
If the File System Agent or another package is already installed on the computer, you are not required to gather all the computer details again. The level of detail depends on how the package you selected is installed, as follows:
-
For installations using the CommCell Console, the installation program requests only the name of the client computer.
-
For installations using the installation package, the installation program reads the details from the previous installation.
Restart the DB2 Services
DB2 services must be restarted after the installation as follows:
-
For installations using the CommCell Console, select the Restart Oracle/DB2 Service (if applicable. Oracle DB2 instance needs to be restarted to load Commvault media library for Data Protection) option.
-
For installations using the installation package, select the Process Manager option.
Destination Folder for the DB2 Archive Path
When you install the DB2 Agent, you specify a DB2 archive log path.
The Commvault software stores DB2 archive logs in this staging path to avoid a log backup job for each log archival request. When you determine the DB2 archive path size, consider the on-demand log backup threshold.
You can change the threshold. Set the additional setting to the size of the archive logs (in MB) that are in the archive log directory that triggers the Commvault software to automatically start a command line log backup, and then remove the archive logs from the archive log path. The default is 10000 MB. For more information, see Modifying the Threshold for DB2 Log File Backups
The Archive Log path is the disk location that the software uses for DB2 log archiving. The is the location where the software archives the online logs.
For more information on the DB2 archive log path, see How the Commvault Software Works with the DB2 Archive Log Path.
Note
If you install the software in a clustered environment, the DB2 archive path must reside on a shared drive. The DB2 archive path cannot reside on a temporary location. If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.
Destination Folder for the DB2 Retrieve Path
Determine the location where the files required for the DB2 recovery process are stored. When you select the "Restore Logs" option on the CommCell Console restore, logs archived after the full restore are restored to the DB2 retrieve path, and then the rollforward starts.
The software allocates the logs to the restore path when you perform a log restore operation.
Note
If you install the software in a clustered environment, the DB2 restore log path must reside on a shared drive. The DB2 retrieve path cannot reside on a temporary location. If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.
Destination Folder for the DB2 Audit Error Path
Determine the location where the DB2 audit error logs are stored.
When you use the VENDOR library for log archival, the software stores the offset log files in this location. The software automatically cleans up any offset file that is not accessed in 4 days.
Offset log files are index files that contain information about the backed up DB2 logs, for example, the chain number and offset media. The information in these files improves the restore job performance.
Note
If you install the software in a clustered environment, the DB2 audit error path must reside on a shared drive. The DB2 Audit Error path cannot reside on a temporary location. If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.