0% found this document useful (0 votes)
147 views

B DP Erp Sap db2 Guide PDF

Uploaded by

Javier Gonzalez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
147 views

B DP Erp Sap db2 Guide PDF

Uploaded by

Javier Gonzalez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 222

IBM Tivoli Storage Manager for Enterprise Resource

Planning
Version 6.4.2

Data Protection for SAP


Installation and User's Guide for DB2


IBM Tivoli Storage Manager for Enterprise Resource
Planning
Version 6.4.2

Data Protection for SAP


Installation and User's Guide for DB2


Note:
Before using this information and the product it supports, read the information in “Notices” on page 173.

First edition (June 2014)


This edition applies to version 6, release 4, modification 2 of IBM Tivoli Storage Manager for Enterprise Resource
Planning (product number 5608-E05), and to all subsequent releases and modifications until otherwise indicated in
new editions.
© Copyright IBM Corporation 1995, 2014.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Figures . . . . . . . . . . . . . . vii Installing Tivoli Storage Manager for ERP for DB2 in
a Windows environment . . . . . . . . . . 29
Tables . . . . . . . . . . . . . . . ix Enabling ProLE to access configuration files on a
remote share (Windows) . . . . . . . . . 30
Uninstalling an older version of Data Protection
About this publication . . . . . . . . xi for SAP for DB2 (Windows) . . . . . . . . 31
Who Should Read This Publication . . . . . . xi Verify the installation or upgrade . . . . . . . 31
Publications . . . . . . . . . . . . . . xi Preparing to install the Administration Assistant . . 31
Note on Advanced Copy Services and FlashCopy Prerequisites for installing the Administration
Manager . . . . . . . . . . . . . . . xi Assistant for Data Protection for SAP . . . . . 32
Installing the Administration Assistant for Data
New for IBM Tivoli Storage Manager Protection for SAP server-level components. . . 33
for Enterprise Resource Planning
Version 6.4.2 . . . . . . . . . . . . xiii Chapter 4. Upgrading Data Protection
for SAP for DB2 . . . . . . . . . . . 35
Chapter 1. Protecting Data for SAP Upgrading the Data Protection for SAP for DB2 base
database servers . . . . . . . . . . . 1 product. . . . . . . . . . . . . . . . 35
Data Protection for SAP for DB2 overview . . . . 1 Migrate the Data Protection for SAP for DB2
Integration between SAP and DB2 . . . . . . . 2 profile . . . . . . . . . . . . . . . 36
DB2 command line processor . . . . . . . . . 3 Upgrading the Administration Assistant for Data
DB2 Backup Object Manager utility. . . . . . . 4 Protection for SAP . . . . . . . . . . . . 36
DB2 Log Manager . . . . . . . . . . . . 6 Copying the Administration Assistant from a
Backup objects and types of failures . . . . . . 8 previous release . . . . . . . . . . . . 37
Administration Assistant for Data Protection for SAP 9
Administration Assistant for Data Protection for Chapter 5. Configuring . . . . . . . . 39
SAP . . . . . . . . . . . . . . . . 12 Changing configuration tasks for the Data
Minimize backup and restore processing with Tivoli Protection for SAP base product . . . . . . . 39
Storage Manager for ERP . . . . . . . . . . 12 Configuring profile tasks . . . . . . . . . 39
DB2 tasks . . . . . . . . . . . . . . 43
Chapter 2. Planning for Data Protection Setting up the Administration Assistant for Data
Protection for SAP . . . . . . . . . . . 47
for SAP for DB2 operations . . . . . . 15
Configuring distributed file system tasks . . . 51
Database Server Considerations . . . . . . . 15
Configuring Data Protection for SAP for DB2 as
Network performance optimization . . . . . . 16
an HACMP application . . . . . . . . . 52
Backup server optimization . . . . . . . . . 16
Configuring Tivoli Storage Manager . . . . . . 54
Store data on the Tivoli Storage Manager server . . 17
Tivoli Storage Manager client tasks . . . . . 54
Parallel backup paths and backup servers . . . 18
Tivoli Storage Manager server tasks . . . . . 58
Archive inactive data . . . . . . . . . . . 18
Restore versus backup . . . . . . . . . . . 19
Planning for using IBM HACMP for AIX . . . . 19 Chapter 6. Protecting data . . . . . . 67
HACMP impact on Data Protection for SAP for Backing up SAP data . . . . . . . . . . . 67
DB2 . . . . . . . . . . . . . . . . 20 Schedule automated backup tasks . . . . . . 67
Digital signing of executable files (Windows) . . . 20 Windows scheduling example . . . . . . . 68
Backups in a nonpartitioned database
environment . . . . . . . . . . . . . 69
Chapter 3. Installing Data Protection for
Use DB2 single system view for backup . . . . 69
SAP for DB2 . . . . . . . . . . . . 23 Multiple log file copies . . . . . . . . . 70
Preparing to install Data Protection for SAP . . . 23 Schedule batch sample . . . . . . . . . 70
Prerequisites . . . . . . . . . . . . . . 24 Full offline backup batch file sample . . . . . 70
Installing Data Protection for SAP for DB2 in silent Full offline backup shell script sample . . . . 71
mode . . . . . . . . . . . . . . . . 25 Segment large backup objects . . . . . . . 71
Installing Tivoli Storage Manager for ERP for DB2 Restoring SAP data . . . . . . . . . . . . 73
on UNIX or Linux . . . . . . . . . . . . 26 Start restores in a nonpartitioned database
Uninstalling the old version of Tivoli Storage environment . . . . . . . . . . . . . 73
Manager for ERP for DB2 (UNIX or Linux) . . . 28 Processing redirected restore in automatic mode 74
Tablespace definition information . . . . . . 75

© Copyright IBM Corp. 1995, 2014 iii


Processing redirected restore in batch mode . . 78 Performance tuning for data transfer . . . . 111
Redirected restore in interactive mode . . . . 79 Multiple servers . . . . . . . . . . . 112
Sample work flow for redirected restore . . . . 80 Multiple sessions . . . . . . . . . . . 113
Redirected restore plausibility checks . . . . . 83 Multiplexing. . . . . . . . . . . . . 113
DB2 redirected restore using Backup Object Multiple network paths . . . . . . . . . 114
Manager . . . . . . . . . . . . . . 84 Storage space . . . . . . . . . . . . . 114
Creating table space definition information . . . 85 Automated tablespace adaptations . . . . . 115
Redirected restore prerequisites . . . . . . . 85 Tablespace normalization . . . . . . . . 115
Tablespace definition information . . . . . . 86 Scaling tablespace containers . . . . . . . 116
Protecting SAP data with the Administration
Assistant for Data Protection for SAP . . . . . . 87 Chapter 8. Troubleshooting . . . . . 119
Administer user IDs . . . . . . . . . . 87 Troubleshooting common problems . . . . . . 119
Specifying a new Administration Assistant for Reproducing problems . . . . . . . . . 120
Tivoli Storage Manager for ERP . . . . . . 87 Internet Protocol version 6 (IPv6) support . . . 120
Generating reports using report templates . . . 88 Setup requirements . . . . . . . . . . 121
Requesting a report from the Administration Information to collect for support . . . . . 123
Assistant . . . . . . . . . . . . . . 89 Troubleshooting Data Protection for SAP for DB2
Starting and stopping the Administration problems . . . . . . . . . . . . . . . 123
Assistant . . . . . . . . . . . . . . 89 Location of log files . . . . . . . . . . 126
Changing the password for the Administration Log files that contain information and messages 126
Assistant for Data Protection for SAP database DB2 vendor reason codes . . . . . . . . 127
user ID . . . . . . . . . . . . . . . 90
Determine throughput rates . . . . . . . . 90
Chapter 9. Reference information . . . 129
Determine the disk I/O rate . . . . . . . . 91
Version numbers . . . . . . . . . . . . 129
Determine the network throughput rate . . . . 91
Backups and restores in partitioned database
Reporting on simulations . . . . . . . . . 91
environments . . . . . . . . . . . . . 129
Simulating backup and restore . . . . . . . 92
Backup Object Manager . . . . . . . . . . 131
Determine the throughput rate of storage media 93
Backup Object Manager command options . . . 132
Backup command . . . . . . . . . . . . 134
Chapter 7. Tuning performance . . . . 95 Delete command . . . . . . . . . . . . 134
Example of a disk bottleneck . . . . . . . . 96 Password command . . . . . . . . . . . 135
Example of a network or Tivoli Storage Manager Query command . . . . . . . . . . . . 135
bottleneck . . . . . . . . . . . . . . . 96 Restore commands . . . . . . . . . . . 136
Viewing performance data . . . . . . . . . 97 BACKOM command examples . . . . . . . 137
Drilling down into performance data . . . . . 98 Crontab example . . . . . . . . . . . . 138
Use the reports . . . . . . . . . . . . . 99 Crontab file sample . . . . . . . . . . . 138
Reporting on the performance of backup Data Protection for SAP profile . . . . . . . 139
operations . . . . . . . . . . . . . . 99 Profile parameter descriptions . . . . . . . 140
Reporting on backup status . . . . . . . 101 Sample profile file for UNIX or Linux . . . . 145
Create a report . . . . . . . . . . . . 102 Sample Data Protection for SAP for DB2 profile
Reporting on failed actions . . . . . . . . 102 (Windows) . . . . . . . . . . . . . 148
Report output and style sheets . . . . . . 102 The custom SQL file . . . . . . . . . . . 151
Reporting on operations details . . . . . . 103 Define thresholds using the custom SQL file . . 152
Reporting on backup operation trends . . . . 104 Sample custom SQL file . . . . . . . . . 153
Reporting on Data Protection for SAP activities 105 Protecting Data for SAP for DB2 files and samples 153
Report templates . . . . . . . . . . . 106 Scheduling a report, shell script sample (UNIX) 153
Server-related tuning . . . . . . . . . . . 106 Scheduling a report, sample command file
Manage data on the backup server . . . . . 106 (Windows) . . . . . . . . . . . . . 154
Alternate network paths and servers . . . . 106 Client user options file sample (UNIX, Linux) 154
Options . . . . . . . . . . . . . . . 106 Client user options file sample (Windows). . . 154
Performance options for Data Protection for Client system options file sample (dsm.sys) . . 155
SAP . . . . . . . . . . . . . . . 107 Include/exclude list sample (UNIX, Linux) . . 155
Buffer copies . . . . . . . . . . . . 108 Include/exclude list sample (Windows) . . . 156
Buffer size . . . . . . . . . . . . . 108 Client options files sample . . . . . . . . 157
Compression of data for backup . . . . . . 108 Vendor environment file sample . . . . . . 157
Automation options for Data Protection for SAP Planning sheet for the base product . . . . . . 158
for DB2 . . . . . . . . . . . . . . 109 Administration Assistant planning sheet . . . 158
Data transfer . . . . . . . . . . . . . 110 Network settings for Tivoli Storage Manager . . . 162
Data throughput rate . . . . . . . . . . 110 Networks with large bandwidth delay . . . . . 162
Data Protection for SAP for DB2 performance SP switch (RISC 6000) . . . . . . . . . . 163
sensors . . . . . . . . . . . . . . 111

iv IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Appendix A. Tivoli support B . . . . . . . . . . . . . . . . . 179
information . . . . . . . . . . . . 165 C . . . . . . . . . . . . . . . . . 180
Communities and other learning resources . . . 165 D . . . . . . . . . . . . . . . . . 181
Searching knowledge bases . . . . . . . . . 167 E . . . . . . . . . . . . . . . . . 183
Searching the Internet . . . . . . . . . 167 F . . . . . . . . . . . . . . . . . 184
Using IBM Support Assistant . . . . . . . 167 G . . . . . . . . . . . . . . . . . 184
Finding product fixes. . . . . . . . . . 168 H . . . . . . . . . . . . . . . . . 185
Receiving notification of product fixes . . . . 168 I. . . . . . . . . . . . . . . . . . 186
Contacting IBM Software Support . . . . . . 168 J. . . . . . . . . . . . . . . . . . 186
Setting up and managing support contracts . . 169 K . . . . . . . . . . . . . . . . . 186
Determining the business impact . . . . . . 169 L . . . . . . . . . . . . . . . . . 187
Describing the problem and gathering M . . . . . . . . . . . . . . . . . 188
background information . . . . . . . . . 169 N . . . . . . . . . . . . . . . . . 189
Submitting the problem to IBM Software O . . . . . . . . . . . . . . . . . 190
Support . . . . . . . . . . . . . . 170 P . . . . . . . . . . . . . . . . . 190
Q . . . . . . . . . . . . . . . . . 191
R . . . . . . . . . . . . . . . . . 192
Appendix B. Accessibility features for S . . . . . . . . . . . . . . . . . 193
the Tivoli Storage Manager product T . . . . . . . . . . . . . . . . . 196
family. . . . . . . . . . . . . . . 171 U . . . . . . . . . . . . . . . . . 196
V . . . . . . . . . . . . . . . . . 197
Notices . . . . . . . . . . . . . . 173 W . . . . . . . . . . . . . . . . . 198
Trademarks . . . . . . . . . . . . . . 175
Privacy policy considerations . . . . . . . . 175 Index . . . . . . . . . . . . . . . 199

Glossary . . . . . . . . . . . . . 177
A . . . . . . . . . . . . . . . . . 177

Contents v
vi IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figures
1. Scope of Data Protection for SAP for DB2 1 18. Performance report - tabular presentation
2. Integration of Data Protection for SAP with DB2 2 section . . . . . . . . . . . . . . 101
3. DB2 Backup Architecture . . . . . . . . 3 19. Status report . . . . . . . . . . . . 101
4. Data Protection for SAP Backup Object Manager 5 20. Operations - failure report . . . . . . . 102
5. Log Management with DB2 Log Manager and 21. Operations – detailed report . . . . . . 104
Data Protection for SAP . . . . . . . . . 7 22. Operations daily report . . . . . . . . 105
6. DB2 Backup Objects . . . . . . . . . . 8 23. Data transfer for a backup and restore 107
7. Administration Assistant for Data Protection 24. Null Block Compression . . . . . . . . 108
for SAP Components (with Default Port 25. High-level view of the data flow during
Numbers) . . . . . . . . . . . . . 10 backup . . . . . . . . . . . . . . 110
8. Example of an SAP Landscape . . . . . . 11 26. Performance Optimizing by Using Sensors 111
9. Sample Environment for HACMP takeover 19 27. Data Protection for SAP Data Transfer 112
10. Production Backup Example . . . . . . . 68 28. Multiple Servers . . . . . . . . . . 112
11. Redirected restore overview . . . . . . . 84 29. Parallel (Multiple) Sessions . . . . . . . 113
12. Simulation Report . . . . . . . . . . 92 30. Multiplexing . . . . . . . . . . . . 114
13. A balanced configuration . . . . . . . . 95 31. Parallel (Multiple) Paths . . . . . . . . 114
14. Indicating a Disk Bottleneck . . . . . . . 96 32. Tablespace Normalizing . . . . . . . . 115
15. Indicating a Network or Tivoli Storage 33. Tablespace scaling . . . . . . . . . . 117
Manager Bottleneck . . . . . . . . . . 97 34. SAP and Data Protection for SAP for DB2
16. Showing data throughput and I/O usage 98 configuration files on UNIX or Linux . . . 122
17. Performance Report - Graphical Presentation 35. General problem isolation . . . . . . . 124
Section . . . . . . . . . . . . . . 100

© Copyright IBM Corp. 1995, 2014 vii


viii IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Tables
1. File Extensions for Shared Libraries . . . . 27 9. Tags for Defining Thresholds in the Custom
2. SERVER statement and appropriate profile and SQL File . . . . . . . . . . . . . 152
option file settings. . . . . . . . . . . 40 10. Installation Parameters for Data Protection for
3. Configuration parameters for DB2 database SAP. . . . . . . . . . . . . . . 158
backup and restore, and log archive and 11. Installation parameters for the Administration
retrieve . . . . . . . . . . . . . . 45 Assistant for Data Protection for SAP . . . 158
4. Password handling for UNIX or Linux . . . 63 12. Tuning Tivoli Storage Manager Configuration
5. Password handling for Windows . . . . . 64 File Attributes . . . . . . . . . . . 162
6. Summary: How to determine throughput rates 90 13. Tuning of network settings . . . . . . . 162
7. DB2 vendor reason codes . . . . . . . 127 14. Tuning of SP switch buffer pools . . . . . 163
8. Contents of the Custom SQL File . . . . . 151

© Copyright IBM Corp. 1995, 2014 ix


x IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
About this publication
This publication documents how to use IBM® Tivoli® Storage Manager for
Enterprise Resource Planning Data Protection for SAP Version 6.4.2. It describes the
procedures that are needed to install and customize IBM Tivoli Storage Manager
for Enterprise Resource Planning which is the interface between SAP and Tivoli
Storage Manager.

Who Should Read This Publication


This publication (or topic collection) is intended for system programmers and
administrators who are responsible for implementing a backup solution in an SAP
environment using the Tivoli Storage Manager. It describes the procedures needed
to install and customize Data Protection for SAP, the interface between SAP and
the Tivoli Storage Manager. The reader should be familiar with the documentation
for SAP and Tivoli Storage Manager.

Publications
The Tivoli Storage Manager product family includes IBM Tivoli Storage
FlashCopy® Manager, IBM Tivoli Storage Manager for Space Management, IBM
Tivoli Storage Manager for Databases, and several other storage management
products from IBM Tivoli.

For more IBM product documentation, see http://www.ibm.com/support/


knowledgecenter/.

Note on Advanced Copy Services and FlashCopy Manager


The product IBM Tivoli Storage Manager for Advanced Copy Services (TSM for ACS)
was replaced by IBM Tivoli FlashCopy Manager. References in this publication, and
in error messages, to TSM for ACS are also applicable to the Tivoli FlashCopy
Manager.

© Copyright IBM Corp. 1995, 2014 xi


xii IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
New for IBM Tivoli Storage Manager for Enterprise Resource
Planning Version 6.4.2
Read about features that are new in IBM Tivoli Storage Manager for Enterprise
Resource Planning Version 6.4.2.

New features
v Support for SAP BRTools 7.4
v Support for DB2® 10.1 and 10.5 on all operating systems
v Support for Windows 2012
v Support for Solaris 11

© Copyright IBM Corp. 1995, 2014 xiii


xiv IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 1. Protecting Data for SAP database servers
IBM Tivoli Storage Manager for Enterprise Resource Planning: Data Protection for
SAP for DB2 protects SAP system data, and is integrated with the database-specific
utilities of IBM DB2. Data Protection for SAP improves the availability of SAP
database servers and reduces administration workload. This result is achieved with
automated data protection features that are designed for SAP environments.

About this task

Data Protection for SAP provides these features and functions.

Data Protection for SAP for DB2 overview


Data Protection for SAP and Tivoli Storage Manager provide a reliable, high
performance, and production-oriented solution that enables back up and restore of
DB2 based SAP systems.

Data Protection for SAP is integrated with DB2 backup and recovery facilities and
applies SAP backup and recovery procedures. Data Protection for SAP is optimized
for SAP databases and therefore provides efficient management of large data
volumes.

Figure 1. Scope of Data Protection for SAP for DB2

As demonstrated in this graphic, SAP backup-and-recovery utilities center on


database objects where more than 90% of the data is on an SAP database server. As
a result, Data Protection for SAP backs up and restores database contents,
database-specific control files. An example of control files is the database
configuration, the history and the log file header, and offline DB2 log files.

Other files (such as SAP and DB2 executable files) can be backed up using the IBM
Tivoli Storage Manager backup-archive client. This action is important for disaster

© Copyright IBM Corp. 1995, 2014 1


recovery purposes, as all SAP and DB2 executable files must be available before
you use Data Protection for SAP to restore and recover the database.

Integration between SAP and DB2


Data Protection for SAP for DB2 operates as an unseen link between DB2 and the
Tivoli Storage Manager. A shared library is dynamically linked by DB2
backup/archive processes.

Figure 2. Integration of Data Protection for SAP with DB2

Data Protection for SAP also provides the Administration Assistant function for
Data Protection for SAP, which is used to increase administrator productivity. The
Administration Assistant function for Data Protection for SAP can control multiple
instances of Data Protection for SAP. It communicates with Data Protection for SAP
through TCP/IP, and typically is on a different server. It is used to configure a
Data Protection for SAP instance, monitor data transfer performance, backup status
of all SAP systems backed up by Data Protection for SAP, and Tivoli Storage
Manager server activity that is related to SAP. In addition, the Administration
Assistant can remotely monitor and administer all Data Protection for SAP
instances through an applet that runs on a web browser. Information about how to
use the Administration Assistant to register an SAP instance during installation or
later is available in “Specifying a new Administration Assistant for Tivoli Storage
Manager for ERP” on page 87.

2 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
DB2 command line processor
The DB2 Command Line Processor (CLP) interprets commands for the DB2
database and passes control to a DB2 Server Process. For Data Protection for SAP
for DB2, the LOAD libraryname option instructs DB2 to start the Data Protection for
SAP shared library. This process starts the backup or restore operation,
dynamically loads the library, and communicates with Data Protection for SAP
through the Vendor API.

For starting a backup or restore, the DB2 CLP communicates with the DB2 Server
Process and provides information to the Server Process for processing the database.

Figure 3. DB2 Backup Architecture

The DB2 BACKUP DATABASE command performs this DB2 Server process:
v Creates a unique timestamp to identify the backup
v loads Data Protection for SAP dynamically as a shared library
v Reads the data from the database containers
v Reads the DB2 configuration files
v Creates data blocks that contain the backup image and passes these blocks to the
data mover part of Data Protection for SAP

Chapter 1. Protecting Data for SAP database servers 3


The Data Protection for SAP shared library sends the data to the Tivoli Storage
Manager server storage (tape or disk). At the end of the backup process, the DB2
Server process logs the backup in the Recovery History File.

The DB2 RESTORE DATABASE command performs this DB2 Server process:
v Loads Data Protection for SAP dynamically as a shared library
v Requests the backup data from the shared library

The Data Protection for SAP shared library


v checks with the Tivoli Storage Manager if the backup image is available
v retrieves the data blocks from TSM
v passes the data blocks to the DB2 Server Process

The DB2 Server Process


v restores the DB2 data to the database containers.
v logs the restore in the Recovery History File.

DB2 Backup Object Manager utility


Backup objects, such as database or table space backups and DB2 log files, can be
managed with the Data Protection for SAP for DB2 Backup Object Manager.
Information about Backup Object Manager commands and options is provided.

The Backup Object Manager is a utility that performs these tasks:


v Verify and store a Tivoli Storage Manager password.
v Find backup objects in Tivoli Storage Manager.
v Check the properties of the backup objects in Tivoli Storage Manager.
v Remove any backup object from Tivoli Storage Manager.
v Backup database and selected table spaces.
v Restore database and table space backups to the corresponding database.
v Retrieve files from Tivoli Storage Manager and restore them to the file system.
v Perform a redirected restore of databases (cloning).

The Backup Object Manager is designed to handle DB2 log files that are archived
with Data Protection for SAP, the SAP tool BRARCHIVE, and those files that are
archived with Data Protection for SAP and the DB2 Log Manager. No special
Backup Object Manager customization or configuration is necessary. Because of the
log chain concept that is used by the DB2 Log Manager, all log files that are
archived on Tivoli Storage Manager with Data Protection for SAP is associated to
one of these chains by the Backup Object Manager. However, the SAP and DB2
Administration Tools, BRARCHIVE and BRRESTORE, do not support the log chain
concept. Therefore, log files that are archived with BRARCHIVE and Data
Protection for SAP is associated with a default value. For example, the first log
chain is ’0’ or ’C0000000’. However, log files that are archived with the DB2 Log
Manager and Data Protection for SAP are associated with the appropriate log chain
number. The log files are handled by the Backup Object Manager. Detailed
information about the DB2 Log Manager and the log chain concept is available in
your DB2 Administration Guide documentation.

This graphic displays how the Backup Object Manager interacts with the Tivoli
Storage Manager server and the SAP database Server:

4 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 4. Data Protection for SAP Backup Object Manager

The Backup Object Manager works with database backups, DB2 log files, and raw
files that might comprise any files of the file system. The tasks that can be done
with the Backup Object Manager are processed in different ways:
v Requests to verify the Tivoli Storage Manager password are passed directly to
Tivoli Storage Manager.
v Requests to display or delete any data are answered by accessing the Tivoli
Storage Manager server directly, thus working with the data that is available on
Tivoli Storage Manager.
v Requests to restore DB2 log files and raw files are also processed by using the
Tivoli Storage Manager client.
v Requests to back up or restore any DB2 database data are routed to the DB2
agent. The DB2 agent employs the Data Protection for SAP shared library.

The Backup Object Manager is available for use upon successful installation and
setup of Data Protection for SAP. The Backup Object Manager uses the settings in
the Data Protection for SAP profile, configuration file, and the settings of the
XINT_PROFILE, TDP_DIR, and DB2_VENDOR_LIB environment variables. As a result,
extra installation and setup steps are not required.

Chapter 1. Protecting Data for SAP database servers 5


DB2 Log Manager
Data Protection for SAP for DB2 is integrated with the built-in DB2 Log Manager.
As a result, when Data Protection for SAP is registered within the DB2 database
configuration, the DB2 Log Manager uses Data Protection for SAP for archiving
and retrieving log files.

Log files that are used in an SAP environment are in one of these four states:
Online active
The log file is used by DB2 for current logging transactions.
Online retained
The log file is not used by DB2 for current logging transactions. However,
it contains transactions with unwritten data pages. An unwritten data page
is a page that is not received data from the buffer pool to disk. As a result,
the log file is needed by DB2 to do a crash recovery or rollback operation.
The DB2 Log Manager copies a filled online log file to a possible archive
location. Do not use operating system commands for copying online log
files.
Offline retained
The log file is not used by DB2 for current logging transactions and it does
not contain transactions with unwritten data pages. In addition, it is not
needed to do a crash recovery or a rollback operation. The log file is
archived to a location specified by the database configuration. When
archived successfully, DB2 deletes the log from the database log directory.
Archived
Filled or closed log files that were archived to Tivoli Storage Manager
storage.

6 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 5. Log Management with DB2 Log Manager and Data Protection for SAP

Data Protection for SAP for DB2 is loaded dynamically by the DB2 Log Manager
as a shared library on UNIX or Linux. It is also loaded as a dynamic link library
(DLL) on Windows, and runs as part of the DB2 engine. When a log file is ready to
be archived (online/offline retained), the DB2 Log Manager starts the archive
process by passing the file as blocks to Data Protection for SAP. The data is then
sent (by Data Protection for SAP ) to Tivoli Storage Manager storage.

When a database rollforward recovery is issued, the DB2 Log Manager first checks
if the corresponding log files are in either the log path or in an overflow log path.
Either log path is specified in the DB2 rollforward command invocation. If the log
files are not found at one of these locations, the DB2 Log Manager accesses Data
Protection for SAP to determine whether the log images are available on Tivoli
Storage Manager. If available, Data Protection for SAP retrieves the data from
Tivoli Storage Manager and sends them as blocks to the DB2 Log Manager. Then,
the log manager writes the log files to the file system. The log files are then
applied to the database by using DB2 processes.

Detailed information about the DB2 Log Manager is available in your DB2
Administration Guide.

Chapter 1. Protecting Data for SAP database servers 7


Backup objects and types of failures
Data Protection for SAP for DB2 backs up and restores SAP® database objects only
as shown in Figure 6.

DB2 configuration files

DB2 BACKUP

DB2 container(s)

Offline log file(s) ..... DB2 LOG MANAGER

Online log file(s) NO BACKUP

log_dir

Figure 6. DB2 Backup Objects

Corrupt database
For a corrupted database (caused by user errors or transaction failures), the
database can be restored to a specific point in time. Restoring only the
database and configuration files can be sufficient for a specific point in
time operation. As a result, a backup image of the database and the
corresponding DB2 log files are required.
Hardware failure
In the event of a storage hardware failure, the database is typically restored
to the most recent point in time. Thus, the most recent database image and
DB2 log files are restored. However, the database executable files, SAP
system data, and restoring user data might be necessary in the event of a
hardware failure. To protect the system against the loss of SAP executable
files, user data, or even operating system data, use the Tivoli Storage
Manager backup-archive client incremental backup feature. You can use the
client to define an include-exclude list of files that to be backed up during
incremental backup operation. The include-exclude list is to exclude
database container files and offline log files that were backed up or
archived by Data Protection for SAP. See “Include/exclude list sample
(UNIX, Linux)” on page 155 or “Include/exclude list sample (Windows)”
on page 156 for example include-exclude lists. Example include-exclude list
files are also provided in the Data Protection for SAP installation directory.
Disaster recovery
For a complete disaster recovery operation, all operating system data must
be restored along with the database image, DB2 log files, database
executable files, SAP system data, and user data. To help prevent a
complete loss of the operating system, use operating system utilities (such
as mksysb for AIX®) to run system backups. Such backups are to be done
after you install, update, or upgrade the operating system. After these
actions, you can start your system from the backup medium. A configured

8 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
TCP/IP environment and Tivoli Storage Manager Backup-Archive client
installation is to be included in a base backup to be able to restore all data.
Since there is no provision for backing up online DB2 log files that are
required for disaster recovery, place the DB2 log directory on a mirrored
disk.

Administration Assistant for Data Protection for SAP


The Administration Assistant comprises the client component and three
server-level components, Server, Database Agent, and Database). Operations data is
maintained in an internal database that helps to prevent an insufficient memory
problem in SAP environments where a number of Data Protection for SAP for DB2
instances are active.

The internal database that is used by the Administration Assistant is managed by


either the open source database product Apache Derby or IBM DB2 data server..
Apache Derby is bundled with, and installed by, the Administration Assistant. For
more information about Apache Derby, see
http://db.apache.org/derby/

If you prefer to use the IBM DB2 data server, an existing DB2 installation must be
present. It is configured by the Administration Assistant. For more information
about DB2, see
http://www.ibm.com/software/data/db2/

The server-level components are installed together on one system (standard


installation) or distributed across multiple systems (distributed installation). An
example of a multiple system installation is when the Server component is on one
system and the database components is on a second system; or, each component is
installed on a separate system. This type of distributed installation helps alleviate
CPU loads on a single-system configuration (in large-scale environments) by
distributing this load over two or three separate systems. If CPU load is not an
issue, the single-system installation is typically used. The distributed installation
requires that all connecting Data Protection for SAP instances be version 5.4 or
higher. If a single-system installation is selected, earlier Data Protection for SAP
versions can also connect to the Administration Assistant.

Each system that hosts an Administration Assistant component can be running


UNIX, Linux, or Windows. Separate configuration files are maintained by the
Server (assist.cfg) and Database Agent (dbagent.cfg) component. User profiles
ensure that a client user can access the data of only those SAP database servers for
which permission is granted.

This figure shows the communication relationships of the Administration Assistant


components (port numbers that are shown are defaults).

Chapter 1. Protecting Data for SAP database servers 9


Figure 7. Administration Assistant for Data Protection for SAP Components (with Default Port
Numbers)

The Server component waits for the client requests for connections. It uses either
the HTTP or HTTPS protocols and also for connect requests (through TCP/IP)
from the Data Protection for SAP ProLE service. After it connects to the Server
component, the Data Protection for SAP ProLE service connects and communicates
directly with the Database Agent. It sends backup and restore data that is
requested through the Data Protection for SAP instance. The Database Agent
collects this data and stores all information that is related to the Operations
Monitor in the Administration Assistant database through the Database
component. The Database Agent forwards performance data to the Administration
Assistant Server component, which records it in history files. The retention time for
this data is definable at installation time (default 14 days). This data is accessed
when the clients request any of the Administration Assistant monitoring or
analysis functions. The Administration Assistant server-level components must be
running and connected to the Data Protection for SAP ProLE service during the
backup and restore operations to receive and store the history data. The existence
of the database-related components is not visible to the client user.

An SAP system landscape contains several SAP systems, such as production,


development, test, and education systems. A single Administration Assistant Server
component can monitor many SAP database servers. A typical example is shown in
Figure 8 on page 11.

10 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 8. Example of an SAP Landscape

The Administration Assistant client is started from a browser by activating the


URL of the Server component host. The client is implemented as an Oracle Java™
applet that communicates with the Server component through a remote method
invocation (RMI) connection.
v When the Administration Assistant Server component is started in non-secure
mode (keyword nonsecure defined in the Server configuration file assist.cfg),
it accepts connect requests from a client to the HTTP port with the HTTP
protocol. In this case, further communication between the client and server is
through TCP/IP.
v When the Server component is started in secure mode (keyword nonsecure
omitted from the Server configuration file), it accepts connect requests from a
client to its HTTPS port through the HTTPS secure protocol. In this case, the
Secure Sockets Layer (SSL) protocol is employed for all communication between
the Administration Assistant clients and the Server component.
XML or HTML formatted reports can be created by the Administration Assistant
graphical user interface or through a command-line interface from a scheduling
client. The scheduling client is an application that is based on Oracle Java
technology. It communicates with the Administration Assistant Server component
through an RMI connection.

Chapter 1. Protecting Data for SAP database servers 11


Administration Assistant for Data Protection for SAP
The Administration Assistant provides a number of features that help you
configure, manage, and monitor the data protection environment.
Monitor Operations
A centralized view of the backup status information for all SAP systems
that are registered with the Administration Assistant server is provided.
Summaries of the backup status of all or a selection of SAP systems are
available and detailed information about all backup runs of a specific SAP
system. Thresholds can be defined to enable alerting under certain
conditions.
View Performance Data
Performance information during Data Protection for SAP for DB2 backup
or restore operations is displayed. The Administration Assistant also saves
this performance data and provides a graphical presentation for later
analysis.
Configure systems
Configuration of the SAP backup profiles, the Data Protection for SAP
profile, and the IBM Tivoli Storage Manager files for each of the SAP
systems that are registered with the Administration Assistant server is
provided. Online information also supports configuration. Additionally,
profiles can be copied from one system to another system. When
configuration changes are made through the Administration Assistant, a
configuration history is maintained so that a previous configuration can be
reused.
Request problem support
This feature sends support requests directly to IBM. Although support
requests contain user-specified problems the Administration Assistant
automatically collects and forwards more information, such as profiles and
error logs.
Manage report templates
This allows the generation and maintenance of templates for producing
reports.
Administer users
This feature defines user IDs and permissions to access the server
component from the Administration Assistant client.

The primary documentation for the Administration Assistant is the integrated


online help. The Administration Assistant also provides administrator-created
reports in XML or HTML format that are generated from the output of Monitor
operations and View performance data.

Minimize backup and restore processing with Tivoli Storage Manager


for ERP
Tivoli Storage Manager for ERP and the product IBM Tivoli Storage FlashCopy
Manager provide backup and restore capabilities for the SAP database on IBM
FlashCopy devices. These devices include IBM System Storage® DS8000®, IBM
System Storage SAN Volume Controller, IBM Storwize® V7000, and IBM XIV®
Storage System. These products can minimize downtime of the production systems
by using point-in-time copy functions.

12 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Although Tivoli Storage Manager for ERP for DB2 provides extensive storage
capabilities, business-critical databases might demand faster recovery operations.

Starting with DB2 9.5, DB2 offers a functionally restricted version of Tivoli Storage
Manager for ACS or FlashCopy Manager known as DB2 Advanced Copy Services.
DB2 can be upgraded to an unrestricted level by installing the full FlashCopy
Manager. In this environment, the software that is based on Tivoli Storage Manager
for ACS is also called by using the DB2 BACKUP DATABASE and RESTORE DATABASE
commands, but they contain the keywords USE SNAPSHOT rather than the “LOAD
library” phrase that is used to call the shared library for Tivoli Storage Manager for
ERP. USE SNAPSHOT causes DB2 to load and interact with the FlashCopy Manager
Snapshot Backup Library.

FlashCopy Manager product information is available at this website:


http://www.ibm.com/software/tivoli/products/storage-flashcopy-mgr/.

Chapter 1. Protecting Data for SAP database servers 13


14 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 2. Planning for Data Protection for SAP for DB2
operations
Planning information about various component considerations is provided.

About this task

Database Server Considerations


In general, the production (SAP® database) server is the most critical component
for data transfer. This is especially when parallelism is applied as described in
“Performance options for Data Protection for SAP” on page 107. As a result,
special attention is given to these items:
CPU power
Data transfer, data compression, local, or LAN-free backup operations can
cause significant demands on the database server CPU. These demands are
in addition to the application load caused by online backups. In many
environments, the CPU is the most critical constraint. The CPU load for
LAN-free backups (Managed System for SAN) can be reduced by
managing the buffers as described in “Buffer copies” on page 108.
I/O paths
Fast disk attachments with internal busses (like a peripheral component
interface) and file system features (like caching or reading ahead) can
improve data transfer rates. These attachments and features can be
especially useful for backup and restore operations that contain a
significant number of files and large data volumes.
Volume Manager settings
Volume Manager provides volume mirroring options that can significantly
reduce the data transfer rate during restore operations. As a result, not
using volume mirroring options during restore operations can improve the
data transfer rate.
Disk layout
The manner in which the database files are laid out can affect data transfer
rates. Since the DB2 backup utility allows parallel access to table spaces
during backup and restore operations, distribute data across several disks
to take advantage of this feature.
Database size
The size of a database can be reduced by offloading inactive data to an
external archive. For archive support, refer to the companion product DB2
CommonStore for SAP. For more information, see “Archive inactive data” on
page 18.

© Copyright IBM Corp. 1995, 2014 15


Network performance optimization
When you are setting up the network, there are some items to consider that can
improve network performance.

Consider these items when you set up the network:


LAN-free backup
LAN-free backup can reduce the load on the network and on the Tivoli
Storage Manager server, thus improving data transfer rates. When you use
LAN-free backup, ensure that Fibre Channel adapter capacity to the SAN
can accommodate the data transfer rates of the disk reads and tape writes.
Network bandwidth
In general, the effective throughput capacity is approximately half of the
theoretical network bandwidth. For high-speed networks such as Gigabit
Ethernet LAN, the network adapters limit the throughput rather than the
network itself.
Network topology
A dedicated backbone network that is used only for backup and restore
operations can improve the data transfer rate.
TCP options
Use TCP options that are the most beneficial for your environment.
Multiple Paths
Increase the overall throughput rate to the backup server by providing a
way to specify multiple network paths.

Backup server optimization


When you are setting up the Tivoli Storage Manager server, there are some items
to consider to optimize performance.

Consider these items when you set up the Tivoli Storage Manager server. Data
Protection for SAP for DB2 uses the Tivoli Storage Manager archive function for all
backup activities:
Dedicated backup server
A dedicated backup server allows sharing of resources and provides an
efficient resource usage.
CPU power
For a specific data throughput, the CPU load on the backup server is
approximately 60% of the load on the database server. Therefore, backup
server CPU power is not as critical as the CPU power of the database
server. However, demands on the Tivoli Storage Manager server CPU do
increase when several clients access a single Tivoli Storage Manager server.
Storage hierarchy
Backup of large data files is to be directed to tape to achieve the highest
transfer rates. If disks must be used, use one disk pool per session. Small
files such as log files, are to be directed to disk storage first and then
moved to tape collectively to avoid excessive tape mounts.
Parallel sessions
The Tivoli Storage Manager server allows the use of several tape drives in
parallel to store data. This setup can increase overall data throughput. To
fully use this feature, two conditions must exist. The corresponding Tivoli

16 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Storage Manager node must be allowed the appropriate number of mount
points and the device class must be allowed the appropriate mount limits.

Store data on the Tivoli Storage Manager server


In SAP terminology, backup (BRBACKUP) refers to the backup of data; archive
(BRARCHIVE) refers to the backing up of log files. Data Protection for SAP uses the
Tivoli Storage Manager archive function for backups and archives.

Tape storage is the preferred media for storing the database contents as it provides
the best data throughput for backup and restore. A disk-tape storage hierarchy can
be used for backing up log files. Each DB2 log file is to be backed up immediately
after it is placed in the archive directory. This action provides the best protection
against data loss, and eliminates the requirement to mount a tape for each DB2 log
file.

Tape storage is the preferred media for storing database contents as it provides the
best data throughput for backup and restore operations. For a large scale-out
system, the number of required tape drives might become too large. In this case,
use a virtual tape library (VTL). A disk-tape storage hierarchy is used for backing
up redo log files. This action provides the best protection against data loss, and
eliminates the need to mount a tape for each redo log file.

Data Protection for SAP transfers data to and from the backup server through
single or multiple (parallel) sessions to the Tivoli Storage Manager server. Each
session must have a storage device that is associated with it. The SAP backup ID is
persistently linked with each backup file. This backup ID can be used later to
determine all files that are required for a complete restore.

Collocation is a Tivoli Storage Manager function that ensures client data is


maintained together on one tape. Deactivate collocation in these situations:
v Deactivate collocation for Data Protection for SAP backups when you enable
parallel sessions for use with multiple tape drives in parallel.
v Deactivate collocation when you use the multiple log copy function.

To improve availability (alternate servers) or performance (multiple servers),


configure Data Protection for SAP to use multiple Tivoli Storage Manager servers.
Consider the location of all backup data before you remove a Tivoli Storage
Manager server from the Data Protection for SAP profile. Since Data Protection for
SAP accesses only those servers that are defined in the profile, be cautious when
you remove a Tivoli Storage Manager server if it contains valid backup data.

Database backups are retained for a specified period and then become obsolete.
Manage backup storage space efficiently, by deleting obsolete backups in one of
the following ways:
v Set an appropriate archive retention period with Tivoli Storage Manager options.
v Use the Data Protection for SAP backup version control function. When the
number of backup versions that are specified by this function is exceeded, entire
backup generations are deleted. The backups that can be deleted are full
backups and all related or DB2 partial and log file backups.

Chapter 2. Planning for Data Protection for SAP for DB2 operations 17
Parallel backup paths and backup servers
Data Protection for SAP can use several communication links between Tivoli
Storage Manager clients to control alternate backup paths and alternate backup
servers. This feature can increase throughput by transferring data over multiple
paths simultaneously or to and from several servers in parallel. It can improve the
availability of the Tivoli Storage Manager client-to-server communication and
enable disaster recovery backup to a remote Tivoli Storage Manager server.

In Data Protection for SAP terminology, path denotes a connection between a


Tivoli Storage Manager client or node, and a Tivoli Storage Manager server. A set
of communication parameters is set for each defined communication path. A Tivoli
Storage Manager server network address is an example of a communication path.
This set of communication parameters is called client option data and is collected
under a logical server name. The logical server name is determined by the user. On
UNIX or Linux systems, all client option data can be stored in a single file. This
file is the client system option dsm.sys file. On Windows systems, the client option
data for each logical server must be stored in separate client option files that have
the file name servername.opt. For example, if there are two logical Tivoli Storage
Manager servers “fast” and “slow”, then two client option files fast.opt and
slow.opt are required. Windows also requires an extra client user option file,
dsm.opt. All option files must be in the same directory.

Each path in the initSID.utl profile is defined by a server statement and the
corresponding definitions in the Tivoli Storage Manager client system option file
dsm.sys (UNIX and Linux) or server.opt (Windows). The SERVER <server 1..n>
statement denotes Tivoli Storage Manager servers that are defined in the Data
Protection for SAP profile. This definition corresponds to the statement SERVERNAME
server 1..n in the Tivoli Storage Manager client option file or files. These servers
are identified by their TCPSERVERADDRESS and can be on one system (multiple paths)
or several systems (multiple servers). SESSIONS denotes the number of parallel
sessions that Data Protection for SAP schedules for the path. If only one path is
used, SESSIONS must be equal to MAX_SESSIONS, which specifies the total number of
parallel sessions to be used (equivalent to number of tape drives/management
classes). Data Protection for SAP attempts to communicate with the Tivoli Storage
Manager server by using the first path in the profile. If this attempt is successful,
Data Protection for SAP starts the number of parallel sessions as specified for this
path. If the attempt was unsuccessful, this path is skipped and Data Protection for
SAP continues to the next path. This process continues until as many sessions are
active as were specified in the total session number (MAX_SESSIONS). If this number
is never reached (for example, because several paths were inactive), Data
Protection for SAP ends the backup job.

Archive inactive data


Data Protection for SAP creates a database image that is stored at the bit-level and
can be used for routine backup operations.

To restore an outdated backup, you must restore it into the same environment it
was originally taken from. This process requires you to maintain older versions of
SAP, the operating system, database, and Tivoli Storage Manager data to enable a
rebuild of the original environment. SAP provides archiving functions that can
display business documents that are designated with long-term retention
requirements. These business documents are format-independent and can be used
for auditing and other legal purposes. Archived data can then be removed from
the operational database to reduce the database size and improve backup and

18 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
restore processing time.

Restore versus backup


Configuration changes and infrastructure problems affect backup and restore
operations.

Changes that support a fast backup while you are using resources can be
considered applicable to the restore operation. Tune the backup operation and then
run a restore to verify that the restore operation works in a satisfactory manner.

During a restore operation, the values of these parameters are determined by their
settings during the corresponding backup:
Compression
If compression is used during the backup, data must be decompressed.
Multiplexing
The same level of multiplexing that is used during backup is automatically
applied during restore.
Multiple servers
When a backup is done with multiple servers, the same servers must be
online and available during the restore operation.

Planning for using IBM HACMP for AIX


Information is provided about Data Protection for SAP for DB2 that is useful when
you plan for HACMP™ failover configurations. This example uses the mutual
takeover configuration (each node can take over the other node). If the application
server and database server are installed on different hosts, the described actions
must be taken on the database servers only.

This figure illustrates the takeover environment:

Figure 9. Sample Environment for HACMP takeover

Chapter 2. Planning for Data Protection for SAP for DB2 operations 19
HACMP impact on Data Protection for SAP for DB2
A list of Data Protection for SAP for DB2 components that are impacted by
HACMP are provided.
Files
v The installation directory is /usr/tivoli/TSM/tdp_r3.
v Lock files are in /var/tdp_r3.
v There is only one ProLE running on each host (even after takeover).
v Each SAP® system has its own Data Protection for SAP configuration
files (initSID.utl, initSID.bki) . These files are in a directory that is
specified during the installation process.
Dependencies
v Both hosts must have the same level of Tivoli Storage Manager API
installed.
v Both hosts must be Data Protection for SAP.
v On both hosts, the dsm.sys file (in /usr/Tivoli/Tivoli Storage
Manager/client/api/bin/dsm.sys) must contain all server names that are
required for takeover.
Communication
The Data Protection for SAP dynamic library connects to ProLE by using
the following procedure:
v Retrieves the IP address for localhost (can be 127.0.0.1 for IPv4).
v Retrieves the tdpr3db264 service (can be 57324).
v Connects to 127.0.0.1: tdpr3db264 service>.

Digital signing of executable files (Windows)


Data Protection for SAP for DB2 executable files (except .jar files) for Windows
systems have a digital signature.

The following files are affected:


v Passport Advantage® package for Windows
v Data Protection for SAP installation files
– version-TIV-TSMERPDB2-WinX64.exe
v The Data Protection for SAP application files:
– backom.exe
– createinfo.exe
– prole.exe
– tdpdb2.dll

Code signing employs digital IDs, also known as certificates.

Having a valid digital signature ensures the authenticity and integrity of an


executable file. It identifies the software publisher as IBM Corporation to the
person who downloads or starts it. However, it does not mean that the user or a
system administrator implicitly trusts the publisher. A user or administrator must
decide to install or run an application on a case-by-case basis. The factors of their
decision are based on their knowledge of the software publisher and application.
By default, a publisher is trusted only if its certificate is installed in the Trusted
Publishers certificate store.

20 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
The customer can see the digital signature for any .EXE, .DLL, or installation
wizard of Data Protection for SAP by using one of the following methods:
1. The digital signature can be viewed from the Digital Signature tab of Properties
of the signed file. If you select the IBM Corporation item and click Details,
more information is displayed about the IBM Certificate and the entire chain of
trusted certificate authority signatures.
2. For the installation wizard, there is also the possibility to see the IBM digital
signature from the software publisher link that is displayed in the Security
Warning window.

A warning is shown if the certificate is expired and if a time stamp is not present.
A warning is also shown if the installation executable file is downloaded from a
site that is not listed as a trusted site. The security warning is not related to the
fact that executable files contain digital certificates. It is related to the security zone
policy of the site you download the file from.

The executable file must be stored on an NTFS disk. The Internet Explorer
Enhanced Security Configuration component (also known as Microsoft Internet
Explorer hardening) reduces the server vulnerability to attacks from web content
by applying more restrictive Internet Explorer security settings. As a consequence,
Internet Explorer Enhanced Security Configuration might prevent some websites
from displaying properly. It might also prevent users and administrators from
accessing resources with Universal Naming Convention (UNC) paths on a
corporate intranet. For more information about managing Internet Explorer
Enhanced Security Configuration, see http://www.microsoft.com/downloads/
details.aspx?FamilyID=d41b036c-e2e1-4960-99bb-9757f7e9e31b&DisplayLang;=en A
security warning might be displayed whenever you run an executable file that is
downloaded using the Internet Explorer from a URL or UNC that is not a member
of the trusted security zone.

When a downloaded file is saved to a disk formatted with NTFS, it updates the
metadata for the file with the zone (Internet or restricted) it was downloaded from.
The metadata is saved as an Alternate Data Stream (ADS), which is a feature of
NTFS with which the same file name can be used to cover multiple data streams.
When you open a file that includes an ADS that identifies it as being from another
zone, the Attachment Execution Services (AES) software is activated, which reacts
to the following file categories as described:
v High risk: Blocks the file from being opened when the file is from the restricted
zone. The following security warning is shown:
Windows Security Warning:
Windows found that this file is potentially harmful.
To help protect your computer, Windows has blocked access to this file.

v Moderate risk: Prompts with a warning before the file is opened when the file
is from the Internet zone.
Open File - Security Warning:
The publisher could not be verified. Are you sure you want to run this software?

v Low risk: Opens the file with no warnings.

Warning messages do not prevent the file from being used.

Note: This is different from configuring the web Server with a digital certificate.
During the installation of the Administration Assistant, the customer can generate

Chapter 2. Planning for Data Protection for SAP for DB2 operations 21
a self-signed certificate for the AA server and to use it to configure the security
communication over HTTPS between the Administration Assistant server
component and the clients.

22 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 3. Installing Data Protection for SAP for DB2
Install IBM Tivoli Storage Manager for Enterprise Resource Planning: Data
Protection for SAP for DB2 and follow the steps that are required to complete the
installation.

About this task

There are different procedures to install through the console, or to install the
product in silent mode. See “Installing Data Protection for SAP for DB2 in silent
mode” on page 25.

Windows executable files (except Java) contain a digital signature to certify that the
software originated by IBM. For more information, see “Digital signing of
executable files (Windows)” on page 20.

Procedure
v Review the prerequisite information for the version before you start to install the
product, “Prerequisites” on page 24.
v Install the Data Protection for SAP product through InstallAnywhere.

Preparing to install Data Protection for SAP


Data Protection for SAP for DB2 must be installed on all SAP database servers. The
following tasks are required to set up Data Protection for SAP.

Before you begin

If you plan to use the Administration Assistant, you must install it for Data
Protection for SAP before you install Data Protection for SAP. Data Protection for
SAP can automatically connect to the Administration Assistant as part of its
installation procedure. Details are available in “Administration Assistant for Data
Protection for SAP” on page 12.

Be aware of differences between UNIX or Linux, and Windows versions of Data


Protection for SAP. For example, UNIX or Linux uses the path separator “/” and
Windows uses the path separator “\” with a drive letter.

Procedure
1. Verify that the Data Protection for SAP for DB2 package is complete. See the
README.1ST file on each installation disk (or disk image) for a description of the
contents.
2. Verify that the prerequisites are met as described in “Prerequisites” on page 24.
3. Review planning sheet information as described in “Planning sheet for the base
product” on page 158.
4. Install Data Protection for SAP as described in “Installing Tivoli Storage
Manager for ERP for DB2 on UNIX or Linux” on page 26 or “Installing Tivoli
Storage Manager for ERP for DB2 in a Windows environment” on page 29. See
“Upgrading the Data Protection for SAP for DB2 base product” on page 35
when you upgrade a previous version of Data Protection for SAP.

© Copyright IBM Corp. 1995, 2014 23


5. Follow postinstallation tasks such as “Configure the Tivoli Storage Manager
client options” on page 54 and “Configure the Tivoli Storage Manager server”
on page 58.
6. Verify that the installation completes successfully as described in “Verify the
installation or upgrade” on page 31.

Prerequisites
Before you install Data Protection for SAP for DB2, review the hardware, software,
and application requirements.

Requirements for Data Protection for SAP are published in the hardware and
software requirements technote for each release. Review the technote for your
version in the IBM Tivoli Storage Manager for Enterprise Resource Planning - all
requirement documents site, http://www.ibm.com/support/
docview.wss?uid=swg21219410. From the page, follow the link to the technote for
your release or update level.

The installation packages are on the Data Protection for SAP for DB2 product
installation disk, disk image (from Passport Advantage), and occasionally on the
IBM public FTP server. Initial installations must always be done from the disk or
image. Refer to the file README.1ST in the root path for information about where to
find documents on the disk or image, and follow the appropriate installation
description. See the README.1ST file in the root directory of the disk or image for a
list of its contents.

If you are upgrading from an earlier version of Tivoli Data Protection for R/3 or
Data Protection for SAP in your environment, you can either upgrade from the
product disk or image, or download the latest version from the IBM FTP server.
For the specific procedure for upgrading from an earlier version, refer to
“Upgrading the Data Protection for SAP for DB2 base product” on page 35.

These products must be installed before you install Data Protection for SAP:
v DB2
v SAP R/3 or SAP e-business Solution that is based on DB2
The SAP Service Marketplace provides current information about SAP features,
product versions, and maintenance levels that are compatible with your version
of SAP R/3 or SAP.
v Tivoli Storage Manager Backup-archive client
For information about configuring the Tivoli Storage Manager API client, see
“Configure the Tivoli Storage Manager client options” on page 54. TCP/IP must
be ready for communication between the Tivoli Storage Manager server and the
Tivoli Storage Manager client.
v An operating system level that is supported by SAP and the Tivoli Storage
Manager client
The release notes contain current information about Data Protection for SAP
hardware, software, operating system, and maintenance levels.

When Data Protection for SAP is installed on a distributed file system, the root
user requires read/write access to the file system during the installation. For more
information about the installation in a distributed file system, see: “Configuring
Tivoli Storage Manager for ERP for DB2 in a distributed file system” on page 51.

24 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Installation planning forms for Data Protection for SAP and the Administration
Assistant are available in the planning_sheet (UNIX and Linux) or
planning_sheet.txt (Windows) files in the installation directory. They are also
available for printing in “Planning sheet for the base product” on page 158. When
prerequisites are met and installation planning information is completed, Data
Protection for SAP is ready to be installed.

Installing Data Protection for SAP for DB2 in silent mode


You can install Data Protection for SAP for DB2 in silent mode using a response
file. An installation that runs in silent mode suppresses the installation wizard.
Instead, user data entry and status messages are displayed in the command line
window.

About this task

To run a silent or unattended installation follow this procedure.

Procedure
1. Create a response file during an installation in either graphic or console mode
by using option -DRECORDFILE denoting the response file name:
./version-TIV-TSMERPDB2-platform.bin [-i console] -DRECORDFILE=properties file

Note: This command is for a UNIX system. For a Windows system, use the
corresponding .exe file with the same options.
2. Start the executable file with the -i silent option (silent mode) and the -f
option that denotes the file name of the response file:
./version-TIV-TSMERPDB2–platform.bin -i silent -f properties file

Note: This command is for a UNIX system. For a Windows system, use the
corresponding .exe file with the same options.
The properties file specification must contain a full path.

Chapter 3. Installing Data Protection for SAP for DB2 25


Example

Sample properties file:


USER_INSTALL_DIR=//opt//tivoli//tsm//tdp_r3//db264
NAMEPORTAA_ADRESSE=AAServer
NAMEPORTAA_PORT=5126
RMANYES=
MANNO=
TSMUTL_SERVERADRESSE=TSMServer
TSMUTL_NODE=R3NODE
TSMUTL_BACKUPMGM=MDB
TSMUTL_ARCHIVEMGM=MLOG1 MLOG2
TSMUTL_YES=1
TSMUTL_NO=0
TSMAPI_DSMI_DIR=
TSMAPI_DSMI_CONFIG=
TSMAPI_DSMI_LOG=
TSMAPI_YES=
TSMAPI_NO=
SAP_BR_TOOL=
SAP_CFG_FILE=
TSM_CFG_FILE=
DBGSCRIPTS2=//dev//null
SID=SID
DB2_INSTANCE_NAME=DB2_INSTANCE_NAME
USER_MAGIC_FOLDER_1=//db2//DB2ERE//tdp_r3
LOGGING_NONE=0
LOGGING_LOGARCHMETH1=0
LOGGING_LOGARCHMETH2=0
LOGGING_BOTH=1
LOGGING_NR=12

Lines starting with “'#” are treated as comments.

Note: This example is a UNIX properties file. When you install Tivoli Storage
Manager for ERP in silent mode for Windows, use the corresponding Windows
properties file.

Installing Tivoli Storage Manager for ERP for DB2 on UNIX or Linux
Data Protection for SAP for DB2 is delivered as a single executable file for each
operating system. Use the executable file to start the installation wizard and to
install the product.

About this task

Packages on the FTP server contain “FTP” before the operating system designation.
v For a disk or disk image, the name has the following format:
version-TIV-TSMERPDB2-platform
When the file is started, the Tivoli Storage Manager for ERP installation wizard
guides you through the procedure. Read the descriptions carefully and follow the
guidelines that are displayed on the windows.

Shared libraries have different file extensions on different UNIX or Linux operating
systems. Within the following the section, the file extensions of shared libraries are
represented as ext. Replace this text with the extension that applies to your
operating system:

26 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Table 1. File Extensions for Shared Libraries
Operating System Extension
AIX a
HP-UX sl
Linux so
Solaris so

Procedure
1. Log in as the root user on the SAP database server system.
2. Verify that the DISPLAY variable is set to view the installation prompts through
a graphical X-Window.
3. Start the DB2 instance. The installation program makes the necessary updates
to the DB2 configuration.
4. Start the Tivoli Storage Manager for ERP executable file and follow the
installation prompts.
5. View the summary in the last page of the installation wizard. The Tivoli
Storage Manager for ERP installation path is displayed in the summary where
the installation log file (log.txt) is located.

Results

These modifications are automatically done to your system during installation:


v An entry is created in /etc/inittab that automatically starts the "ProLE"
daemon.on UNIX systems. If upstart is configured, /etc/init/prole_db2.conf is
created and upstart starts the "ProLE" daemon.
v An entry is created in /etc/inittab that automatically starts the “ProLE”
daemon on UNIX systems. If upstart is configured, /etc/init/prole_db2.conf is
created and upstart starts the “ProLE” daemon.
v The environment variable XINT_PROFILE specifies the Tivoli Storage Manager
for ERP profile that is in the path that is specified for configuration files during
installation. The file name is initSID.utl where SID is the DB2 database SID
specified during installation.
v The environment variable TDP_DIR points to the path where Tivoli Storage
Manager for ERP configuration files and process logs are. The default path is
profile path/tdplog where profile path is the path that is specified for the
Tivoli Storage Manager for ERP profile during installation.
v The environment variable XINT_NLS_CATALOG_PATH points to the installation path
of Tivoli Storage Manager for ERP. The message catalog is located under DP for
SAP install path/lang where DP for SAP install path is the installation path
/usr/tivoli/tsm/tdp_r3/db264.
v If the DB2 instance is running, the installation program sets the DB2 database
configuration parameter VENDOROPT to the Tivoli Storage Manager for ERP
vendor environment file. If VENDOROPT is already set (for example, because of the
installation of a previous version), the program uses its value and does not set
VENDOROPT. If DB2 log archiving is not to be managed by Tivoli Storage Manager
for ERP, the corresponding database configuration settings are not modified. If
DB2 log archiving is to be managed by Tivoli Storage Manager for ERP, the
corresponding DB2 database configuration values are set based on the method
that is selected during installation:

Chapter 3. Installing Data Protection for SAP for DB2 27


LOGARCHMETHn VENDOR:/path/library
LOGARCHOPTn /path/vendor.env

If the DB2 instance was not running, you must complete these tasks manually, as
described in “Specifying the VENDOROPT parameter” on page 44 and
“Configuring the DB2 Log Manager” on page 44.

An entry is created in /etc/inittab that automatically starts the "ProLE"


daemon.on UNIX systems.

The EN_US folder is created, which contains the message catalog file tsmerp.cat.
The _uninst folder is also created, which contains more files.

These files are installed in the Tivoli Storage Manager for ERP installation
directory:
README
README_TSMERPversionlanguage.html
TIPHINTS
libtdpdb264.a (AIX)
libtdpdb264.so (Linux or Solaris)
ProLE
backom
createinfo
initSID.utl
SanFSsetupFS.sh (AIX only)
agent.lic (only after installation from disc or disc image)

The folder EN_US is created and it contains the message catalog tsmerp.cat. The
_uninst folder is also created, which contains sample files.

These files are installed in the directory where the Tivoli Storage Manager for ERP
configuration files are located:
initSID.utl
vendor.env
agent.lic (copy of file in installation directory)

Uninstalling the old version of Tivoli Storage Manager for ERP


for DB2 (UNIX or Linux)
Follow the procedure to uninstall a previous version of IBM Tivoli Storage
Manager for Enterprise Resource Planning:

Procedure
1. Log in as root user.
2. Make sure that the DISPLAY variable is set correctly as the uninstall procedure
requires a graphical X-Window.
3. Make sure the previous version of Tivoli Storage Manager for ERP for DB2 is
not running.
4. Start the uninstall executable file as shown here:
AIX 64-bit:
For version before 6.1:
/usr/tivoli/tsm/tdp_r3/db264/_uninst/uninstaller.bin [-silent | -console]
For Version 6.1 or later:
/usr/tivoli/tsm/tdp_r3/db264/Uninstall_TIV-TSMERPDB2/
Uninstall_TIV-TSMERPDB2 [-i silent | -i console]

28 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Other UNIX 64-bit or Linux 64-bit:
For version before 6.1:
/opt/tivoli/tsm/tdp_r3/db264/_unist/uninstaller.bin [-silent | -console]
For Version 6.1 or later:
/opt/tivoli/tsm/tdp_r3/db264/Uninstall_TIV-TSMERPDB2/
Uninstall_TIV-TSMERPDB2 [-i silent | -i console]

Follow the instructions of the uninstall dialog.

Installing Tivoli Storage Manager for ERP for DB2 in a Windows


environment
Tivoli Storage Manager for ERP for Windows is delivered as a single executable
file (.exe) for each operating system. Packages on the FTP server contain FTP
before the operating system designation.

About this task

Tivoli Storage Manager for ERP for these operating systems is delivered as a single
executable file for each operating system. The packages are named as follows:
v The package name on the disk or the disk image, which is shown in this
example:
version-TIV-TSMERPDB2-platform

Procedure
1. Log in as a user with administrator authority on the SAP database server
system.
2. If you want the installation program to make updates to the DB2 configuration,
start the DB2 instance.
3. Start the Tivoli Storage Manager for ERP executable file, and follow the
instructions of the installation dialog.
4. View the summary on the last page of installation wizard. The Tivoli Storage
Manager for ERP installation path is displayed in the summary where the
installation log file (log.txt) is located.

Results

The following modifications are done on your system during installation:


v The ProLE service is installed and started.
v An entry is created in %windir%\system32\drivers\etc\services (tdpr3db264).
v (Optional) The DSMI_DIR, DSMI_CONFIG, and DSMI_LOG environment variables are
modified.
v The XINT_PROFILE environment variable specifies the Tivoli Storage Manager
for ERP profile in the path that is specified during installation. The file name is
initSID.utl where SID is the DB2 database SID specified during installation.
v The TDP_DIR environment variable specifies the directory where Tivoli Storage
Manager for ERP saves the configuration file and creates its process logs.
Initially, this path is set to profile path\tdplog where profile path is the path for
Tivoli Storage Manager for ERP profile that is specified during installation.
v The environment variable XINT_NLS_CATALOG_PATH points to the installation path
of Tivoli Storage Manager for ERP. The message catalog is located under DP for

Chapter 3. Installing Data Protection for SAP for DB2 29


SAP install path\lang where DP for SAP install path is the installation path
that is specified by the user during the installation.
v If the DB2 instance is running, the installation program sets the DB2 database
configuration parameter VENDOROPT to the Tivoli Storage Manager for ERP
vendor environment file. If VENDOROPT is already set (for example, because of
the installation of a previous version), the program uses its value and does not
set VENDOROPT. If DB2 log archiving is not to be managed by Tivoli Storage
Manager for ERP, the corresponding database configuration settings are not
modified. If DB2 log archiving is to be managed by Tivoli Storage Manager for
ERP, the corresponding DB2 database configuration values are set based on the
method that is selected during installation:
LOGARCHMETHn VENDOR:path\tdpdb2.dll
LOGARCHOPTn drive:\path\vendor.env

If the DB2 instance is not running, these tasks must be run manually as
described in “Specifying the VENDOROPT parameter” on page 44 and
“Configuring the DB2 Log Manager” on page 44.

The following files are installed in the Tivoli Storage Manager for ERP installation
directory:
README.txt
README_TSMERPversionlanguage.html
TIPHINTS.txt
tdpdb2.dll
ProLE.exe
backom.exe
createinfo.exe
initSID.utl
agent.lic (only after installation from disc or disc image)

The _uninst folder is also created, which contains sample files.

These files are installed in the directory where the Tivoli Storage Manager for ERP
profile is located:
initSID.utl (’SID’ is replaced by the DB2 database SID provided during installation)
vendor.env
agent.lic (copy of file in installation directory)

Enabling ProLE to access configuration files on a remote


share (Windows)
When ProLE is started as a regular service, it operates under the ID of the local
system account with Administrator privileges. However, a session opened on a
remote system does not have credentials or permissions. You must grant access to
ProLE to access the files on a remote share.

About this task

ProLE sessions on a remote system cannot access files that are on that remote
share. This condition is true even when the share is mapped to a local drive letter
or is accessed as a Uniform Naming Convention (UNC) notation (\\server\path\).
Data Protection for SAP for DB2 accepts UNC notation for the profile but not for
all the files that are specified within the profile. These files are opened by ProLE,
which by default has no permission to access remote shares, as explained.

30 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Microsoft knowledge base article 132679 provides information about this situation:
http://support.microsoft.com/kb/132679.

Follow the procedure to enable ProLE to access all files on a remote share:

Procedure
1. Map the share where the configuration files are to a local drive letter.
2. Modify the profile (.utl) to refer to the path names on the mapped drive.
3. Modify the ProLE service so that it runs as an account with permissions to
access the mapped drive, and not as a local system account. There might be
other implications when you use a regular account. For example, when the
password for this account expires or is changed, the service is no longer able to
start.
4. Restart the ProLE service to activate the changes.

Uninstalling an older version of Data Protection for SAP for


DB2 (Windows)
Follow these steps to uninstall a previous version of Data Protection for SAP for
DB2 in a Windows environment.

Procedure
1. Log on as a user with administrator authority on the SAP database server
system.
2. Ensure that the previous version of Data Protection for SAP is not running.
3. Select Start > Settings > Control panel.
4. Click Add/Remove Programs.
5. Select the old version of Data Protection for SAP and click Remove.
6. Follow the instructions of the uninstall procedure.

Verify the installation or upgrade


When you complete the installation or upgrade of the product, you can verify that
the procedure was successful by running a backup task.

To verify the installation of Data Protection for SAP for DB2, do a full DB2
database backup. Then, restore with the DB2 Control Center or DB2 command line
processor (CLP).

Before you start, you must plan to run a complete offline backup. Then you can
run a complete restore or recovery of the entire SAP database for verification.

Preparing to install the Administration Assistant


The Administration Assistant for Data Protection for SAP is a web-browser based
graphical interface. It provides customization, simulation, and analysis of SAP
database backup, restore, and configuration operations.

Before you begin

When you upgrade from an earlier version of the Administration Assistant for
Data Protection for SAP, the latest version is available for download from the IBM
FTP server. More upgrade information is available in “Upgrading the

Chapter 3. Installing Data Protection for SAP for DB2 31


Administration Assistant for Data Protection for SAP” on page 36.

About this task

Prepare to install the Administration Assistant for Data Protection for SAP with the
following steps.

A setup assistant is included in the Administration Assistant package that helps


guide the installation process in English or a chosen language.

Procedure
v Ensure that you have system administrator privileges that are needed to install
the Administration Assistant.
v If you are installing in a multi-host environment, distributing the server-level
components over two or more hosts, you need to copy the package file to each
target host.
v Plan to run a custom installation so that components are selected for specific
hosts. The CLASSPATH environment variable is not needed. However, if this
variable is set, you must specify the directory in which the package file is in.
v If you want to switch the language specified during installation, the
Administration Assistant must be uninstalled and installed again with the
preferred language.

Prerequisites for installing the Administration Assistant for


Data Protection for SAP
There are server level, and client level components that must be installed and
configured before you can use the Administration Assistant for Data Protection for
SAP.

Server-level components
The following products must be installed before you set up the Administration
Assistant for Data Protection for SAP server-level components:
v Java Runtime Environment (JRE) or Java Development Kit (JDK)
v JavaBeans Activation Framework (JAF)
v JavaMail
v IBM DB2 data server (optional DBMS for Administration Assistant database if
you do not want to use the Apache Derby database that is already bundled with
the Administration Assistant installation package). If you choose to use DB2,
ensure that DB2 is running. In addition, UNIX and Linux systems require that a
dedicated system user (for which the DB2 instance must be installed) be created.
v For software, hardware, and maintenance levels that are required by the current
version of the Administration Assistant, refer to the Data Protection for SAP for
DB2 release notes.
v TCP/IP must be ready for communication before you start the Administration
Assistant server-level components.

Client components

These requirements must be met before you start the Administration Assistant for
Data Protection for SAP client:

32 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v A Java capable web browser with Java plug-in. The applet that is loaded from
the Administration Assistant server must be granted the following access:
– Permission to establish a connection to the Administration Assistant server
through RMI. For example:
permission java.net.SocketPermission "Server component hostname:1024-", "connect";

– Permission to switch to a different language. For example:


permission java.util.PropertyPermission "user.language", "write";

v To view report graphics, a browser that supports Scalable Vector Graphics


(SVG), such as Adobe SVG Viewer, must be available.
v (UNIX or Linux): An X Window System is required for the Administration
Assistant client.
v A minimum screen resolution of 1024x768 pixels, 1280x1024 works best.
v For software and maintenance levels that are required by the current version of
the Administration Assistant, refer to the Data Protection for SAP release notes.
v TCP/IP must be ready for communication before you start the Administration
Assistant server-level components.

Scheduling client

These requirements must be met when you select the scheduling client:
v A TCP/IP connection can be established to the Administration Assistant Server
component.
v A Java VM is available.
v To view report graphics, a browser that supports Scalable Vector Graphics
(SVG), like Adobe SVG Viewer, must be available.

Installation Planning for Server-Level Components

See Table 11 on page 158 for a list of planning requirements in table form. This
information is also available in the planning_sheet_aa (UNIX or Linux) and
planning_sheet_aa.txt. (Windows) files in the Data Protection for SAP installation
directory.

Installing the Administration Assistant for Data Protection for


SAP server-level components
Install the Administration Assistant for Data Protection for SAP server-level
components for use with Data Protection for SAP and for DB2.

About this task

Initial installations must be run from the installation disk or disk image. Refer to
the README.1ST file in the root path of the disk or disk image for information. The
Administration Assistant installation packages are on each of the Data Protection
for SAP for DB2 disks or disk images, and can be downloaded from the IBM FTP
server. The Administration Assistant installation package is a single,
platform-independent JAR file with the following naming convention:
version-TIV-TSMERPAABASE-MULTI.jar
java -jar package file name

Chapter 3. Installing Data Protection for SAP for DB2 33


After the first component is installed, an overview panel displays the installation
status, and records user entries.

Procedure

Specify the following command to start the installation: java -jarpackage file
name

34 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 4. Upgrading Data Protection for SAP for DB2
Information needed to upgrade to Tivoli Storage Manager for Enterprise Resource
Planning: Data Protection for SAP for DB2 is provided.

About this task

Follow the tasks to upgrade to Data Protection for SAP for DB2.

Upgrading the Data Protection for SAP for DB2 base product
Upgrade Data Protection for SAP from an earlier version.

About this task

The format of the configuration file (.bki) was changed with version 5.4. The
software accepts the previous format and converts it automatically. If it is
necessary to use a version earlier than 5.4, the old format can be recovered by
overwriting the new file with the empty file. The previous version provides the
empty file. The file must then be initialized by setting the Tivoli Storage Manager
password. However, the information about the current backup number is lost. As a
result, more backup versions must be retained for a longer time than is specified
by the MAX_VERSIONS parameter.

Procedure
1. Verify that the Data Protection for SAP for DB2 package is complete. The
installation packages are provided on a disc or disc image (downloadable
from Passport Advantage), or the IBM FTP server. See the release notes file in
the Tivoli Information Center for the most current release information.
2. Check the readme files and release notes for incompatibilities between the
installed version and the new version. Make sure that data backed up with an
older version of Tivoli Storage Manager for Enterprise Resource Planning can
still be restored with the version to be installed.
3. Make sure that the requirements for the new version of Data Protection for
SAP are met as described in “Prerequisites” on page 24.
4. Make sure that planning information is available as described in
“Prerequisites” on page 24.
5. A full backup of the SAP database must be performed before you upgrade to
the new version.
6. Uninstall the old version as described in “Uninstalling the old version of
Tivoli Storage Manager for ERP for DB2 (UNIX or Linux)” on page 28 or
“Uninstalling an older version of Data Protection for SAP for DB2 (Windows)”
on page 31.
7. Install the new version of Data Protection for SAP as described in
“Prerequisites” on page 24.
8. Update the Data Protection for SAP profile as described in “Migrate the Data
Protection for SAP for DB2 profile” on page 36.
9. Create the configuration file or files as described in “Creating the
configuration files” on page 46.

© Copyright IBM Corp. 1995, 2014 35


10. Perform the necessary configuration tasks as described in “Configure the
Tivoli Storage Manager client options” on page 54.
11. Verify the installation as described in “Verify the installation or upgrade” on
page 31.
12. A full backup must be performed after you upgrade to the new version.

Migrate the Data Protection for SAP for DB2 profile


The license file, the profile, and the configuration files are not deleted when Data
Protection for SAP for DB2 is uninstalled. These files can be used by the new
version of Data Protection for SAP. To reuse the existing configuration and
connection to the Tivoli Storage Manager server, choose not to change the profile
when you are prompted during installation.

Upgrading the Administration Assistant for Data Protection for SAP


Upgrade the Administration Assistant for Data Protection for SAP server to a new
version.

Procedure
1. Verify that the Administration Assistant package is complete. The
Administration Assistant is provided on each of the Data Protection for SAP
installation disks or disk images, or downloaded from the IBM FTP server.
2. Verify that the new Administration Assistant requirements are met as described
in “Prerequisites for installing the Administration Assistant for Data Protection
for SAP” on page 32. The Data Protection for SAP for DB2 release notes contain
the latest requirement information.
3. Review planning information as described in “Prerequisites for installing the
Administration Assistant for Data Protection for SAP” on page 32.
4. If you plan to move existing data to the new version, follow the tasks that are
described at this link “Copying the Administration Assistant from a previous
release” on page 37.
5. Uninstall the old version of the Administration Assistant as described in
“Installing the Administration Assistant for Data Protection for SAP server-level
components” on page 33.
6. Install the new version of the Administration Assistant server-level components
as described in “Installing the Administration Assistant for Data Protection for
SAP server-level components” on page 33.
7. Run the configuration tasks. Begin with “Preparing a secure connection” on
page 47.
8. Set up the Administration Assistant client as described in “Configuring the
Administration Assistant for Data Protection for SAP client” on page 48.
9. Verify the installation as described in “Verifying the Administration Assistant
for Data Protection for SAP installation” on page 49.

Results

Note: It is possible to use the Administration Assistant with supported Data


Protection for SAP versions before version 5.4. The Administration Assistant must
be installed on a single host.

36 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Copying the Administration Assistant from a previous release
Before you uninstall and reinstall a new version of the Administration Assistant,
use the report function to capture data to be used with the new version.

Procedure
v From the installation disk, export existing database data to a new directory.
v During the installation of the Administration Assistant, update an existing
database with the saved database.
v Copy existing styles and reports to a new directory.
v During the installation of the Administration Assistant, when asked if you want
to import old data, enter the directory where the existing database is stored.

Copying database data


You can reuse data from the database of a previous version of the product before
you install a new version.

Before you begin

Make a backup of the current Administration Assistant for Data Protection for SAP
database before you start the migration process.

Procedure
1. From Administration Assistant for Data Protection for SAP
a. Export the following files from the Data Protection for SAP for DB2
installation disk (or disk image) in the migration directory.
v aaDerbyAdaption.jar
v prepareExport.sql c.
v export.cmd (for use with Windows systems)
v export.sh and export ksh (for use with UNIX/Linux systems)
b. If you are using Apache Derby, get information about how to connect to the
Apache Derby database. These settings are provided in file assist.cfg and
are listed:
v Location of your previous installation of the Administration Assistant
v User name to connect to the Apache Derby database
v Password to connect to the Apache Derby database
v Port to connect to the Apache Derby database
v Host name of your system
v Name of the database
v Path to file aaDerbyAdaption.jar
v Directory where the data is exported
c. Start the export script. The script guides you through the export process.
The directory that you specify in this step is the same directory from which
you can import data to the newer version of the product during the
installation process.
2. From Administration Assistant for Data Protection for SAP:
When you are asked which components to uninstall, specify the Administration
Assistant server and Database Agent. Do not uninstall the currently running
database during the Administration Assistant uninstallation process. You can
access data from the currently running Administration Assistant database in a
newer version of the Administration Assistant database of the same type.

Chapter 4. Upgrading Data Protection for SAP for DB2 37


3. When you install the newer version of the Administrative Assistant database,
you are asked if you want to update an existing database. If you choose this
option, and are using the Apache Derby database, specify the directory that
contains the existing database. (The default directory is AA_install_dir/
aaDBSupport). If you are using DB2, specifying an import directory is not
necessary.
4. To keep performance data that is not kept in the database, back up the
complete history directory, including its subdirectories, before you uninstall the
old version. After you install the new version, copy the performance data into
the new installation directory. As a result, the export directory contains several
*.aa files.
5. During the installation process, you are asked if you want to import old data.
Within this dialog box, you can enter the export directory that you selected
during the export.

Reusing styles and report templates


You can reuse your existing styles and report templates from a previous version of
the product.

About this task

During the installation of the Administration Assistant for Data Protection for SAP,
all data in the installation directory is removed.

Procedure
v Before you install a new version of the Administration Assistant, save the
directories that contain the styles and report templates from the installation
directory to another directory.
v After the installation process, copy the directories you want back into the
installation directory of the Administration Assistant.

38 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 5. Configuring
In addition to configuring Data Protection for SAP you need to configure other
applications, for example, the Tivoli Storage Manager backup-archive client.

About this task

Data Protection for SAP requires certain configuration tasks to be run for these
applications:
v Data Protection for SAP base product
v Administration Assistant
v DB2 Log Manager and related DB2 files
v HACMP
v Distributed File System
v Tivoli Storage Manager backup-archive client
v Tivoli Storage Manager server

Changing configuration tasks for the Data Protection for SAP base
product
Instructions about how to configure the Data Protection for SAP base product are
provided.

About this task

Data Protection for SAP requires that you complete certain configuration tasks
before it runs a backup operation. Optional configuration tasks are identified in
their description.

Configuring profile tasks


To configure the Data Protection for SAP profile file, you must set the server
statement and in the Tivoli Storage manager client options file.

Set the SERVER statement in the Data Protection for SAP profile
The SERVER statement is specified in the Data Protection for SAP profile, and in
the Tivoli Storage Manager client option file.

There are corresponding keywords in the Tivoli Storage Manager client option file.
Depending on the choice of password handling, some parameters are ignored. The
corresponding sections in the Data Protection for SAP profile and the Tivoli
Storage Manager client option file are established by using the logical server name.
This logical server name is defined by the keywords SERVER or SERVERNAME.

The logical server names are also used by the View TSM Server Utilization
function of the Administration Assistant. This function generates a separate entry
for each logical server name that is found in the system landscape. Identical logical
server names are considered to represent the same server.

© Copyright IBM Corp. 1995, 2014 39


Table 2. SERVER statement and appropriate profile and option file settings.
Configuration possibilities Data Protection for SAP profile Tivoli Storage Manager client option
initSID.utl file dsm.sys or server.opt [2]
single path; no password or manual SERVER server SERVERNAME server
password ADSMNODE node[1] TCPSERVERADDRESS address
NODENAME do not specify
single path; automatic password by SERVER server SERVERNAME server
Tivoli Storage Manager ADSMNODE do not specify NODENAME node
TCPSERVERADDRESS address
several paths/servers; no password SERVER server 1 SERVERNAME server 1
or manual password ADSMNODE node 1 NODENAME do not specify
TCPSERVERADDRESS address 1
SERVER server 1
ADSMNODE node n SERVERNAME server n
NODENAME do not specify
TCPSERVERADDRESS address n
several paths/servers; automatic SERVER server 1 SERVERNAME server 1
password by Tivoli Storage ADSMNODE do not specify NODENAME do not specify
Manager[3] TCPSERVERADDRESS address 1
SERVER server n
ADSMNODE do not specify SERVERNAME server n
NODENAME do not specify
TCPSERVERADDRESS address n
several paths/servers; automatic SERVER server SERVERNAME server
password by Tivoli Storage Manager ADSMNODE do not specify NODENAME node
[4]
TCP_ADDRESS address 1 TCPSERVERADDRESS address

SERVER server n
ADSMNODE do not specify
TCP_ADDRESS address n

Notes:
[1] If ADSMNODE is not specified, the host name is used.
[2] On UNIX or Linux, dsm.sys is the single client option file for all Tivoli
Storage Manager servers.
On Windows, there is a separate client option file server.opt for each
Tivoli Storage Manager server.
[3] If two different physical systems have the same Tivoli Storage Manager
node name or if multiple paths are defined on one node by using several
server stanzas, passwordaccess generate might work only for the first
stanza that is used after password expiration. During the first client/server
contact, the user is prompted for the same password for each server stanza
separately. A copy of the password is stored for each stanza. When the
password expires, a new password is generated for the stanza that
connects the first client/server contact. All subsequent attempts to connect
through other server stanzas fail because there is no logical link between
their copies of the old password and the updated copy. The updated copy
is generated by the first stanza that is used after password expiration. To
avoid this situation, update the passwords before they expire. When the
passwords are expired, run these tasks to update the password:
1. Run dsmadmc and update the password on the server.
2. Run dsmc -servername=stanza1 and use the new password to generate
a valid entry.

40 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
3. Run dsmc -servername=stanza2 and use the new password to generate
a valid entry.
[4] If you are using Tivoli Storage Manager API 5.5 (or later), you can use the
TCP_ADDRESS parameter in the Data Protection for SAP profile. This
parameter eliminates the requirement to set multiple stanzas in the Tivoli
Storage Manager client option file for multiple paths. The parameter also
eliminates the problem when it updates the password (see [3]).

Example of SERVER statement with alternate paths:

This example assumes that the Tivoli Storage Manager server is configured with
two tape drives and two LAN connections. A backup is typically processed
through network path 1 (SERVER statement 1). If network path 1 is unavailable, the
backup is processed by using network path 2 (SERVER statement 2). If path 1 is
active, Data Protection for SAP for DB2 begins the two sessions as defined in the
SERVER statement for path 1. Since MAX_SESSIONS also specifies 2, no more sessions
are started. If path 1 is inactive, Data Protection for SAP starts two sessions on
path 2. Since MAX_SESSIONS specifies 2, the backup is processed by using path 2.

The Data Protection for SAP profile that is used in this alternate path configuration
is shown in the following example:

MAX_SESSIONS 2 # 2 tape drives


.
.
SERVER server_a # via network path 1
ADSMNODE C21
SESSIONS 2
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS mdb
BRARCHIVEMGTCLASS mlog1 mlog2
# USE_AT 0 1 2 3 4 5 6

SERVER server_b # via network path 2


ADSMNODE C21
SESSIONS 2
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS mdb
BRARCHIVEMGTCLASS mlog1 mlog2
# USE_AT 0 1 2 3 4 5 6

Even if the logical names server_a and server_b actually point to the same Tivoli
Storage Manager server, the Administration Assistant still considers them to be two
different servers.

Example of SERVER statement with parallel servers:


This example assumes the following configuration:
v Two Tivoli Storage Manager servers (each with two tape drives) with
connections through two network paths:
– server_a uses TCP/IP address xxx.xxx.xxx.xxx
– server_b uses TCP/IP address yyy.yyy.yyy.yyy
v An SAP® database server that is connected to two networks.
v Daily backups are run on both systems.

The following is an example of the Data Protection for SAP for DB2 profile that is
used in this parallel configuration:

Chapter 5. Configuring 41
MAX_SESSIONS 4 # 4 tape drives
.
.
SERVER server_a # via network path 1
ADSMNODE C21
SESSIONS 2
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS MDB
BRARCHIVEMGTCLASS MLOG1 MLOG2 MLOG3 MLOG4
# USE_AT 1 2 3 4 5 6 7

SERVER server_b # via network path 2 ADSMNODE C21


SESSIONS 2
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS MDB
BRARCHIVEMGTCLASS MLOG1 MLOG2 MLOG3 MLOG4
# USE_AT 1 2 3 4 5 6 7

Example of SERVER statement with alternate servers:

Data Protection for SAP profile is used in certain disaster recovery configurations.

This example assumes the following configuration for two servers a and b:
v Two Tivoli Storage Manager servers:
– server_a uses TCP/IP address xxx.xxx.xxx.xxx and uses four tape drives
(MAX_SESSIONS 4)
– server_b uses TCP/IP address yyy.yyy.yyy.yyy and uses four tape drives
(MAX_SESSIONS 4)
v An SAP database server that is connected to this FDDI network.
v Normal backups are processed with server a, which is local to the SAP database
server.
v A disaster recovery backup is stored on remote server b every Friday.

The following is an example of the Data Protection for SAP profile that is used in
this disaster recovery configuration:

MAX_SESSIONS 4 # 4 tape drives


.
.
SERVER server_a # via network path 1
ADSMNODE C21
SESSIONS 4
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS MDB
BRARCHIVEMGTCLASS MLOG1 MLOG2 MLOG3 MLOG4
USE_AT 1 2 3 4

SERVER server_b # via network path 2


ADSMNODE C21
SESSIONS 4
PASSWORDREQUIRED YES
BRBACKUPMGTCLASS MDB
BRARCHIVEMGTCLASS MLOG1 MLOG2 MLOG3 MLOG4
USE_AT 5 # for Disaster Recovery

42 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
DB2 tasks
When you are configuring Data Protection for SAP for DB2, you must do some
additional steps to complete the process.

Procedure
v Review the vendor environment file vendor.env, and the Data Protection for
SAP profile file.
v Set the VENDOROPT parameter for backup and restore commands.
v Configure parameters for DB2 Log Manager.
v Create configuration files for DB2 partitions.

DB2 and Data Protection for SAP for DB2 configuration


guidelines
Data Protection for SAP for DB2 data transfer functions are implemented in a
shared library that is accessed by DB2. When back up or restore operations are
started, and log archive or log retrieve commands are entered, the shared library is
accessed. This library requires information about the path of the Data Protection
for SAP profile and the path of the log files that are written by Data Protection for
SAP.

BACKUP DATABASE and RESTORE DATABASE

If an action is initiated by using the DB2 commands BACKUP DATABASE or RESTORE


DATABASE, the information that is required must be specified in a vendor
environment file. The name of the vendor environment file is sent to DB2 through
either the OPTIONS parameter of the BACKUP DATABASE or RESTORE DATABASE
commands. It can also be stored persistently in the database configuration
parameter VENDOROPT. For log archive or log retrieve, this file can be stored
either in the database configuration parameter LOGARCHOPT1 or in
LOGARCHOPT2. For BACKUP DATABASE or RESTORE DATABASE, use of the OPTIONS
keyword for this purpose is no longer necessary. It is advised that you keep the
settings in the vendor environment file and in the system variables synchronized
continually. For an example of a Data Protection for SAP vendor environment file,
see “Vendor environment file sample” on page 157. If BACKUP DATABASE or RESTORE
DATABASE is triggered through the backom utility, the information that is required
must be specified in the environment.

Vendor environment file

Consider the following adjustment rules for Data Protection for SAP:
v To select different Data Protection for SAP environment settings for a DB2
backup or restore, specify the full path of the vendor environment file in the
OPTIONS parameter of the BACKUP DATABASE or RESTORE DATABASE commands.
For details, refer to the DB2 Command Reference
v To select a different Data Protection for SAP profile, modify the environment
variable XINT_PROFILE to denote the new profile in the vendor environment
file.
v To select a different Data Protection for SAP profile for future calls to the
backom utility, modify the environment variable XINT_PROFILE to denote the
new profile.
v To select a different Data Protection for SAP profile for a call to the backom
utility, specify the path of the new profile in option –e of the backom command.

Chapter 5. Configuring 43
v To change the path for Data Protection for SAP process log files for a call to DB2
commands BACKUP DATABASE or RESTORE DATABASE, modify the environment
variable TDP_DIR in the vendor environment file. Specify the file path in the
OPTIONS parameter of the BACKUP DATABASE or RESTORE DATABASE commands.
v To change the path for Data Protection for SAP process log files for future calls
to the backom utility, modify the environment variable TDP_DIR to denote the
new profile.

Specifying the VENDOROPT parameter


You can select a default set of Data Protection for SAP for DB2 environment
settings for commands BACKUP DATABASE, RESTORE DATABASE, and for the DB2 Log
Manager.

About this task

This command can be used as an alternative to the db2set command and provides
these advantages:
v You do not need to restart the DB2 instance.
v You can define default values for the OPTIONS parameter of the BACKUP DATABASE
command in the DB2 configuration.
v You can define default values for the OPTIONS parameter of the RESTORE
DATABASE command in the DB2 configuration.
v The same settings can be applied to database backup and restore, and to log file
archive and retrieve options.
When you use the BACKUP DATABASE and RESTORE DATABASE commands with the USE
SNAPSHOT option for snapshot-based backup and restore by DB2 ACS or FlashCopy
Manager, the VENDOROPT parameter is ignored. In this case, any options other than
the default values must be set by using the OPTIONS keyword.

Procedure
1. Modify the DB2 database configuration to denote a file that contains the
following settings: db2 update db cfg for SID using LOGARCHOPT1|2 vendor
environment file, where vendor environment file is the fully qualified path of
the file that contains Data Protection for SAP environment settings for DB2.
2. Verify that the environment settings of your system match the settings in this
file.

Configuring the DB2 Log Manager


To activate log archival or retrieval with the DB2 Log Manager facility, modify the
DB2 database configuration during the installation. The following two changes to
the database configuration are the minimum changes necessary to use the DB2 Log
Manager with Data Protection for SAP

Procedure
1. Update one of the LOGARCHMETH database configuration parameters (this
example uses LOGARCHMETH1):
v (UNIX and Linux):
db2 update db cfg for SID using LOGARCHMETH1 VENDOR:/path/shared library

v (Windows):
db2 update db cfg for SID using LOGARCHMETH1 VENDOR:drive:\path\tdpdb2.dll

44 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
2. Update the Data Protection for SAP environment. A file that contains the
environment settings must be made available to DB2 to allow DB2 to provide
this environment for Data Protection for SAP archive or retrieve requests. This
file is an extra requirement. This example shows the setup that is needed by
Data Protection for SAP for LOGARCHMETH1:
v (UNIX and Linux):
db2 update db cfg for SID using LOGARCHOPT1 /path/vendor.env

v (Windows):
db2 update db cfg for SID using LOGARCHOPT1 drive:\path\vendor.env

The update to LOGARCHMETH takes effect during the next log file archive.

Results

The following database configuration parameters are applicable to DB2 database


backup and restore, and log archive and retrieve with Data Protection for SAP:
Table 3. Configuration parameters for DB2 database backup and restore, and log archive
and retrieve
Parameter Description Default
LOGARCHMETH1 Media type of the primary Off
destination for archived log
files
LOGARCHOPT1 Options field for the primary NULL
destination for archived log
files (if required).
LOGARCHMETH2 Media type of the secondary Off
destination for archived log
files. If this path is specified,
log files are archived to both
this destination and the
destination that is specified
by LOGARCHMETH1.
LOGARCHOPT2 Options field for the NULL
secondary destination for
archived log files (if
required).
FAILARCHPATH If DB2 is unable to archive NULL
log files to both the primary
and secondary (if set) archive
destinations because of a
media problem, then DB2
tries to archive log files to
this path. This path must be
a disk.

Chapter 5. Configuring 45
Table 3. Configuration parameters for DB2 database backup and restore, and log archive
and retrieve (continued)
Parameter Description Default
NUMARCHRETRY Number of retries to archive 5
a log file to the primary or
secondary archive
destination before log files
are archived to a failover
directory. This option is used
only if FAILARCHPATH is
set. If NUMARCHRETRY is
not set, DB2 continuously
tries to archive again to the
primary or secondary log
archive destination.
ARCHRETRYDELAY Number of seconds to wait 2
after a failed archive attempt
before it tries to archive the
log file again. Subsequent
retries take effect only if
NUMARCHRETRY is at least
set to 1.

The database configuration parameters LOGRETAIN and USEREXIT are still available
but are mapped to the parameter LOGARCHMETH1. For further description of the DB2
Log Manager, see the DB2 Administration Guide. Configure Data Protection for SAP
so that at least one Tivoli Storage Manager session is available for each of these
operations. One session is needed for the database backup and one is for the log
archives.

Creating the configuration files


When you set the Tivoli Storage Manager password with the backom utility, the
configuration files for all DB2 partitions are automatically created in the paths
path/%DB2NODE/.

About this task

The path is the directory is the value of keyword CONFIG_FILE in the profile.
%DB2NODE is replaced automatically by a DB2 partition name that is referenced in
the DB2 configuration file db2nodes.cfg.

Procedure
v If the directory denoted by the value of keyword CONFIG_FILE is not in the same
network file system as the DB2 configuration file db2nodes.cfg, you must set the
password for each system where a partition of the database is located.
v If the database is not partitioned, NODE0000 is used as the only DB2 partition
name.

46 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Optional: Setting backup object segmentation
Environments that contain large databases that rapidly increase in size might
encounter problems when data is transferred to the Tivoli Storage Manager server.
For example, you might encounter the following problems when you back up or
restore large databases:
v Canceling a running backup session takes an unacceptably long time. This
behavior is because of multiple internal processing activities on the Tivoli
Storage Manager server.
v The recovery log for the Tivoli Storage Manager internal database might become
unavailable when large databases are processed. This unavailability prevents
immediate access to important recovery data.
To avoid potential problems that are related to transferring large objects, use the
Data Protection for SAP SEGMENTSIZE profile keyword. This keyword specifies
the upper bound of the segments that are split from large backup objects during
backup and restore processing. For more information about the SEGMENTSIZE
keyword, see “Profile parameter descriptions” on page 140.

Setting up the Administration Assistant for Data Protection for


SAP
Data Protection for SAP for DB2 requires that Administration Assistant for working
with Data Protection for SAP tasks be configured.

Preparing a secure connection


By default, the Administration Assistant for Data Protection for SAP is set up to
accept unsecure (HTTP) client requests.

About this task

If the Administration Assistant was set up for secure (HTTPS) connection during
installation, then proceed to the next step.

The secure communication between the Administration Assistant Server


component and its clients is realized with the Secure Socket Layer (SSL) protocol.
This protocol requires that both the server and client are to integrate in a public
key infrastructure (PKI). The Server component requires these settings:
v An HTTPS port to listen on for HTTPS connect requests.
v A keystore that contains a key pair that it uses to identify itself to the clients and
when it connects internally to the RMI registry. The server host name is used as
an alias for this key pair. Since the keystore contains the server private key,
precautions must be taken that prevent access by unauthorized persons.
v A truststore that contains trusted certificates that allow verifying the server's
signature. If the server certificate was digitally signed by an official certificate
authority whose root certificate is available in the truststore by default, there is
nothing to be done. If however, the server identifies itself with a self-signed
certificate, this certificate must be imported into the truststore as well.
v Be sure to remove this trusted certificate from the truststore as soon as the
officially signed server certificate is available and employed. A setup that uses
self-signed certificates is not recommended for production environments.
v Both the keystore and truststore can be modified with your keystore
management tool. This tool varies by operating system and provider.

Chapter 5. Configuring 47
Procedure
1. Remove the keyword nonsecure from the Server configuration file (assist.cfg).
2. Specify the appropriate HTTPS port number in the Server configuration file:
httpsport=https port number

The default HTTPS port number is 443.


3. Add the keystore, keystore password, and truststore to the appropriate Java
call. The Java calls are shown in bold text:
-Djavax.net.ssl.keyStore=keystore
-Djavax.net.ssl.keyStorePassword=password for keystore
-Djavax.net.ssl.trustStore=truststore

v (UNIX and Linux): add the parameters to sadma.sh(Windows): add the


parameters to sadmt.cmd and to the registry. The following is the Windows
registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\...
...AdminAssistant\Parameters\AppParameters
If you do not specify one or more of these parameters, the defaults of your Java
virtual machine is used.
4. Make sure that the required certificates are contained in the keystore and
truststore.
5. Restart the Administration Assistant Server component.

Results

When you change the Administration Assistant server from nonsecure to secure
mode by using a self-signed certificate, remember to also prepare the
Administration Assistant clients. This action is described in “Configuring the
Administration Assistant for Data Protection for SAP client” and “Configuring a
scheduling client to create reports” on page 50.

Configuring the Administration Assistant for Data Protection for


SAP client
The Administration Assistant for Data Protection for SAP client starts a Java applet
when it connects to the Administration Assistant for Data Protection for SAP
Server component.

About this task

Make sure that these requirements are met when you set up the Administration
Assistant client:
v Make sure that all Administration Assistant Client prerequisites are met as
described in “Prerequisites for installing the Administration Assistant for Data
Protection for SAP” on page 32.
v The browser must be enabled to accept cookies.
v Advertisements and popup windows must not be blocked unless index.html is
used in the address.
v A secure connection requires that the client Java plug-in must be able to verify
the certificate that is presented by the Administration Assistant Server
component. In a production environment, this verification is typically done at
the server level. The server certificate is signed by an official certificate authority

48 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
whose root certificate is contained in the plug-in truststore. If the server
identifies itself with a self-signed certificate, this certificate must be imported
into the plug-in truststore. If you did not use the using the Java plug-in control
panel to replace the plug-in truststore, the file cacerts (in the Java security path)
is used as the truststore. The file is modified with the keystore management tool.
This tool varies by operating system and provider. For example, the Sun
Microsystems keytool is modified with the following command:
keytool -import -alias Server component hostname -file cert_file
-keystore trustore

v Be sure to remove the self-signed trusted certificate from the truststore as soon
as the officially signed server certificate is available and activated. A setup with
self-signed certificates is not recommended for production environments.

Verifying the Administration Assistant for Data Protection for


SAP installation
Verify the installation of the Administration Assistant for Data Protection for SAP
after the configuration step. Make sure to use the ADMIN user ID with password
admin for the initial login

About this task

Use the client function Administer Users to change the default password
immediately after a connection is established. As soon as an instance of Data
Protection for SAP for DB2 connects to your Administration Assistant Server
component, the instance is displayed in the list of Data Protection for SAP servers.
For details on how to set up your instance of Data Protection for SAP to connect to
a specific Server component, refer to “Specifying a new Administration Assistant
for Tivoli Storage Manager for ERP” on page 87.

Procedure
v Nonsecure connection: If the Server component was started with the keyword
“nonsecure” in the Server configuration file, connect to the Administration
Assistant Server component from a client system with this command:
http://Server component host name:http port

v Make the connection without opening a new browser window by entering this
command:
http://Server component host name:http port/index.html

v Secure connection: If the Server component was started with the keyword secure
in the Server configuration file, connect to the Administration Assistant Server
component from a client system with this command:
https://Server component host name:https port

v Make the connection without opening a new browser window by entering this
command:
https://Server component host name:https port/index.html

Chapter 5. Configuring 49
Configuring a scheduling client to create reports
A scheduling client/server must be set up to create reports with templates. Follow
the procedure to set up a scheduling client/server.

Procedure
1. Select a system that meets the requirements as described in “Prerequisites for
installing the Administration Assistant for Data Protection for SAP” on page 32.
2. Copy files Admt.jar and NLS.jar from the installation directory of the
Administration Assistant Server component to the scheduling client system.
Before you generate a report, make sure that these files are specified in the
CLASSPATH and that the JVM is included in the PATH. See “Scheduling a report,
shell script sample (UNIX)” on page 153 or “Scheduling a report, sample
command file (Windows)” on page 154 for a sample script.
3. In case the Administration Assistant Server component is started in secure
mode, set up a public key infrastructure between the scheduling client and the
Server component. In a production environment, this effort is typically done at
the server level. The server certificate is signed by an official certificate
authority whose root certificate is contained in the plug-in truststore. If the
server identifies itself with a self-signed certificate, this certificate must be
imported into the plug-in truststore. If you did not use the Java plug-in control
panel to replace the plug-in truststore, the file cacerts (in the Java security
path) is used as the truststore. The file is modified with the keystore
management tool. This tool varies by operating system and provider. For
example, the Sun Microsystems keytool is modified with this command:
keytool -import -alias <Server component hostname> -file cert_file
-keystore trustore

Threshold definitions
You can define limits and thresholds for various states with the Administration
Assistant for the Data Protection for SAP environment. The threshold status is
shown in the Monitor Backup States and Backup State - Detailed View panels.

The following list contains predefined threshold types:


v Backup duration (in minutes or hours)
v Backup size (in MB or GB)
v Throughput rate (in GB per hour or MB per second)
v Time since the last complete backup (in hours or days)
v Size of all log file backups since the last complete backup (in MB or GB)
v Recovery point objective (maximum time that is allowed since the last backup,
in minutes or hours)
When a threshold is exceeded, this condition is reported in the Threshold Status
column of the Monitor Backup States panel. Also, an email that describes the
exception in more detail is sent to any email addresses defined for the threshold. A
lifetime parameter that is associated with each threshold defines the length of time
between email notifications, provided the threshold remains in alert status. The
Administration Assistant online help provides information about threshold
definitions.

50 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Configuring distributed file system tasks
Configure Data Protection for SAP for DB2 in a distributed file system. If the SAP
systems are statically assigned to specific hosts, you do not need to configure in a
distributed file system. If the root user ID has write access to the distributed file
system, you do not need to configure in a distributed file system.

Configuring Tivoli Storage Manager for ERP for DB2 in a


distributed file system
Configure Tivoli Storage Manager for ERP for DB2 in a distributed file system with
the following procedure.

Before you begin

For a single SID on a host, Tivoli Storage Manager for ERP sets the ProLE service
to run with the db2SID user ID instead of root. Follow the procedure to set up the
ProLE service to run with the db2SID user ID.

About this task

This set up task is not required if the following conditions exist:


v All SAP systems are statically assigned to specific hosts. For example, the
instances are not moved between hosts.
v The root user is granted read/write access permission to the distributed file
system.
If these conditions exist, the standard installation process can be used as described
in “Preparing to install Data Protection for SAP” on page 23.

Procedure
1. Enable root access to the distributed file system.
2. Install Tivoli Storage Manager for ERP by using the procedure that is described
in “Preparing to install Data Protection for SAP” on page 23.
3. On a UNIX system, replace the following entry in the /etc/inittab file:
pd64:345:respawn:/usr/tivoli/tsm/tdp_r3/db264/prole -p profile

with this entry:


pd64:345:respawn:su - db2SID -c /usr/tivoli/tsm/tdp_r3/db264/prole -p profile

If upstart is configured, the init script /etc/init/prole_db2.conf must be


used. SID must be the actual SID.
4. Refresh the /etc/inittab processes.
5. Disable root access to the distributed file system.

Results

For multiple SIDs on a host system, run the ProLE service by root with permanent
read/write permission to the distributed file system.

Chapter 5. Configuring 51
Configuring Data Protection for SAP for DB2 as an HACMP
application
Configure Data Protection for SAP for HACMP. Data Protection for SAP must be
defined as an application to HACMP, and must be in a resource group that has a
cascading or rotating takeover relationship. It does not support a concurrent access
resource group.

Before you begin

A prerequisite for installation is a correct setup of the Tivoli Storage Manager


client. The installation steps for the Tivoli Storage Manager backup-archive client
for AIX can be found in the documentation Tivoli Storage Manager Installing the
Clients.

About this task

Although the HACMP for AIX Installation Guide can be reviewed for detailed
instructions, a high-level summary is provided here.
1. Enter this command to start HACMP for AIX system management:
smit hacmp
2. Select Cluster Configuration > Cluster Resources > Define Application
Servers > Add an Application Server.
3. Enter field values as follows:
Server Name
Enter an ASCII text string that identifies the server (for example,
tdpclientgrpA). You use this name to refer to the application server
when you define it as a resource during node configuration. The server
name can include alphabetic and numeric characters and underscores.
Do not use more than 31 characters.
Stop Script
Enter the full path name of the script that stops the server (for example,
/usr/sbin/cluster/events/utils/stop_tdpr3.sh). This script is called
by the cluster event scripts. This script must be in the same location on
each cluster node that might stop the server.
4. Press Enter to add this information to the HACMP for AIX ODM.
5. Press F10 after the command completes to leave SMIT and return to the
command line.

What to do next

For more information about selecting the HACMP node topology and takeover
relationships, see the HACMP for AIX Planning Guide Version 4.4.

52 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Adding Data Protection for SAP for DB2 to an HACMP resource
group
A final step in enabling Data Protection for SAP for DB2 for HACMP failover is to
define it to a cluster resource group.

Before you begin

Although the HACMP for AIX Installation Guide can be reviewed for detailed
instructions, a high-level summary is provided here. Perform these tasks to define
the resources that are part of a resource group:

About this task


1. From the Cluster Resources SMIT screen, select the Change/Show
Resources/Attributes for a Resource Group option and press Enter. SMIT
displays a picklist of defined resource groups.
2. Pick the wanted resource group. Press Enter and SMIT displays the Configure a
Resource Group screen.
3. Enter values that define all the resources you want to add to this resource
group.
4. After you enter field values, synchronize cluster resources.
5. Press F10 to exit SMIT or F3 to return to previous SMIT screens to run other
configuration tasks or synchronize the changes that you just made. To
synchronize the cluster definition, go to the Cluster Resources SMIT screen and
select the Synchronize Cluster Resources option.

What to do next

The Tivoli Storage Manager client application must be added to the same resource
group that contains the file systems it will back up. The file systems that are
defined in the resource group are to also be the ones that are specified in the
domain for this client instance in the client user options file. Both JFS and NFS file
systems can be defined as cluster resources, although NFS supports only two node
clusters in a cascading takeover relationship.

HACMP stop script example


A stop script that operates in an HACMP environment is illustrated.

Depending on the installation environment, the sample stop script might have to
ensure that any backup or restore operation in progress can be stopped.

The stop script is used in the following situations:


v HACMP is stopped.
v A failover occurs because of a failure of one component of the resource groups.
The other members are stopped so that the entire group can be restarted on the
target node in the failover.
v A fallback occurs and the resource group is stopped on the node currently
hosting it to allow transfer back to the node by entering the cluster again.

The stop script is called by HACMP with the root user ID.

Note: This script is not in its final form. It is to be considered pseudo code that
indicates the functions it processes.

Chapter 5. Configuring 53
#!/bin/ksh
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# This sample script is provided for use with #
Data Protection for SAP in an HACMP #
# environment #
# It should be reviewed and customized to meet your specific environment #
# #
# #
# Name: stop_tdpr3.sh #
# #

# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

if ["$VERBOSE_LOGGING"="high"]
then
set -x
fi

# Function to update all disk information for Data Protection for SAP

STOP_BACKUP()
{
# You may want to cancel all backups currently running
# Note that this will generate errors in the current backup logs and it will also
# cancel the connection to the Admin Assistant.
# *** Note that if you are using Data Protecion for Snapshot Devices for SAP,
# this may leave your FlashCopy device in an
# inconsistent state.
# kill –9 `cat /var/tdp_r3/prole.pid`

# This stops any running backup or archive process.

STOP_BACKUP

Exit 0

Configuring Tivoli Storage Manager


Data Protection for SAP requires that you complete configuration tasks for the
Tivoli Storage Manager backup-archive client and server.

Tivoli Storage Manager client tasks


Data Protection for SAP requires that configuration tasks be run for the Tivoli
Storage Manager client as part of the overall product configuration.

Configure the Tivoli Storage Manager client options


The Tivoli Storage Manager clients must be configured after the Tivoli Storage
Manager server is configured. These clients include the backup-archive client for
the file system backups, and the application programming interface (API) client for
interface programs. The API client is used to enhance existing applications with
backup, archive, restore, and retrieve services. An installed and confirmed API
client is a prerequisite for Data Protection for SAP.

The clients must be installed on all nodes that interface with the Tivoli Storage
Manager server. In a SAP® system landscape, the backup-archive client must be
installed on every system that is scheduled for a file system backup. Examples of
these systems are SAP application servers and the SAP database server. The Tivoli
Storage Manager API client must be installed only on the SAP database server
system to enable backup and restore operations of the SAP database by using Data
Protection for SAP.

54 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
The Administration Assistant uses the logical Tivoli Storage Manager server names
in the View TSM Server Utilization function. Identical logical names are considered
to represent the same Tivoli Storage Manager server. However, different entries are
generated for each logical server name that is found in the system landscape.
Therefore, use identical logical server names when you point to the same Tivoli
Storage Manager server throughout the system landscape. Also, use different
logical server names when different Tivoli Storage Manager servers are addressed.

Setting Tivoli Storage Manager client options on UNIX or Linux:

Tivoli Storage Manager clients on UNIX or Linux are configured by setting options
in the dsm.opt and dsm.sys files. The include/exclude file is used to define which
files are included or excluded during backup, archive, or hierarchical storage
processing.

About this task

Configure the Tivoli Storage Manager backup-archive client to operate in an SAP


environment with the following procedure.

Procedure
1. Install the Tivoli Storage Manager client software on the SAP database server
system.
2. Edit the client system options file dsm.sys and set these values as appropriate
for your installation:
Servername server_a
TCPPort 1500
TCPServeraddress xxx.xxx.xxx.xxx or servername
InclExcl /usr/tivoli/tsm/client/ba/bin/inclexcl.list
Compression OFF

3. Specify TCPServeraddress 127.0.0.1. If the server and client are on the same
system, select loopback. This selection improves TCP/IP communication speed.
4. Specify InclExcl if you want Tivoli Storage Manager to include or exclude the
files that are listed in inclexcl.list. You might want to exclude all database
files that are processed by the DB2 database backup.
5. Throughput improves when tape drives attached to the Tivoli Storage Manager
server provide hardware compression. However, combining hardware
compression and Tivoli Storage Manager client software compression
(Compression ON) is not advised.
6. Edit the client user options file dsm.opt and set these values as appropriate for
your installation:
LANGUAGE AMENG (this is the default value)
NUMBERFormat 1 (this is the default value)
TAPEPROMPT NO
TIMEFORMAT 1 (this is the default value)

Results

When the Tivoli Storage Manager API client is installed on a UNIX or Linux
system, ensure that a link exists that points to the Tivoli Storage Manager API
installation directory, /usr/tivoli/tsm/client/api/bin64.

/usr/lib/libApiDS.a

Chapter 5. Configuring 55
The Tivoli Storage Manager provides two features for specifying the location of the
Tivoli Storage Manager API Client error log: the environment variable DSMI_LOG
and the Tivoli Storage Manager system client option ERRORLOGName in dsm.sys. For
DSMI_LOG, a directory is specified to which a file named dsierror.log is written.
For ERRORLOGName a path and user-defined file name are defined.

To achieve conclusive logical linking of the environment, configuration and log


files in your SAP backup-archive system, you must use the Tivoli Storage Manager
system client option ERRORLOGName rather than the environment variable DSMI_LOG.
When you use ERRORLOGName, you can include the SID in the file name. This
information can speed up problem determination by simplifying identification
of the correct error log file. You can match log file names to the active user
client options file name, which must also contain the SID and be stored in
environment variable DSMI_CONFIG. This information is especially useful on
systems with several SIDs.

The following is the suggested setup for Data Protection for SAP for DB2 on AIX:
1. For each “SERVER servername” section in the profile initSID.utl, create a
corresponding “SErvername servername” stanza in the system client options file
/usr/tivoli/tsm/client/api/bin64/dsm.sys, where SID designates the DB2
database name as returned by “echo $DB2DBDFT”. One SID might use several
“SErvername servername” stanzas. It is not advised to use “SErvername
<servername” stanza by several SIDs.
2. In all “SErvername servername” stanzas that belong to the same SID, add option
“ERRORLOGName /writeable_path/dsierror_SID.log”. Write permission
problems can usually be avoided by specifying a directory below $HOME of
the DB2 instance owner as writeable_path.
3. Create one user options file for each DB2 SID with the file name
/usr/tivoli/tsm/client/api/bin64/dsm_SID.opt containing option
“SErvername servername”. servername must point to the stanza in
/usr/tivoli/tsm/client/api/bin64/dsm.sys that is designated by the first
“SERVER servername”section in initSID.utl. Add variable
DSMI_CONFIG=/usr/tivoli/tsm/client/api/bin64/dsm_SID.opt to the
environment of the user who is running the SAP backups, db2SID or SIDadm,
or both in case of doubt.

With this setup, you obtain the following logical interlinking:


v Environment variable DSMI_CONFIG is exported from the login shell
v Environment variable DSMI_CONFIG points to client user options file
/usr/tivoli/tsm/client/api/bin64/dsm_SID.opt
v Client user option “SERVER servername” in dsm_SID.opt points to the “SERVER
servername” stanza in /usr/tivoli/tsm/client/api/bin64/dsm.sys
v The “SERVER servername” stanza contains the option “ERRORLOGName
/writeable_path/dsierror_SID.log”
If the variable DSMI_LOG exists in your environment from an earlier setup, it is
overridden by dsm.sys option ERRORLOGName. However, to avoid confusion, make
sure the DSMI_LOG path is identical to the path in ERRORLOGName. Alternatively, you
can remove DSMI_LOG completely from your environment.

56 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Setting Tivoli Storage Manager client options:

Tivoli Storage Manager clients on Windows are configured by setting options in


the file server_a.opt, where server_a is the logical server name in the initSID.utl
file. The include/exclude file is also used to define which files are included or
excluded during backup, archive, or hierarchical storage processing.

About this task

Examples of an include/exclude file for Windows can be found in


“Include/exclude list sample (Windows)” on page 156. Perform these tasks to
configure the Tivoli Storage Manager backup/archive clients to operate in an SAP
environment:

Procedure
1. Install the Tivoli Storage Manager client software on the SAP database server
system.
2. For each logical Tivoli Storage Manager server, a corresponding client option
file is needed. In this example, the file name must be server_a.opt since
server_a is the logical server name:
TCPPort 1500
TCPServeraddress xxx.xxx.xxx.xxx
InclExcl c:\tivoli\tsm\baclient\inclexcl.list
Compression OFF

In addition, the environment variable DSMI_CONFIG must specify the


corresponding client options file (for example c:\tivoli\tsm\api\
server_a.opt).
3. Specify TCPServeraddress 127.0.0.1 or loopback if the server and client are on
the same system. This selection improves TCP/IP communication speed.
4. Specify InclExcl if you want Tivoli Storage Manager to include or exclude the
files that are listed in inclexcl.list. You might want to exclude all database
files that are processed by the DB2 database backup.
5. Throughput improves when tape drives attached to the Tivoli Storage Manager
server provide hardware compression. However, combining hardware
compression and Tivoli Storage Manager client software compression
(Compression ON) is not advised.

Results

A Tivoli Storage Manager error log (required for each client) can be specified for
each process regardless of the number of Tivoli Storage Manager client option files
server.opt involved. The Tivoli Storage Manager error log is determined by these
rules:
1. The Tivoli Storage Manager Client log is written to the file specified by the
DSMI_LOG environment variable.
2. If the DSMI_LOG environment variable is absent or is not writeable, the Tivoli
Storage Manager client log is written to the file specified with keyword
ERRORlogname in the client system options file dsm.opt.
3. If there is no ERRORlogname in dsm.opt or if it is not writeable, the Tivoli
Storage Manager client log is written to file dsierror.log in the local path.

Chapter 5. Configuring 57
It is advised to set up the Tivoli Storage Manager client so that different processes
write to separate error logs. Therefore, the error log path must be defined in the
DSMI_LOG environment variable if the client options files are shared among
processes.

Tivoli Storage Manager server tasks


Data Protection for SAP for DB2 requires configuration tasks to be done for the
Tivoli Storage Manager server as part of the overall product configuration.

Configure the Tivoli Storage Manager server


When you are configuring Data Protection for SAP you must set up the Tivoli
Storage Manager server, and run general and specific server configurations such as
setting up storage devices.

Although the task examples use Tivoli Storage Manager commands, these tasks can
also be run using the Tivoli Storage Manager web client GUI.

Consider the following performance-related guidelines before you install the Tivoli
Storage Manager server.
Tivoli Storage Manager server host system
The Tivoli Storage Manager server must be installed on an exclusive
system. The tasks that are presented here avoid concurrent processes and
disk I/O access with other applications. A single Tivoli Storage Manager
server is sufficient for a single SAP system landscape. If the Tivoli Storage
Manager server is used to back up and restore other clients, consider
installing the server on a large system or by using several Tivoli Storage
Manager servers.
Network topology
Network topologies such as Fast Ethernet and Gigabit Ethernet work well
with the Tivoli Storage Manager server. Use fast network topologies to
prevent bottlenecks during backup and restore operations. The Tivoli
Storage Manager server supports multiple network adapters. This support
increases server throughput by providing multiple connections to the same
network or by providing several physically distinct networks for the same
server.
In the AIX: LPAR environment
An LPAR node can be used for a Tivoli Storage Manager server. The use of
a High Performance Switch network can improve backup and
performance.

These steps are considered complete when the Tivoli Storage Manager server is
successfully installed:
v Recovery log volume is allocated and initialized.
v Recovery log mirror volume is allocated and initialized.
v Database volume is allocated and initialized.
v Database mirror volume is allocated and initialized.
v Extra labeled volumes for the backup and archive storage pools are allocated
and initialized (disks, tapes, or combinations).
v Licenses are registered.
v The Tivoli Storage Manager server is started.

58 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
The latest code fixes for Tivoli Storage Manager can be found at:
ftp://public.dhe.ibm.com/storage/tivoli-storage-management/maintenance

Specifying a Tivoli Storage Manager server:

To configure Data Protection for SAP, you need to specify a Tivoli Storage Manager
in the profile file.

About this task

Follow these steps to add a Tivoli Storage Manager server:

Procedure
1. Add a server statement to the Data Protection for SAP profile.
2. Adapt the Tivoli Storage Manager options files as described in “Verifying the
Tivoli Storage Manager server name” on page 65.
3. Set and save the Tivoli Storage Manager password for the new server as
described in “Setting the Tivoli Storage Manager password” on page 63.

Specifying a storage device:

A storage device needs to be added when you are configuring. A storage device
defines a device class, which handles the type of media. The default device class
that is defined for disks is DISK and is considered sufficient.

About this task

Verify that the following items are established within the Tivoli Storage Manager
server after installation.
v Query the defined library:
q library

v Query the defined drives:


q drive

v Query the defined device class:


q devclass

Defining a storage pool:

A storage pool needs to be added when during the configuration. A storage pool is
a named collection of storage volumes that are associated with one device class.
Each storage pool represents a collection of volumes that are the same media type.
The storage pool setup defines the storage hierarchy for the appropriate
environment.

About this task

In an SAP environment, these data types can be backed up:


v SAP system data
v SAP database data (containers, offline log files)

Chapter 5. Configuring 59
To separate data within the Tivoli Storage Manager server, define appropriate
storage pools for each of these data collections. Log on as the Tivoli Storage
Manager Administrator by using the Admin Command Line or the Web Admin and
run these commands to define storage pools:

Procedure
1. Define a storage pool for the SAP system data: define stgpool sap_incr
device_class_name maxscr=5
2. Define a storage pool for the containers: define stgpool sap_db
device_class_name maxscr=20
3. Define a storage pool for the offline log files: define stgpool sap_log1
device_class_name maxscr=3

Results

When a library tape device is associated, the maximum scratch volumes (labeled
volumes that are empty or contain no valid data) that this storage pool is allowed
to use (parameter maxscr) must be defined. The maximum number of scratch tapes
depends on the size of the database, the capacity of the tapes, the number of
scratch volumes available, and how many versions of the backup must be retained.
Replace these values with appropriate estimates.

Defining a policy:

A server policy needs to be specified when you are configuring Tivoli Storage
Manager policies. Specify how files are backed up, archived, moved from client
node storage, and how they are managed in server storage. A policy definition
includes the definition of a policy domain, a policy set, management classes, and copy
groups.

About this task

After you set definitions, a default policy set must be assigned, validated, and
activated. For the policy definition, log on as a Tivoli Storage Manager
Administrator by using the Admin Command Line or the Web Admin and run the
following commands.

Procedure
1. Define a policy domain and policy set:
define domain sap_c21
define policyset sap_c21 p_c21

2. Define a management class for file system backups, data files, offline log files
and copies of offline log files :
define mgmtclass sap_c21 p_c21 mdefault
define mgmtclass sap_c21 p_c21 mdb
define mgmtclass sap_c21 p_c21 mlog1
define mgmtclass sap_c21 p_c21 mlog2

If you are planning to use this Tivoli Storage Manager server with multiple
SAP systems, use a set of different management classes for each system.
3. Define a copy group:

60 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
define copygroup sap_c21 p_c21 mdefault type=backup destination=sap_incr
define copygroup sap_c21 p_c21 mdefault type=archive destination=archivepool
define copygroup sap_c21 p_c21 mdb type=archive destination=sap_db retver=nolimit
define copygroup sap_c21 p_c21 mlog1 type=archive destination=sap_log1 retver=nolimit
define copygroup sap_c21 p_c21 mlog2 type=archive destination=sap_log2 retver=nolimit

Data Protection for SAP uses version control for managing SAP database
backups by backing up all data to only those management classes for which an
archive copy group is defined (typearchive). To prevent backed up files within
Tivoli Storage Manager server storage from being deleted due to expiration
dates (Tivoli Storage Manager deletes expired files), the copy group parameter
retver, which specifies the number of days a file is to be kept, must be set to
unlimited (9999 or nolimit).
4. Assign the default management class:
assign defmgmtclass sap_c21 p_c21 mdefault

5. Validate and activate the policy set:


validate policyset sap_c21 p_c21
activate policyset sap_c21 p_c21

Registering a node:

The node must be registered when you are configuring The Tivoli Storage Manager
server views its registered clients, application clients, host servers, and source
servers as nodes.

About this task

To register a node, log on as the Tivoli Storage Manager administrator by using the
Admin Command Line or the Web Admin, run the following command

register node C21 passwd domain=sap_c21 maxnummp=8

When you use two or more tape drives, the maxnummp parameter settings can affect
the nodes. It defines the maximum number of mount points that one node can use.
The default value is 1. If one node must use more than one mount point, the
parameter must be set to the wanted number of mount points. This parameter is
not to be set higher than the total number of drives available on the Tivoli Storage
Manager server.

Determining the Tivoli Storage Manager password method:

Specify how Data Protection for SAP manages the Tivoli Storage Manager
password. There are three options.

About this task

There are three methods of password handling:


No password is required
No authentication is done on the Tivoli Storage Manager server. Each user
that is connected to the backup server can access Tivoli Storage Manager
data without a password. This method is only advised if adequate security
measures are established. For example, no password might be acceptable

Chapter 5. Configuring 61
when the Tivoli Storage Manager is only used for SAP, and authentication
and authorization is done at the operating system level. This would be the
case when no other clients are registered to the Tivoli Storage Manager.
Manual handling of password
A password is required for each connection to the Tivoli Storage Manager
server. In this method, Data Protection for SAP for DB2 stores the
encrypted password in its configuration files. While the password does not
expire and is not changed on the Tivoli Storage Manager server, Data
Protection for SAP automatically uses the stored password when it
connects to Tivoli Storage Manager. This method provides password
security and can be set up easily. Whenever the password expires or is
changed, the new password must be set with this command:
backom -c password [-x]

If you are setting the password to be automated (such as in a script), enter


this command:
backom -e full path/initSID.utl
-c password serverA:nodeA:passwordA serverB:nodeB:passwordB [-x]

where passwordA is the password for Tivoli Storage Manager node nodeA
on Tivoli Storage Manager server serverA.

Note:
1. The interactive password prompt is omitted only if the passwords for
all server stanzas in the.utl file are specified.
2. There is a potential security risk when you record Tivoli Storage
Manager passwords in a script.
Automatic handling of password
A password is required for each connection to the Tivoli Storage Manager
server. After the first connection, the password is managed by Tivoli
Storage Manager. The Tivoli Storage Manager client stores the current
password locally. When the password expires, the password is changed
and stored automatically. If you schedule your backups or restore from a
system user different from the database owner, you must grant access
permissions to your data files on disk for this user. Specify the Tivoli
Storage Manager password in use before you start by using Data
Protection for SAP to connect to the server. Whenever the password is
changed manually on the Tivoli Storage Manager server, again connect to
the server and update the password with the command update node. Use
the following command for automatic password handling:
backom -c password [-x]

This method is advised for an automated production environment.

62 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Setting the Tivoli Storage Manager password:

Data Protection for SAP is to be installed after the Tivoli Storage Manager
installation is completed. Tivoli Storage Manager provides different password
methods to protect data. Data Protection for SAP must use the same method as
specified in Tivoli Storage Manager.

About this task

The default password method during Data Protection for SAP installation is
PASSWORDACCESS prompt.

Provide Data Protection for SAP for DB2 with the password for the Tivoli Storage
Manager node by entering this command:
backom -c password

The default parameters for Data Protection for SAP are set according to this default
value. If a different password method is set in Tivoli Storage Manager, adjust the
Data Protection for SAP parameters.

Password configuration matrix:

After you select the suitable password-handling method, follow this configuration
matrix to set the password keywords and parameters.

Proceed as indicated by the step number.


Table 4. Password handling for UNIX or Linux
Step Profile/Action Parameter Password
No Manual Set by Tivoli
Storage
Manager
1 Tivoli Storage AUTHENTICATION OFF ON n days (see ON n days
Manager admin EXPIRATION PERIOD (see note note 2)
1)
2 dsm.sys PASSWORDACCESS Unavailable PROMPT GENERATE

PASSWORDDIR (see note 5) Unavailable path

NODENAME Unavailable. nodename


3 Tivoli Storage UPDATE NODE (see notes 1, 6) Unavailable password password
Manager admin
4 Data Protection for For each SERVER statement, NO YES NO (see
SAP for DB2 profile specify:PASSWORDREQUIRED nodename nodename note 4)
(initSID.utl) ADSMNODE
6 Command line backom -c password Unavailable password (See password (See
notes 3, 7) notes 3, 7

Note:
1. See appropriate Tivoli Storage Manager documentation.
2. If you are using manual password generation during testing, make sure that
the expiration period is set to an appropriate time.

Chapter 5. Configuring 63
3. This password must be the one that is effective on the Tivoli Storage Manager
server for the node.
4. ADSMNODE must not be set when PASSWORDACCESS generate is set.
5. The users SIDadm and db2SID must have read and write permission for the path
specified.
6. This step is only necessary if the password is expired (manual-handling only)
or must be changed on the Tivoli Storage Manager server.
7. A password must be entered for each server statement in the Data Protection
for SAP profile.
8. When you use PASSWORDACCESS GENERATE, the operations must always be used
with the same user ID provided in step 5 (setting of passwords).

Password configuration matrix (Windows):

When the preferred method of password-handling is determined, review the


following steps to set the keywords and parameters in the various profiles.

Detailed information about password-handling methods is available in


“Determining the Tivoli Storage Manager password method” on page 61.

After you select the suitable password-handling method, follow this configuration
matrix to set the keywords and parameters. Proceed as indicated by the step
number.
Table 5. Password handling for Windows
Step Profile/Action Parameter Password
No Manual Set by Tivoli
Storage
Manager
1 Tivoli Storage AUTHENTICATION OFF ON n days (see ON n days
Manager admin EXPIRATION PERIOD (see note note 2)
1)
2 server.opt PASSWORDACCESS Unavailable PROMPT GENERATE

PASSWORDDIR (see note 5) Unavailable path

NODENAME Unavailable nodename


3 Tivoli Storage UPDATE NODE (see notes 1,6) Unavailable. password password
Manager admin
5 Data Protection for For each SERVER statement, NO (see note
SAP profile specify:PASSWORDREQUIRED 4)
initSID.utl ADSMNODE NO YES

nodename nodename
6 Command line backom -c password Unavailable password (see password (see
notes 3,7) notes 3,7)

Note:
1. See Tivoli Storage Manager documentation.
2. If you are using manual password generation during testing, make sure that
the expiration period is set to an appropriate time.

64 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
3. For an initial setup, this password must be the same password that is specified
when the node was registered to Tivoli Storage Manager. The password must
be changed first on the Tivoli Storage Manager server and then on Data
Protection for SAP.
4. ADSMNODE must not be set when PASSWORDACCESS generate is set.
5. The users SIDadm and sapserviceSID must have read and write permission for
the path specified .
6. This step is only necessary if the password is expired (manual-handling only)
or must be changed on the Tivoli Storage Manager server.
7. A password must be entered for each server statement in the Data Protection
for SAP profile.

Verifying the Tivoli Storage Manager server name:

You must verify that the server name and the parameters are correct in the
initSID.utl file.

Procedure
v Review the Tivoli Storage Manager client options files to make sure that the
server name matches the name that is specified in the server statement of the
initSID.utl file.
v Review that other parameters are set correctly. These settings depend on the
password method selected.
v (UNIX or Linux) Define the Tivoli Storage Manager server in the Tivoli Storage
Manager client system options file (dsm.sys). The server stanza that is specified
in dsm.sys must match the entry in initSID.utl.
v (Windows) Define a client options file servername.opt. This file must be in the
directory that contains dsm.opt. The value of servername is the server name that
is specified in initSID.utl.

Chapter 5. Configuring 65
66 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 6. Protecting data
Information that is needed to back up, restore, and clone your SAP data is
provided.

Backing up SAP data


Plan a daily backup strategy with scheduled and automated backups for the
system.

About this task

Follow the tasks to put the backup strategy in place. Use the samples to help you
for your operating system.

Schedule automated backup tasks


Scheduling and automating backup and archive operations helps to ensure that
data is backed up regularly at a specified time. Products that are used to schedule
backup operations can be used to automate these operations.
SAP scheduler
The SAP Computer Center Management System (CCMS) provides a
scheduler for database administration and backup planning on a single
database server. The scheduler can be started from the SAP GUI command
line (transaction code db13) or with the SAP GUI menu function Tools >
CCMS > DB administration > DBA scheduling.
Scheduler (Windows) or Crontab (UNIX or Linux)
Automating backups at the database server level is available by using
either the Schedule Services feature (on Windows) or the crontab
command (for UNIX or Linux).
Tivoli Storage Manager scheduler
Tivoli Storage Manager also provides a scheduler function for all of its
clients. As a result, automation can be set for multiple database servers.
The Tivoli Storage Manager administrative client GUI provides an
easy-to-use wizard for defining schedules. Information about how to define
Tivoli Storage Manager schedules can be found in the Tivoli Storage
Manager Administrator's Reference.
IBM Tivoli Workload Scheduler
The IBM Tivoli Workload Scheduler provides event-driven automation,
monitoring, and job control for both local and remote systems.

Sample backup strategy for daily backup processing

This figure illustrates the sequence of backup operations to consider for a daily
backup schedule.

© Copyright IBM Corp. 1995, 2014 67


Figure 10. Production Backup Example

The automated backup example shown in the graphic displays these common
tasks:
v A full database backup (offline or without application load) runs each night.
v Offline log files are backed up to disk during online hours. This action has the
advantage of eliminating the need for extra tape mounts for relatively small
files.
v The Tivoli Storage Manager server moves archived log files from disk to tape
after the full database backup.
v SAP system files are backed up incrementally with the Tivoli Storage Manager
backup-archive client.
v The last backup in the daily cycle is the backup of the Tivoli Storage Manager
database. This backup must always be done.
Backups can be moved to disk storage and to tape media. The Tivoli Storage
Manager server manages the data regardless of the storage media. However,
backing up the SAP database directly to tape is the preferred media.

Windows scheduling example


An example of a batch file schedule is shown.

About this task

On Windows systems, the schedule service must be running to start automated


backup jobs. Issue this command to start the schedule service:
net start schedule

Use the at command to schedule jobs when the schedule service is running. This
command starts the batch file backup.cmd. In this example, the command runs the
schedule every Friday at 8:00 p.m.:

68 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
at 20:00 /every:f cmd /c c::\db2\C21\sapscripts\backup.cmd

Backups in a nonpartitioned database environment


The following examples show how you can start DB2 database or table space
backups from the command line by using DB2 CLP.

To start a DB2 backup or restore with Data Protection for SAP for DB2, log on as
user db2SID or SIDadm. In the following examples, the variable shared library
represents the full path of the Data Protection for SAP shared library (UNIX and
Linux) or DLL (Windows). DB2 database and table space backups are run as
follows:
v Full online backup (database parameter LOGRETAIN must be activated):
db2 backup db dbname online load shared library

v Online table space backup (database parameter LOGRETAIN must be activated):


db2 backup db dbname online tablespace (tablespace_name#1, ...)
load shared library

Use DB2 single system view for backup


DB2 Version 9.5 and later provides the single system view (SSV) function, which
allows backing up multiple database partitions immediately.

In earlier releases, partitioned databases that are needed to be backed up one


partition at a time that can be time-consuming and prone to errors. Backing up a
partitioned database one partition at a time also failed to include the log files in
the backup image. These log files are required to restore and recover the data.
Restoring multiple partitions that were backed up individually is complicated as
well because the backup timestamp for each partition is slightly different.
Identifying all database partitions belonging to the same backup is difficult. Also,
determining the minimum recovery time for the backup that contains these
partitions is difficult. Use of db2_all simplifies the backup of partitioned
databases. However, backup and restore operations restrictions still exist that
complicate these tasks.

With DB2 Version 9.5 and later, when you do a backup operation of a partitioned
database, you can specify which partitions to include in the backup. If necessary,
you can include all the database partitions. The specified partitions are backed up
simultaneously and the backup timestamp that is associated with all specified
database partitions is the same. Also, by default, database logs are included in an
SSV backup image. Finally, when you restore from an SSV backup image, you can
specify to roll forward to end of logs, which is the minimum recovery time that is
calculated by the database manager. For more information, see the DB2 Command
Reference.

Chapter 6. Protecting data 69


Multiple log file copies
Backing up multiple copies of a log file in a single archive operation helps protect
against this data in the event of a storage hardware failure or disaster recovery
situation. These copies can be on different physical Tivoli Storage Manager
volumes or on different Tivoli Storage Manager servers.

When a log file copy is unavailable at restore time, the software switches to
another copy. The software continues to restore the log file from that copy.

Schedule batch sample


@echo off
rem ------------------------------------------------------------------------
rem file name: schedule.sample
rem ------------------------------------------------------------------------
rem Task:
rem Submits backup/archive commands at regularly scheduled intervals
rem using two simple batch files containing backup/archive commands.
rem ------------------------------------------------------------------------
rem ***** NOTE ***** NOTE ***** NOTE *****
rem
rem This file is intended only as a model and should be
rem carefully tailored to the needs of the specific site.
rem
rem ***** NOTE ***** NOTE ***** NOTE *****
rem ------------------------------------------------------------------------
rem For a full reference of the AT command please see the Windows NT
rem help.
rem ------------------------------------------------------------------------
rem
rem For the following examples, the system ID of the DB2 database
rem is assumed to be "C21".
rem
rem ------------------------------------------------------------------------
rem Full database backup, scheduled every Friday at 8:00 p.m.
rem
at 20:00 /every:f cmd /c c:\db2\C21\sqllib\scripts\backup.cmd
rem
rem ------------------------------------------------------------------------
rem Save redo logs, scheduled twice a day at 11:30 a.m. and at 5:30 p.m.
rem Monday through Friday
rem
at 11:30 /every:m,t,w,th,f cmd /c c:\db2\C21\sqllib\scripts\archive.cmd
rem --------------------- end of schedule.sample ------------------------

Full offline backup batch file sample


@echo off
rem Full Offline Backup batch file:
rem ------------------------------------------------------------------------
rem file name: backup.cmd
rem ------------------------------------------------------------------------
rem Sample DB2 backup batch file for 3264bit environments
rem ------------------------------------------------------------------------
rem Task:
rem Invokes a DB2 backup in order to perform a full offline backup of
rem all DB2 tablespaces
rem ------------------------------------------------------------------------
rem ***** NOTE ***** NOTE ***** NOTE *****
rem
rem This script is intended only as a model and should be
rem carefully tailored to the needs of the specific site.
rem
rem ***** NOTE ***** NOTE ***** NOTE *****
rem ------------------------------------------------------------------------

70 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
rem
rem For the following examples, the system ID of the DB2 database
rem is assumed to be "C21".
rem
rem ------------------------------COMMAND-----------------------------------
db2 backup db C21 load ’C:\Program Files\tivoli\tsm\tdp_r3\db264\tdpdb2.dll’

Full offline backup shell script sample


#!/bin/ksh
# ---------------------------------------------------------------------------
# backup.ksh:
# Sample DB2 backup shell script for 3264bit environments
# ---------------------------------------------------------------------------
# Task:
# Invokes a DB2 backup in order to perform a full offline backup of
# all DB2 tablespaces
# ---------------------------------------------------------------------------
# ***** NOTE ***** NOTE ***** NOTE *****
#
# This script is intended only as a model and should be
# carefully tailored to the needs of the specific site.
#
# ***** NOTE ***** NOTE ***** NOTE *****
# ---------------------------------------------------------------------------
#
# For the following examples, the system id (alias) of the DB2 database is
# assumed to be ’C21’.
#
# --------------------------------COMMAND------------------------------------
su - db2c21 -c "db2 backup db C21
load /usr/tivoli/tsm/tdp_r3/db264/libtdpdb264.a"

Segment large backup objects


To assist backing up and restoring of database objects that are larger than 1 TB, use
the IBM Tivoli Storage Manager for Enterprise Resource Planning SEGMENTSIZE
keyword parameter for each DB2 backup session to be partitioned into multiple
segments. These segments are stored on Tivoli Storage Manager as individual
backup objects. The value of the SEGMENTSIZE keyword parameter determines
the maximum allowable size of a backup segment on Tivoli Storage Manager
storage.

Each DB2 backup session is assigned its own backup segment group. A backup
segment group is a collection of all segments of a backup session that is generated
by Tivoli Storage Manager for ERP during a database backup operation. For
example, two DB2 backup sessions (s1, s2) that contain two segments for each
session (seg1, seg2), is assigned two backup segment groups (sg1, sg2). The first
backup segment group (sg1) contains segments s1:seg1, s1:seg2. The second
backup segment group (sg2) contains segments s2:seg1, s2:seg2.

When you specify segmentation, the session number substring of the backup image
name is used to identify the backup object as part of a segmented data stream. The
session number substring segment number is added to the backup image name that
is separated by a colon (:). For example:
DB2 instance.db alias.type.partition number.DB2 backup ID.session number:segment number

When Tivoli Storage Manager for ERP initiates a change of Tivoli Storage Manager
objects, the segment number, for the new backup object segment, increases by one.

Chapter 6. Protecting data 71


For integrity check processing of the backup segment group, an extra zero-byte
backup object, the so-called commit object, is generated. This object is used by
Tivoli Storage Manager for ERP to check the integrity of the related backup
segment group. The naming convention of the commit object is as follows:
DB2 instance.db alias.type.partition number.DB2 backup ID.session number:C last segment number

The character C following the colon (:) character identifies the backup image as a
committed object. These committed objects are stored on Tivoli Storage Manager at
the very end of each participating backup session. Also, the last segment number
identifies the number of segments that must exist on Tivoli Storage Manager for all
segments for that session to be restored. As a result, this update to the backup
image name ensures that the correct object is assigned to the correct DB2 backup
session. However, when one or more committed objects are missing, the integrity
of the backup segment group is not guaranteed. For this reason, the database
restore is not started by Tivoli Storage Manager for ERP

You can verify whether backup object segmentation was activated by using either
of these methods:
Tivoli Storage Manager for ERP log entries
An information message that identifies that the maximum segment size is
logged to this file. The session number substring :segment number is
included in the backup image name, and in an information message that
indicates that a commit object (containing substring Clast segment number)
was generated.
DB2 Backup Object Manager
The session number substring :segment number is visible in the backup
image that is displayed by the q_all -m detailed, q_db -m detailed or
q_raw command.
Administration Assistant function for Tivoli Storage Manager for ERP
The session number substring (:segment number) is visible in the backup
image that is displayed in the operations monitoring or performance
monitoring views.

Segmentation and Tivoli Storage Manager server

If segmentation is used for backup operations, the Tivoli Storage Manager server
might issue the error message,"ANS0326E This node exceeds its maximum number
of mount points. This situation happens because there might be a short delay
before the Tivoli Storage Manager actually closes client sessions. To overcome this
problem, the Tivoli Storage Manager server MAXNUMMP parameter for the Tivoli
Storage Manager node is set to twice the number of Tivoli Storage Manager
sessions that are used for the backup. The number of active parallel sessions for
Tivoli Storage Manager for ERP to the Tivoli Storage Manager server is limited by
the Tivoli Storage Manager for ERP parameters SESSION, in the SERVER stanza,
and MAX_SESSIONS.

For example, if two Tivoli Storage Manager sessions are needed for the database
backup, the MAXNUMMP parameter for the used node is set to four in the Tivoli
Storage Manager server. In this example, Tivoli Storage Manager for ERP sends the
data by using two Tivoli Storage Manager sessions only.

72 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Segmentation and backup processing

Review the following backup characteristics before you apply segmentation to your
DB2 backup operations:
v The data stream that is sent from DB2 is segmented during a DB2 database
backup.
v When implemented, segmentation is applied to every participating DB2 backup
session.
v Back up and restore sessions are isolated from each other. As a result, segments
that are generated by Tivoli Storage Manager for ERP are isolated on a per
session basis. Therefore, segments cannot be mixed between different sessions.
All segments that are backed up within the same session are restored in the
same session.
v DB2 logs are not partitioned in to multiple segments.

Segmentation and restore processing

Review the following restore characteristics before you apply segmentation to your
DB2 restore operations:
v Metadata that is associated with the backup object indicates whether the object
is part of a segmented data stream. If the backup object is part of a segmented
data stream, Tivoli Storage Manager for ERP automatically joins the segments to
the object DB2 expects to receive from Tivoli Storage Manager during the restore
operation.
v Back up and restore sessions are isolated from each other. As a result, segments
that are generated by Tivoli Storage Manager for ERP are isolated on a per
session basis. Therefore, segments cannot be mixed between different sessions.
All segments that are backed up within the same session are restored in the
same session.
v Do not use segmentation into two or more segments for a backup that is to be
restored to DB2 by using the Backup Object Manager command backom -c r_raw
.... This backup can be restored to the destination directory, but not into DB2 if
two or more segments were created. If the backup was created by using a single
segment, it can be restored to DB2 from the destination directory after retrieval
from Tivoli Storage Manager. There is no limitation that concerns segmentation
for other restore methods.

Restoring SAP data


Use the Data Protection for SAP File Manager for managing restore operations.

Start restores in a nonpartitioned database environment


The following examples show how you can start DB2 database/tablespace restores
from the command line by using DB2 CLP.

Every successful backup run generates a timestamp that is required for later
restore operations. These timestamps are written to the DB2 Recovery History file
(RHF), which can be queried with DB2 commands. The timestamps of backup
images that are currently stored on the Tivoli Storage Manager server can be
queried by using the Backup Object Manager query commands. If no timestamp is
specified in a restore command, the latest backup image that is found on Tivoli
Storage Manager is restored.

DB2 database and table space restores are performed as follows:

Chapter 6. Protecting data 73


v Full restore to a certain point in time:
db2 restore db dbname load shared library taken at timestamp

or
backom -c r_db -a dbname -t timestamp

v Online table space restore


db2 restore db dbname tablespace (tablespace_name#1, ...) online
load shared library taken at timestamp

or
backom -c r_ts -a dbname -t timestamp -O

v Recovery History File restore


db2 restore db dbname history file online load shared library

or
backom -c r_hfile -a dbname

Data Protection for SAP process results can be checked by analyzing the Data
Protection for SAP log files. These log files might contain success, warning, and
error messages.

Processing redirected restore in automatic mode


Backup Object Manager provides an automatic cloning function, which creates an
exact copy of the original SAP database in a different location.

About this task

The physical database layout of the target database is identical to that of the source
system. The physical database layout consists of table spaces, table space number,
and size of the table space containers. The path names of the new table space
containers are constructed by replacing the original SID with the SID of the target
system. In addition, modifications to the sizes of all or selected table space
containers of the target database can be made to optimize the I/O performance.
Backup Object Manager provides automated table space resizing and automated
table space normalizing for these modifications. The Backup Object Manager
automatic mode redirected restore function can be used to resize table space
containers of the source database. This action is accomplished by performing a
redirected restore in automatic mode with the same SID set as both the original
and the target SID and requesting scaling or normalizing (or both) during the
operation.

Issue this command on the target system to run a redirected restore in automatic
mode:
backom -c rr_db_clone -a DB2 source alias,DB2 target alias -t timestamp

74 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Backup Object Manager performs these steps during a redirected restore in
automatic mode:
1. Backup Object Manager retrieves the TDI for the requested backup from Tivoli
Storage Manager into memory.
2. Backup Object Manager replaces the source database alias with the target
database alias. If no target database alias is specified, Backup Object Manager
uses the original database alias as the target database alias.
3. Using the modified TDI, Backup Object Manager performs basic plausibility
checks.
4. Backup Object Manager uses the modified TDI to create the necessary table
space containers on the target system. If the target database alias is the same as
the original database alias, the database is restored to the original database alias
and SID. When Backup Object Manager restores to the original system, it
attempts to overwrite the original database. Overwriting the original database
requires approval by the administrator.
5. Backup Object Manager calls the DB2 redirected restore function.

Tablespace definition information


To automate a redirected restore operation, Backup Object Manager requires
information about the table spaces and the table space containers that are used in
the original database.

Th following information is used to create the table space containers of the target
database, and is required for each table space:
v The ID and name of the table space.
v The type of the table space. For example, whether the table space is system
(SMS) or database managed (DMS).
v The page size in bytes.
v The extent size in pages.
v The number of pages used. This number can help the administrator when
resizing containers. Backup Object Manager also calculates the numbers of total
pages and of usable pages from the data that is stored for each table space
container.
v Information about the table space containers that are used for the table space.

The following information must be available for each table space container:
v The ID of the table space container.
v The name of the table space container. For example, whether the directory
contains an SMS container or the file contains a DMS container.
v The type of the table space container. For example, whether a database managed
container is stored in a file or on a raw device.
v For DMS table spaces, the total number of pages that are stored in the container.

The TDI and the DB2 backup images are stored together on the Tivoli Storage
Manager server. They are associated by using the combination of the instance
name of the database, the database alias, the database node number, and the
timestamp of the backup. The name of the TDI is constructed in this format: DB2
instance-<DB2 alias>-DB2 node numbertimestamp.tdi. The tablespace definition
information (TDI) can be retrieved from Tivoli Storage Manager separately with
the Backup Object Manager command ’r_tdi' and can be stored as an ASCII file in
a specified file system. The availability of TDI in the file system is a prerequisite
for the Backup Object Manager redirected restore in batch mode.

Chapter 6. Protecting data 75


These changes can be done to the TDI file to prepare for a batch-mode that is
redirected restore:
v Add or remove of table space containers from dedicated table spaces
v Modify names (locations) of table space containers
v Modify the size of a DMS table space container, whereby the sum of container
sizes must have at least the number of pages that are used plus ((number of
containers + 1) * extent), where extent is the extent size in pages.
v Add an automatic storage path, if at least one automatic storage path is already
present
v Change the location of an existing automatic storage path
v Remove one or more existing automatic storage paths, whereby in any case at
least one automatic storage path must exist
tablespace

The following is a sample TDI file:

76 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
; IBM Tivoli Storage Manager for Enterprise Resource Planning
; Data Protection for SAP(R) for DB2
; - Tablespace Definition Information (TDI) -
;
; The following TDI sections can be modified manually:
; - Automatic_Storage_Path
; - Container
;
; An automatic storage path section consists of the following format:
;
; Automatic_Storage_Path = path#1
; ...
; Automatic_Storage_Path = path#n
;
; It is possible to add or remove an automatic storage path entry. For already existing
; automatic storage path entries the assigned path can be updated.
;
; A tablespace section consists of the following format:
;
; [Tablespace ID "tbsp. name" type page size extent size in pages
; used pages yes|no]
; Container[ID 1] = definition ;
. . .
; Container[ID n] = definition
;
; where the definition of a container statement is characterized by its tablespace:
; - SMS tablespace: "path"
; - DMS tablespace: file | "path/container name" | size in pages
;
; If the tablespace containers are modified manually (add or remove container,
; adjust container path or size) at least the following conditions have to be
; guaranteed for ensuring the TDI integrity:
; 1) Any new container specified requires empty brackets ’[]’. The ID is calculated
; internally.
;
; 2) Each tablespace block has to have at least one container specification
;
; 3) The sum of container sizes of a DMS tablespace has to have at least the number
; of used pages plus ((number of containers + 1) * extent).
;
; !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
; ! DO NOT EDIT ANYTHING ELSE EXCEPT THE SECTIONS !
; ! - Automatic_Storage_Path (if present) !
; ! - Container !
; !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
[TDI]
Version = 1.1
Generator = Data Protection for SAP(R) 6400

[Backup]
Alias = T01
Instance = db2t01
Node = 0
Timestamp = 20081130094352
Database_Path = /db2/T01/sapdata1/db2t01/NODE0000/SQL00001/
Automatic_Storage_Path = /db2/T01/sapdata1
Automatic_Storage_Path = /db2/T01/sapdata2

[Tablespace 0 "SYSCATSPACE" dms 16384 4 9264 yes]


Container[0] = file | "/db2/T01/sapdata1/db2t01/NODE0000/T01/T0000000/C0000000.CAT" | 8192
Container[1] = file | "/db2/T01/sapdata2/db2t01/NODE0000/T01/T0000000/C0000001.CAT" | 8192

[Tablespace 1 "TEMPSPACE1" sms 16384 32 1 no]


Container[0] = "/db2/T01/saptemp1"

[Tablespace 10 "T01#USER1D" dms 16384 2 540 no]


Container[0] = file | "/db2/T01/sapdata1/NODE0000/T01#USER1D.container000" | 448
Container[1] = file | "/db2/T01/sapdata2/NODE0000/T01#USER1D.container001" | 448

[Tablespace 11 "T01#USER1I" dms 16384 2 540 no]


Container[0] = file | "/db2/T01/sapdata1/NODE0000/T01#USER1I.container000" | 448
Container[1] = file | "/db2/T01/sapdata2/NODE0000/T01#USER1I.container001" | 448

Chapter 6. Protecting data 77


Be aware of the following considerations that regard the TDI file:
v The [TDI] header block is used to identify the data as TDI and holds some
meta-information about it. The Version key holds the version of the TDI syntax.
The Generator key denotes some product information.
v The [Backup] block holds various kinds of information about the database
backup the TDI is associated with. This information must be kept within the TDI
file so that it is available even when the file is renamed.
[Backup] additionally includes the database path where database metadata is
stored, and all automatic storage paths the database provides for table spaces
supporting automatic storage. It is possible to add or remove an automatic
storage path entry in that section. Optionally, for automatic storage path entries
that already exist, the assigned path can be updated.
v The [Tablespace] block marks the start of the container definitions of a specific
table space.
v The block header contains the following items in exactly this order: the ID of the
table space, its name, its type, the page size in bytes, the extent size in pages
and the number of used pages in the table space. Do not change any data within
the table space block header.
v Each container statement defines one container of a table space according to the
following rules:
– The ID is denoted in square brackets if the line was written by the system. If
a new container is to be added to a table space, the ID is not yet known.
Therefore, the administrator specifies a new container without an ID, just
entering consecutive brackets.
– For an SMS table space, only the fully qualified path is specified.
– For a DMS table space, the type, location, and size of the container are
specified, in this order, and separated by a vertical bar (|). The type is given
by one of the strings file or device. The size is interpreted as a number of
pages unless a unit is specified. In this case, the unit is used.
– Names of table spaces and paths must be quoted strings.

Processing redirected restore in batch mode


Backup Object Manager provides a redirected restore batch mode function where
the TDI for the target database is modified before it starts the redirected restore.

About this task

The TDI image to be used must be available as an ASCII file in the file system. For
example, a TDI image that is created during an interactive redirected restore can be
used as target TDI for a redirected restore in batch mode. Batch mode can also be
used for multiple redirected restores to different locations with identical changes of
the physical database structure. As with the interactive mode, the original TDI is
used to test whether the changes of table space container sizes and locations that
are made are valid. In addition, modifications to the sizes of all or selected table
space containers of the target database can be made to optimize the I/O
performance. Backup Object Manager provides automated table space resizing and
automated table space normalizing for these modifications.

Before a redirected restore in batch mode is started, the TDI for the target database
must be available. This scenario is accomplished by providing the target TDI image
of a previous interactive redirected restore as a file in the file system or by
retrieving the original TDI from Tivoli Storage Manager. Issue the following
command to retrieve a TDI image from Tivoli Storage Manager into the file system:

78 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
backom -c r_tdi -a DB2 source alias -t timestamp -d target directory of TDI

This original TDI image can be renamed and modified.

Issue the following command on the target system to run a redirected restore in
batch mode:
backom -c rr_db_batch -a DB2 source alias,DB2 target alias -t <timestamp,...
...-f full qualified path and name of target TDI file

Backup Object Manager performs these steps during a redirected restore in batch
mode:
1. Backup Object Manager replaces the alias that is specified in the target TDI file
with the alias of the target database. If no target database alias is specified,
Backup Object Manager uses the original database alias as the target database
alias.
2. Backup Object Manager retrieves the original TDI from Tivoli Storage Manager
and verifies whether the target TDI defines table space containers that are
sufficient to replace the original table space containers.
3. Backup Object Manager uses the target TDI and the original TDI to run basic
plausibility checks.
4. Backup Object Manager uses the target TDI to create the necessary table space
containers on the target system. If the target database alias is the same as the
original database alias, the database is restored to the original database alias
and SID. When Backup Object Manager restores to the original system, it
attempts to overwrite the original database. Overwriting the original database
requires approval by the administrator.
5. Backup Object Manager calls the DB2 redirected restore function.

Redirected restore in interactive mode


Backup Object Manager interactive mode is a menu-driven dialog where the table
space container layout is redefined by adding, deleting, moving, or resizing items.

About this task

Backup Object Manager compares the table space definitions that are entered in the
menu dialog with the original database layout (as documented in the original TDI)
and provides immediate feedback about potential configuration problems. In
addition, modifications to the sizes of all or selected table space containers of the
target database can be made to optimize the I/O performance. Backup Object
Manager provides automated table space resizing and automated table space
normalizing for these modifications.

Issue this command on the target system to run a redirected restore in interactive
mode:
backom -c rr_db_interactive -a DB2 source alias,DB2 target alias...
...-t timestamp -f target TDI file

Backup Object Manager performs these steps during a redirected restore in


interactive mode:

Chapter 6. Protecting data 79


1. Backup Object Manager retrieves the TDI for the requested backup from Tivoli
Storage Manager into memory.
2. Backup Object Manager replaces the source database alias with the target
database alias. If no target database alias is specified, Backup Object Manager
uses the original database alias as the target database alias.
3. Backup Object Manager determines whether specific containers must be
redefined.
4. Backup Object Manager displays the main menu, which shows a list of sorted
table spaces for the database to be restored. A “!” mark in front of a table space
or table space container indicates a warning about a potential problem.
Although the redirected restore can still begin, the problem is to be resolved
before proceeding. A “!!” character in front of a table space or table space
container indicates an error was detected, such as a problem about their
location or size. The redirected restore does not succeed until the error is first
resolved.
5. The administrator can select table spaces or table space containers to be
changed by using their IDs. When all modifications of the physical database
layout are completed and no more errors (“!!”) are displayed. The redirected
restore can be started by entering c from the main menu. The administrator can
also end the redirected restore from any menu dialog by entering a.
6. When the -f option is specified during the redirected restore, the modified
physical database layout of the target database is stored in an ASCII file in the
file system. This file can be used later as input for a redirected restore in batch
mode at another location, where the same physical changes to the restored
database must be applied.
7. Backup Object Manager uses the modified TDI and the original TDI to perform
basic plausibility checks.
8. Backup Object Manager uses the modified TDI to create the necessary table
space containers on the target system. If the target database alias is the same as
the original database alias, the database is restored to the original database alias
and SID. When Backup Object Manager restores to the original system, it
attempts to overwrite the original database. Overwriting the original database
requires approval by the administrator.
9. Backup Object Manager calls the DB2 redirected restore function.

Sample work flow for redirected restore


A sample work flow for a redirected restore with Data Protection for SAP Backup
Object Manager is given.

About this task

To clone the SAP production database (PRD) to a test system (TST) on a different
system, apply the following procedure:
1. Make sure that the administrator account to be used has the appropriate
rights on the target system. An example of such rights is permission to
allocate files of a size greater than 2 GB.
2. Verify that the source database PRD meets the prerequisites for a redirected
restore operation.
3. Set up Data Protection for SAP for DB2 on the target system. Verify that these
environment variables specify these values:
v XINT_PROFILE specifies the Data Protection for SAP profile.
v DB2_VENDOR_LIB specifies the Data Protection for SAP shared library.

80 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v TDP_DIR specifies the path for the Data Protection for SAP process log files.
4. For the restore process, customize the Data Protection for SAP profile
(initTST.utl) on the test system with these settings:
v Use BACKUPIDPREFIX as specified on the source system: PRD___.
v Use the Tivoli Storage Manager server that is specified on the source
system. You might include adding the appropriate Tivoli Storage Manager
server stanza to the client system options file (dsm.sys) on the test system.
v Use the ADSMNODE specified on the source system.
v Use BRBACKUPMGTCLASS as specified on the source system.
5. Issue the following command to record the password of the appropriate node
on the Tivoli Storage Manager server:
backom -c password

This creates or updates the Data Protection for SAP configuration file
initTST.bki.
6. Issue the following command to check the Data Protection for SAP database
backup images on Tivoli Storage Manager:
backom -c q_db

Verify that the TDI flag is set to yes for the backup image to be restored.
7. Issue the following command with the -C option to call the BackOM built-in
check routine:
backom -c rr_db_clone -a PRD,TST -t timestamp -C

This command checks for logical and physical integrity of the test system.
8. Issue the following command to start the redirected restore:
backom -c rr_db_clone -a PRD,TST -t timestamp

9. If the database is in rollforward pending mode and must be recovered, there


are two possibilities for retrieving the required logs.
v Automatically by the DB2 Log Manager during the recovery process, or
v Manually with BackOM before the DB2 rollforward process is started.
The automatic log file retrieval requires some extra configuration parameters
to enable Data Protection for SAP to find the logs on the Tivoli Storage
Manager server. The extra parameters are required because the logs were
archived under a different database name (the source database). The
rollforward process tries to find them based on the target database name.
Therefore, two more Data Protection for SAP configuration parameters are
used to find and retrieve the required logs.
The following are the configuration parameters:
v SRC_DB_INSTANCE
v SRC_DB_ALIAS
where SRC_DB_INSTANCE specifies the name of the DB2 instance of the source
database and SRC_DB_ALIAS the name of the source database itself. These two
parameters must be added to the DB2 vendor environment file, which is used

Chapter 6. Protecting data 81


as the option (DB2 database configuration parameter LOGARCHOPT1 or
LOGARCHOPT2) for the appropriate activated DB2 log archive method, for
example:
XINT_PROFILE=/db2/TST/tdpr3/initTST.utl
TDP_DIR=/db2/TST/tdpr3/tdplog
BACKOM_LOCATION=/usr/tivoli/tsm/tdp_r3/db264/backom
SRC_DB_INSTANCE=DB2PRD
SRC_DB_ALIAS=PRD

Activate the DB2 Log Manager on the test system (if not already done) in
combination with Data Protection for SAP. Here, log archive method 1 is used
to service log requests:
db2 update db cfg for TST using LOGARCHMETH1 VENDOR:/<fully qualified name
of shared library>

Set LOGARCHOPT1 to the modified DB2 vendor environment file (vendor.env)


created during the Data Protection for SAP installation:
db2 update db cfg for TST using LOGARCHOPT1 <fully qualified name of
DB2 vendor environment file>

The logs that are required for the database recovery can be either retrieved
automatically, which required the Data Protection for SAP parameters
SRC_DB_INSTANCE and SRC_DB_ALIAS set in the DB2 vendor environment file or
they can be retrieved manually with BackOM. In the latter case, the Tivoli
Storage Manager server must first be checked for the logs already archived,
where logs of a database are grouped by their associated log chain number.
Issue the following command:
backom -c q_log -a PRD

10. To retrieve the log files, issue:


backom -c r_log -a PRD -l log number range -k log chain number
-d destination directory

The database log directory or a different location might be specified for the
destination directory.
11. Start the DB2 rollforward process. In case the log files were retrieved manually
by BackOM to a location other than the database log directory, start the DB2
rollforward procedure and use the overflow log path option to specify the
location of the retrieved log files.
12. After the redirected restore completes successfully and before you back up the
new test system, modify the Data Protection for SAP profile initTST.utl to
match the values of the new test system. This modification might involve
these keywords:
v BACKUPIDPREFIX
v SERVER
v ADSMNODE
v BRBACKUPMGTCLASS
v BRARCHIVEMGTCLASS

82 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
If the DB2 vendor environment file was updated by using the parameters
SRC_DB_INSTANCE and SRC_DB_ALIAS for recovery purposes, remove those
parameters from that file.

Attention: Do not back up the test system with the BACKUPIDPREFIX of the
production system.
13. Perform the following tasks to update the DB2 database configuration of the
test system:
v Set VENDOROPT to the vendor environment file created during the Data
Protection for SAP installation.
db2 update db cfg for TST using VENDOROPT
fully qualified name of DB2 vendor environment file

v If the DB2 Log Manager is used in combination with Data Protection for
SAP and is not yet configured, set the appropriate log archive method and
its assigned option field in the database configuration as follows:
db2 update db cfg for TST using LOGARCHMETH1 VENDOR:
fully qualified name of shared library
db2 update db cfg for TST using LOGARCHOPT1
fully qualified name of DB2 vendor environment file

Redirected restore plausibility checks


Regardless of the mode of the redirected restore operation (automatic, interactive,
batch), Backup Object Manager performs the following checks before the DB2
redirected restore operation begins.
v All paths of tablespace containers must be fully qualified.
v On Windows, all drives that are used for storing tablespace containers must be
available.
v On UNIX or Linux, the volumes that are used for storing tablespace containers
must be available.
v There must be sufficient space in the various locations of the tablespace
containers in the target system for storing them.
v Backup Object Manager tests whether other files or directories exist at the
preferred locations of the tablespace containers. A warning is issued when a
directory for an SMS container exists but is not attached to a different database.
An error is issued when one of these situations is detected:
– A directory for an SMS container exists and is attached to a different
database.
– A file for a DMS container exists in the target location.
v The tablespace containers must provide sufficient storage space for the restored
data.
For all modes of redirected restore, Backup Object Manager provides a test-only
option that does validation checks without actually starting a restore. This option is
used to determine in advance whether a specific redirected restore succeeds. The
Backup Object Manager test-only option is activated by adding the -C command
option to a redirected restore command. For example, issue this command to test
whether a redirected restore in batch mode succeeds with the provided target TDI
file:
backom -c rr_db_batch -a DB2 source alias,DB2 target alias -t timestamp...
...-f full qualified path and name of target TDI file -C

Chapter 6. Protecting data 83


If the test determines that the redirected restore does not succeed, check the
Backup Object Manager log for error and warning messages.

DB2 redirected restore using Backup Object Manager


Backup Object Manager uses a simple set of commands to run a redirected restore
of a database and also runs some plausibility checks before actually starting the
operation.

The DB2 Backup Object Manager provides redirected restore functions such as
these:
v Restore a DB2 database to a different location.
v Change the physical database layout of a restored database, including the
location of tablespace containers, the number of tablespace containers, their
names, and their sizes.
v Clone a database, changing both the name and the location of the database.

Figure 11. Redirected restore overview

Backup Object Manager provides these redirected restore modes:


Automatic
Restore a database to a different name and location while you keep the
general database layout. However, scaling and normalizing of tablespace
containers can be requested with an automatic redirected restore.
Batch Restore a database to a different location and database layout that is
defined in a configuration file.
Interactive
Restore a database to a location and database layout that is specified by
the administrator in a dialog.

In all modes, Backup Object Manager can also process more automated adaptations
to tablespaces. For example, perform tablespace scaling to provide tablespaces with
appropriate free space or perform tablespace normalizing to optimize the parallel
I/O performance of the restored database.

84 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Creating table space definition information
A table space definition image (TDI) is created after a full database backup
completes successfully. It is stored on the Tivoli Storage Manager server with the
database backup image. Only database backups for which a corresponding TDI is
available can be used for redirected restore with Backup Object Manager.

About this task

The Backup Object Manager must be used to create a TDI for an offline database
backup image. For example, this command starts an offline database backup by
using two sessions:
backom -c b_db -a database alias -S 2

A TDI is not created when you use the DB2 command-line interface to run an
offline database backup.

There are two methods available to create a TDI for an online database backup
image:
v One method is to use the Backup Object Manager backup function. For example,
this command starts an online database backup by using two sessions:
backom -c b_db -a database alias -S 2 -O

v Another method is to use the DB2 command-line interface to start an online


backup with the BACKOM_LOCATION parameter set in the vendor environment file.
When the value of this parameter specifies the backom executable file, the TDI is
stored on the Tivoli Storage Manager server after the backup completes
successfully. This statement must be included in the DB2 vendor environment
file:
BACKOM_LOCATION=fully qualified path and name of the backom executable

The DB2 backup command can then be entered on the DB2 command-line
interface:
db2 backup db database alias online load shared library open 2 sessions

Use the Backup Object Manager query function to verify whether a TDI image is
available for a Data Protection for SAP backup image.

Redirected restore prerequisites


The following requirements must be met for the Backup Object Manager to
successfully run a redirected restore.
v Only a backup of type FULL can be used for a redirected restore.
v A TDI image must be available for the backup to be restored.
v The database must not have a tablespace container that is a raw device.
v DMS tablespace containers of the original system are available in these locations:
– UNIX or Linux:/db2/SAPSID/sapdatan
– Windows: drive:\db2\SAPSID\sapdatan (n is an integer)
v SAPSID must be the database alias (SAPSID) and must consist of all uppercase
characters or digits

Chapter 6. Protecting data 85


v SMS tablespace containers of the original system are available in these locations:
– UNIX or Linux: /db2/SAPSID/...
– Windows: drive:\db2\SAPSID\...

Tablespace definition information


To perform a redirected restore, Backup Object Manager requires information about
the physical layout of the original database, such as the tablespace containers used
by the original database.

The size of database managed containers (DMS) must be available to create new
tablespace containers with sufficient space. Backup Object Manager keeps
information about all tablespaces of a database that is backed up for every backup
image on Tivoli Storage Manager. The following information is collected for each
tablespace:
v The ID and name of the tablespace.
v Whether the tablespace type is system (SMS) or database managed (DMS).
v Whether the tablespace is managed by automatic storage.
v The page size in bytes.
v The extent size in pages.
v The number of pages used.
v The tablespace containers that are used for the tablespace:
– The ID of the tablespace container.
– The name of the tablespace container (the directory that contains an SMS
container or the file that contains a DMS container).
– Whether the tablespace container type is a database managed container that is
stored in a file or on a raw device.
– For DMS tablespaces, the total number of pages that are stored in the
container.
This information about the physical database layout is referred to as the Tablespace
Definition Information (TDI) and is stored along with the production data. The TDI
is required for Backup Object Manager redirected restore operations. A TDI image
is identified with its corresponding DB2 backup by the combination of DB2
instance name, database alias, database node number, and the timestamp of the
backup as shown here:
DB2 instance-DB2 alias-DB2 node number-timestamp.tdi

The TDI is stored in ASCII format to allow for read and edit usability. For
example, the number of used pages that are recorded in the TDI image can help
identify the correct sizes to request when resizing containers. Backup Object
Manager also calculates the number of total pages and used pages from the data
that is stored for each tablespace container. Editing might be necessary when you
request a redirected restore in batch mode.

86 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Protecting SAP data with the Administration Assistant for Data
Protection for SAP
Instructions about how to protect your SAP data with the Administration Assistant
for Data Protection for SAP is provided.

About this task

Follow these tasks to protect your SAP data with the Administration Assistant for
Data Protection for SAP.

Administer user IDs


The administer users function allows accounts to be created or deleted and user
permissions to be granted or revoked.

Profiles for authorized users must be created when the Administration Assistant is
started for the first time. The online help provides details on creating profiles. For
each SID in the system landscape, the following permissions can be granted:
v Simulate backup/restores: To initiate simulations
v Configure groups: To configure display groups to be used with Monitor backup
states
v Problem support: To send support request mail
v Operations monitoring: To view backup status information
v User administration: To manage user accounts
v Performance monitoring: To view performance data
v Configuration: To change the configuration of Data Protection for SAP
Additionally, a user can be granted permission to configure parts of the internal
logic of the Monitor backup states function.

Specifying a new Administration Assistant for Tivoli Storage


Manager for ERP
If the Administration Assistant for Tivoli Storage Manager for ERP is not installed,
you can establish a connection when needed by following these instructions.

About this task


If you must specify a new Administration Assistant for Tivoli Storage Manager for
ERP Server component, do the following steps on the SAP database server:

Procedure
v On a Linux system, find the entry for daemon ProLE in /etc/inittab. Modify
the entry to read as follows:
.../prole -p tdpr3db264 Server component hostname port

where <Server component hostname> is the name or IP address of the host that
runs the Administration Assistant Server component and port is the port the
Server component is listening to for connects from Tivoli Storage Manager for
ERP for DB2 (default 5126). If upstart is configured, add the <Server component
hostname> and port to the init script /etc/init/prole_db2.conf.

Chapter 6. Protecting data 87


v Make sure that Tivoli Storage Manager for ERP is not running, and use the kill
command to stop the ProLE daemon. The ProLE daemon is restarted
automatically with the new parameters.
v Log in as a user with administrator authority and enter the following command:
prole -update -p tdpr3db264 Server component hostname port.
v Enter the following command : where<Server component hostname> is the name
or IP address of the host that runs the Administration Assistant Server
component and port is the port that the Server component is listening to for
connects from Data Protection for SAP (default 5126).

Generating reports using report templates


When report templates are available, the Administration Assistant for Data
Protection for SAP reports can be started automatically at given points in time by
using a preferred scheduler.

About this task

The scheduler must call the scheduler interface Sched_Main, which can be started
from a scheduling client.

The scheduling interface is called by using this command syntax:


java -cp $CLASSPATH com.ibm.bkit.schedulerIF.Sched_Main Server component hostname...
... RMI registry port template name userid password...
... directory=local directory log=log path

v Server component hostname: The name or IP address of the host that runs the
Administration Assistant Server component.
v RMI registry port: The number of the RMI registry port of the Administration
Assistant Server component as defined in its configuration file (assist.cfg). The
default value is 1099.
v template name: The name of the appropriate report template to be used. It must
be available in the user template path in the Administration Assistant Server
component.
v userid: The Administration Assistant account of the template owner.
v password: The password that is associated with userid.
v local directory: The local path in the system of the scheduling client where the
requested reports are to be stored. If the local directory is not specified, the
reports are not stored in the local file system. To access the report, the
administrator needs file system access to the Administration Assistant server
where the report is kept for 24 hours.
v log path: The local path in the system of the scheduling client where the
scheduling client saves its own log files.
Consider creating a command file that sets the correct environment and schedules
one (or more reports) on the scheduling client system. If many clients try to
connect to the Administration Assistant server simultaneously, some of them might
not immediately connect. In this case, the scheduling client waits for a random
time 15 - 45 seconds before another attempt is made. After the second unsuccessful
attempt, the scheduling client creates an error log and exits.

88 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Requesting a report from the Administration Assistant
Request a report using the Create Report function on the Administration Assistant
for Data Protection for SAP.

About this task

Reports can be run from the Administration Assistant for a particular SID. Use the
Backup State >Detailed View> View Performance Data (History Mode)> Available
Simulation Results panels to run the report for the SID shown.

Reports that are requested from the Monitor Backup States panel contain
information about all SIDs displayed. Selections that are made in the table of
systems do not have an impact on the report created. However, active filters or the
activation of a display group is reflected in the report. A time interval can be
specified in the report. Backup operations are included in the report if they
completed within the specified time interval. Also, some reports can include
information about log files.

Starting and stopping the Administration Assistant


You can manually start or stop the Administration Assistant by using the following
command files in the installation directory.

About this task

Note: When the Server or Database Agent components are started, a lock file
(.lockAA and .lockDBA) is created. If either of these components are stopped or
restarted by using the delivered scripts, the respective lock file is also deleted. If
for some reason the lock file still exists when the component is started, the request
fails with an error message. In this case, first verify that the process is not already
active. If it is not active, the lock file must be deleted manually and the start
request reissued.

Procedure
v Issue this command to start or stop the Administration Assistant Server
component:
(UNIX and Linux):
sdba.sh start|stop Database Agent configuration file

(Windows):
sadma.cmd start|stop Server component configuration file

v Issue this command to start or stop the Administration Assistant Database


Agent:
(UNIX and Linux):
sdba.sh start|stop Database Agent configuration file

(Windows):
sdba.cmd start|stop Database Agent configuration file

v When you use the bundled Apache Derby, issue this command to start or stop
the Administration Assistant Database component:

Chapter 6. Protecting data 89


(UNIX and Linux):
sdb.sh start|stop

(Windows):
sdb.cmd start|stop

v When you use the IBM DB2 data server, use DB2 built-in utilities or commands
to start or stop the database. Refer to your IBM DB2 data server documentation
for complete instructions.

Changing the password for the Administration Assistant for


Data Protection for SAP database user ID
The password for accessing the internal Administration Assistant for Data
Protection for SAP database can be changed by using the changeSettings.jar
program.

About this task

This program was added to the installation directory in the utils subdirectory:

Procedure
1. Change to the utils directory and issue the command
java –cp changeSettings.jar run

2. Select the type of database you are using with the Administration Assistant for
Data Protection for SAP (Apache Derby or IBM DB2).
3. Enter the directory that contains the encrypted password file (pass.enc).
4. Enter the user ID and the existing password.
5. Enter the new password.
6. For Apache Derby only: To apply the new password to the database, check the
box that is provided. Otherwise, the password file is updated, but the database
change must then be completed manually.
7. Click Next to complete the change.

Determine throughput rates


There are a few factors that affect throughput rates.
Table 6. Summary: How to determine throughput rates
Network throughput
Disk I/O rate Storage media rate rate
Simulation type No data moved to No data moved to No data moved to
and from Tivoli and from disk and from disk
Storage Manager
Disk transfer rate - infinite infinite
Network transfer rate infinite - -
Tape rate infinite - -
RL compression off off off
Multiplexing 1 1 1

90 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Table 6. Summary: How to determine throughput rates (continued)
Network throughput
Disk I/O rate Storage media rate rate
Number of sessions 1 1 maximum number

Determine the disk I/O rate


Run a simulated backup of type No data moved to Tivoli Storage Manager to
determine the actual disk reading rate.

Both the Tape Transfer Rate and the Network Transfer Rate must be set to
infinite to ensure that there is not a network bottleneck. Compression must be
turned off and the View Performance Data function is to show 100 % disk usage.
The overall throughput that you get with this configuration is the rate at which
data is read from disk. To determine the actual disk-writing rate, run a simulated
restore of type No data moved to Tivoli Storage Manager. Both the Tape Transfer
Rate and the Network Transfer Rate must be set to infinite to ensure that the
system is not to create a network bottleneck. Compression must be turned off and
the View Performance Data function is to show 100 % disk usage. The overall
throughput that you get with this configuration is the rate at which data is written
to disk. An increased disk I/O rate is shown while data is written to the file
system cache.

Determine the network throughput rate


Run a simulated backup of type No data moved from disk to determine the actual
network throughput rate.

The disk transfer rate must be set to “infinite” to ensure that there is not a disk
bottleneck. Increase the number of sessions to the maximum number possible (for
example, the number of available tape drives). Ensure that the tape transfer rate is
not the limiting factor. Check that the throughput rate is less than the media rate
multiplied by the number of sessions. This information is provided in the
“Determining the Actual Throughput Rate of Storage Media” section. The View
Performance Data function is to show 100 percent network usage. The overall
throughput that is provided with this configuration is the network throughput
rate.

Reporting on simulations
An overview of simulation parameters and results for a single SID is contained in
the Simulation Report.

The report is requested from the Available Simulation Results panel and displays a
screen capture similar to this panel.

Chapter 6. Protecting data 91


Figure 12. Simulation Report

Simulating backup and restore


The Administration Assistant simulated backup/restore function requires a full
backup of the database by using the file interface (BRBACKUP).

Both backups and restores can be simulated. A restore simulation might provide
information about the duration of the restore operation but it does not affect your
production system. When there are two (or more) eligible backups available, the
latest one is used as the basis for simulation. Compression must be enabled for the
base backup and the COMPR_INFO parameter must specify a valid file in the Data
Protection for SAP profile. These environment components are available for
simulation:
Disk I/O
No data is read from the disk when disk I/O is simulated for a backup.
Data is generated in memory instead. When simulating disk I/O for a
restore, data is absorbed and is not written to disk. The disk I/O rate to be
used for the simulation is set by the administrator.
Network transfer and media rates
No data is sent through the network when network transfer and media
rates are simulated for a backup. The data is absorbed instead. When
simulating network transfer and media rates for a restore, no data is
expected from the network and the data is generated in memory instead.
However, a connection to the Tivoli Storage Manager server must be
maintained during the simulation. Therefore, configure the Tivoli Storage
Manager server so that the sessions do not time out. The network
throughput rate and the media rate that is used for the simulation can be
set by the administrator.
Configuration changes
When simulating configuration changes, performance parameters (in the
Data Protection for SAP profile) can be modified to test for the optimum
configuration within an infrastructure. During a backup configuration
simulation, data is read from disk and written to a special file space in
Tivoli Storage Manager and does not affect production backups. During a
restore configuration simulation, data is retrieved from the Tivoli Storage
Manager server and written to disk before they are deleted.

92 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Determine the throughput rate of storage media
Run a simulated backup of type No data moved from disk to determine the actual
writing rate of a tape.

The Disk Transfer Rate must be set to infinite to ensure that there is not a disk
bottleneck. The number of sessions must be set to one and compression must be
turned off. The View Performance Data function is to show 100 percent disk usage.
The overall throughput that is provided with this configuration is the rate at which
data is written to the storage media unless the network rate is lower than the
media rate. To determine the actual reading rate of a tape, run a simulated restore
of type No data moved from disk. The Disk Transfer Rate must be set to infinite
to ensure that there is not a disk bottleneck. The number of sessions must be set to
one. To exclude a CPU bottleneck, ensure that the View Performance Data function
shows 100 percent network usage. The overall throughput that is provided with
this configuration is the rate at which data is read from the storage media unless
the network rate is lower than the media rate. The throughput rate might not
increase when the number of sessions is increased. In this situation, the network
throughput rate is lower than the media rate, and the media rate cannot be
determined with the Administration Assistant.

Chapter 6. Protecting data 93


94 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 7. Tuning performance
Information needed to tune Data Protection for SAP performance is provided. A
system is considered balanced when the threads on the disk and the network sides
are similarly busy throughout the backup, and when resource usage is good. To
improve overall throughput, consider adding more resources to create a balanced
system.

About this task

In an optimum setup, a slight network bottleneck is preferred. Under certain


conditions, the degree of imbalance cannot be determined from the graphical
presentation. Depending on your system characteristics that include system
buffering and buffer sizes, usage might reduce to almost zero in the graphical
presentation although the system is balanced. In this case, slight modifications can
yield a change of bottleneck without significant throughput changes. However,
whether the system is disk or network, tape constraints are always shown
correctly. A balanced system, however, does not necessarily mean that the data
throughput cannot be improved further. Adding new resources can improve the
throughput rate.

Figure 13. A balanced configuration

Procedure
v Maintain an optimum setup by ensuring tapes are maintained in streaming
mode.

© Copyright IBM Corp. 1995, 2014 95


v Ensure that there is no network idle time, and that the network is at least as fast
as the tape.
v Consider adding new resources to improve the throughput rate.

Example of a disk bottleneck


A disk bottleneck occurs when data is processed by the network and Tivoli Storage
Manager server faster than the data can be read from disk. As a result, overall
throughput is limited by the disk I/O rate and the network thread is idle.

Although internal buffering causes network threads to return quickly, the network
usage might be reduced to almost zero in this situation. Both the network and the
storage media are not used to their capacity. When tapes are used, they are not
kept in streaming mode when this type of bottleneck occurs. Overall throughput
can be improved by increasing multiplexing (which accelerates disk reading) or by
ensuring that data compression is not used. Reduce the number of sessions to the
Tivoli Storage Manager server and the number of tapes that are used for the
backup, while increasing multiplexing, to improve resource efficiently.

Figure 14. Indicating a Disk Bottleneck

Example of a network or Tivoli Storage Manager bottleneck


A network or Tivoli Storage Manager bottleneck occurs when data is read from the
disk faster than the network or Tivoli Storage Manager can process the data.

Throughput is limited either by the network capacity or by the disk or tape storage
media rate. In-depth analysis is typically required to identify the exact cause of the
bottleneck. However, some insight is obtained from the Data Protection for SAP
performance analysis. Overall throughput might be improved by implementing
any of these guidelines:
v If the tape is the bottleneck, increase the number of sessions to the Tivoli Storage
Manager server.
v Use multiple paths to the Tivoli Storage Manager server or use multiple Tivoli
Storage Manager servers.

96 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v Use RL compression to reduce the amount of data to be sent to storage.
To make better use of the resources, consider reducing multiplexing so that less
data is read simultaneously from the disk. If the database is configured for
file-online backup, reducing multiplexing also reduces the number of redo logs
that are created during the backup.

Figure 15. Indicating a Network or Tivoli Storage Manager Bottleneck

Viewing performance data


Use the Administration Assistant View Performance Data function to show a
graphical representation of the data throughput rate at any point in time during
the backup.

Chapter 7. Tuning performance 97


Figure 16. Showing data throughput and I/O usage

The utilization rates of the disk and network threads are also shown. The
Administration Assistant displays the usage rates of the disk in blue and the
network threads in yellow. Optionally, the free capacity of these threads can be
displayed. These rates can be shown for all Tivoli Storage Manager sessions that
are used in the backup or display rate on a per-session basis only. Time intervals
that require further analysis are selected for viewing in replay mode as described
in “Drilling down into performance data.” Data Protection for SAP for DB2
performance sensor results are displayed by using the Administration Assistant
View Performance Data function. The Administration Assistant collects historical
data during each backup run for analysis. To find the results, select View
Performance Data, select History Data. In the list of eligible backups, select the
backup to be analyzed. Click Review to view the performance data summary
panel.

Drilling down into performance data


When you see occurrences of throughput or usage reduction in the performance
diagrams in the Administration Assistant, you can drill in to find more details.

To better understand what happened, drill down on these time intervals. In most
cases of a changed performance, a session ended or a shorter file was multiplexed
with longer files.

98 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Use the reports
After a backup completes, Data Protection for SAP for DB2 creates a report that
contains statistical information such as the number of bytes transferred and the
effective data throughput. The Administration Assistant program provides detailed
performance information that can help you to optimize your system. Reports can
be printed in XML or HTML formats.

Performance analysis

The Administration Assistant provides performance data for all components that
are involved in the data transfer. Graphical representations are provided to help
identify problem areas and resource use.

Tracing

Trace information can be recorded in a file to help analyze problems that occur.
However, contact your Data Protection for SAP support before you attempt to use
this function.

Monitoring the backup status

Backup status of multiple SAP database servers is available by using the


Administration Assistant.

Reporting on the performance of backup operations


The performance data of a single backup is included in the Performance Report.
The transfer rate and the usage of adapters for each session are also displayed. The
report is requested from the View Performance Data (History Mode) panel.

Chapter 7. Tuning performance 99


Figure 17. Performance Report - Graphical Presentation Section

100 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 18. Performance report - tabular presentation section

Reporting on backup status


The Administration Assistant for Data Protection for SAP provides information
about the backup status of the monitored SAP database servers. You can access this
information by choosing Monitor Operations, Monitor Backup Status.

You can view reports that lists status information in tabular format. The overview
information that is provided in the Monitor Backup States panel is provided in the
Status Report.

Figure 19. Status report

Chapter 7. Tuning performance 101


Create a report
Reports can be run from the Administration Assistant or the scheduling client
through the command line. You can choose to print or save reports locally.

Consider this information when you plan to create a report:


v Reports are produced in XML or HTML, with graphic files in SVG format. The
entire report is displayed in the browser.
v Files that are created can be printed or saved to the local file system by using
the browser functions. All reports are temporarily stored for 24 hours on the
Administration Assistant server in these subdirectories:
Administration Assistant install dir/reports/
report type_time stamp_userid/

File system access to the Administration Assistant server is required to access


reports that are stored in the report cache.

Reporting on failed actions


Information about failed backup operations is provided in the Operations Failure
Report. Use the Monitor Backup States panel to run this report. You can choose to
include information about failed backups of log files in this report.

Figure 20. Operations - failure report

Report output and style sheets


All report requests result in the information that is being written to an XML file.
Administration Assistant style sheets can be customized for the Data Protection for
SAP Server component. Style sheets are used to generate the information to
different types of reports in HTML or SVG format. They determine the appearance
and contents of a specific report.

When you are modifying a report, you must consider the following items:
v To generate a report, at least one report-specific style sheet is necessary for the
transformation from XML to HTML. If a report contains graphics, each graphic
is transformed to an SVG file, which requires a separate style sheet. In this
scenario, a single report needs a set of style sheets.
v The Administration Assistant provides two types of style sheet file sets. One set
is contained in file Admt.jar and is used as the default. The second set of style
sheets is on the Administration Assistant server in the Admin. Assistant
install dir/styles/ directory.

102 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v Style sheet names must be of the format report_name_<file format>.xsl where
file format denotes the file type (HTML or SVG) and report name denotes the
name of the file to be created. For example, Picture1_svg.xsl generates a file
that is named Picture1.svg. The name of the HTML file must always be 'report'.
v The styles directory currently contains four subdirectories: Overview, Detailed,
History, Simulation. These styles specify reports that are based on different XML
data sources as provided in the corresponding Administration Assistant panels
Monitor Backup States, Backup State Detailed View, and View Performance Data
(History Mode). The names of these folders are displayed in the list of selectable
report types within the Create Report dialogs.
v For every report type, an extra file, config.xml, exists in the styles subdirectory.
This file specifies default settings of the Create Reports dialogs. For example, the
Operations Daily Report has a reporting interval of 24 hours. Therefore,
specifying the end of the time frame is not necessary, and the corresponding
button is hidden.
v All style sheets that are contained either in file Admt.jar or in the styles
directory are displayed for selection in the Create Report dialogs of the
Administration Assistant. Style sheets that are contained in Admt.jar are marked
by the addition “(built-in)”.

Reporting on operations details


View detailed information about the latest backup operations for a single SID with
the Operations Detailed Report. Select an SID in the Monitor Backup States panel,
and choose Backup State, Detailed View from the Administration Assistant.

Chapter 7. Tuning performance 103


Figure 21. Operations – detailed report

Reporting on backup operation trends


Run a daily report of backup operation trends through the Administration
Assistant. This report type contains general information about the backups of a
single SID. The graphic displays the amount of data that is saved for a single day.

A monthly report produces a graphic that displays the backup duration, amount of
saved data, throughput, and log file data for a specified time interval. These
reports are requested from the Administration Assistant for Data Protection for
SAP Backup State Detailed View panel. You can access this panel by selecting a
single SID in the Monitor Backup States panel.

104 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 22. Operations daily report

Reporting on Data Protection for SAP activities


The Administration Assistant for Data Protection for SAP monitors, and
administers backup configuration and performance information. The
Administration Assistant Server and Database Agent components collect status,
performance, and configuration data from SAP database servers. The data is
retained for a limited time. Reports can be created in XML or HTML format using
the Administration Assistant. This action is useful when there is no access to the
Server component.

Administration Assistant reports contain the same information that is displayed by


the Administration Assistant Monitor Operations and View Performance Data
functions. All information is provided in XML format. In addition, the
Administration Assistant provides style sheets that are used when these reports are
generated in HTML format:
v Status Report
v Operations - Detailed Report
v Operations - Daily Report
v Operations - Monthly Report
v Operations - Failure Report
v Performance Report
All built-in reports are created in English.

Chapter 7. Tuning performance 105


Report templates
A template must be created before a report can be generated without user
interaction, for example when you use a scheduled script. Templates are created in
the same way as reports are requested from the Administration Assistant.

When you click Create Report, you are prompted to create a report or use the
corresponding template. Each template must be given a unique name, which is
used when you reference the template. The template is stored in a file with the
given name in path <Administration Assistant install dir>/templates/userid/
where <Administration Assistant install dir> is the Administration Assistant
server installation path. The file extension depends on the type of report requested.
A single template can be used to generate reports on several SIDs. A template is
owned by the user account that creates it and cannot be accessed from a different
account. To view, change, or delete owned templates, an administrator can use the
Manage templates function in the Administration Assistant View menu.

Server-related tuning
You can manage the data that is stored on the Tivoli Storage Manager server for
Tivoli Storage Manager for ERP. You can manage which servers are used to store
data.

Manage data on the backup server


The Data Protection for SAP for DB2 Backup Object Manager can search for
backup objects on the Tivoli Storage Manager server to restore or delete them.

See “DB2 Backup Object Manager utility” on page 4 for more information.

Alternate network paths and servers


Multiple network paths and multiple backup servers can be specified. When the
number of available sessions to multiple servers exceeds the number of sessions
that are allowed, Data Protection for SAP for DB2 uses the first sessions that it can
establish.

Data Protection for SAP for DB2 continues to use the number of sessions that are
allowed as defined by the MAX_SESSIONS keyword. For more information, see
“Profile parameter descriptions” on page 140. This setup allows data to be backed
up even when a resource (such as a Tivoli Storage Manager server or its network
interface) is unavailable. The servers that are used for the backup must be
available to restore the data. The days of the week that a server is used can also be
specified as described for the USE_AT keyword on page “Profile parameter
descriptions” on page 140.

Options
Use Tivoli Storage Manager for ERP Data Protection for SAP options to tune
performance.

Tune performance for Data Protection for SAP by using multiple sessions, network
paths, servers, or through multiplexing and other options.

106 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Performance options for Data Protection for SAP
Data transfer rates are impacted by the types of disks that are used for the
databases, the network capabilities that are accessed by the database host and the
Tivoli Storage Manager server, and the type of storage device that contains the
backup.

Data Protection for SAP provides the following options to help optimize the data
transfer rate for these components.
Parallel and multiple sessions
Data Protection for SAP can back up or restore data to multiple tape drives
in parallel. Parallelism is achieved by using more than one session to send
data to a backup server.
Multiple and parallel network paths and servers
Improve performance by configuring Data Protection for SAP to distribute
a database backup across two or more Tivoli Storage Manager servers. In
addition, you can balance network traffic by providing two (or more)
separate network connections between the SAP database host and the
Tivoli Storage Manager server.
Incremental and delta backups
Data Protection for SAP supports incremental and delta backups of DB2
databases. Depending on the system environment, incremental backups
might decrease backup processing time.
RL_COMPRESSION
The RL_COMPRESSION profile keyword is compresses a partially filled
database. This process can result in reduced network traffic and fewer
tapes that are required for backup.

Adjustments for improving performance of data transfer

Data Protection for SAP is configured to send uncompressed data to the Tivoli
Storage Manager server that uses a single session.

Figure 23. Data transfer for a backup and restore

A single configuration that is best for all environments is not possible or realistic.
However, the information that is provided here can help in determining which
configuration is best for your environment. The Administration Assistant provides
the View Performance Data feature, which provides information about
performance characteristics and how they change with your configuration.

Chapter 7. Tuning performance 107


Buffer copies
You can change the Data Protection for SAP options to prevent copying data
buffers, the original data buffers are sent between Tivoli Storage Manager
components. This change can improve performance.

Data Protection for SAP for DB2 uses internal buffers to store and exchange data
with the Tivoli Storage Manager Server. When data is sent from one component to
another, data buffers are copied by default. Data Protection for SAP can prevent
copying data buffers by sending the original data buffers. This process reduces the
CPU load of the database server.

Buffer size
Adjust buffer size disk I/O to improve transfer rates.

The internal data buffer size can be adjusted for Data Protection for SAP for DB2 .
These buffers are used for reading the disk and sending data to the Tivoli Storage
Manager client API. The default values typically produce acceptable performance.

Optimize the buffer size for disk I/O to improve transfer rates. For disk
subsystems, the best transfer rates are achieved when the buffer size is set equal to
the stripe size. Before you increase the size of internal buffers, however, ensure that
sufficient storage is available for the number of buffers that are specified by Data
Protection for SAP. This number correlates to the number of sessions requested.
The number of buffers doubles when compression is specified. For more
information, see the description of BUFFSIZE keyword on page “Profile parameter
descriptions” on page 140.

Compression of data for backup


You can adjust the amount of data that is being sent to the Tivoli Storage Manager
server by compressing zero-byte blocks (RL_COMPRESSION profile keyword).

Figure 24. Null Block Compression

Data Protection for SAP for DB2 can decrease the amount of data that is sent to the
Tivoli Storage Manager server by compressing zero-byte blocks. Compression can
increase the CPU load on the database server and can improve performance in
situations when the network is at the point of constraint. Compression is most
effective with database files that contain large portions of null blocks. See the
description of the RL_COMPRESSION keyword on page “Profile parameter
descriptions” on page 140 for details on how to activate Data Protection for SAP
for DB2 compression.

108 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Automation options for Data Protection for SAP for DB2
Administrative productivity can be improved by using the Data Protection for SAP
for DB2 automation options.

Selectable management classes

Specify different Tivoli Storage Manager management classes for backup data and
archive data. Configure Data Protection for SAP to back up directly to a tape
storage pool and to archive log files to a disk storage pool.

Multiple management classes can be specified to use with multiple DB2 log files.
For more information about specifying management classes, see “Profile parameter
descriptions” on page 140.

Retain backups by version

Retaining backups by version limits the number of full backups that are retained
on the Tivoli Storage Manager server. When the number of full backups on the
Tivoli Storage Manager server exceeds the specified number, the oldest version is
deleted. Retaining backups provides a trace of all DB2 log files, and all incremental
and delta backups, that are associated with a full backup. All these objects are
removed together with the full backup.

Multiple redo log copies

Backing up multiple copies of a log file in a single archive operation helps protect
against this data in the event of tape defects or disaster recovery situation. These
copies can be on different physical Tivoli Storage Manager volumes or on different
Tivoli Storage Manager servers. When a log file copy is unavailable at restore time,
Data Protection for SAP automatically switches to another copy. It continues
restoring the log file from that copy. The description of the profile keyword
REDOLOG_COPIES in “Profile parameter descriptions” on page 140 provides
detailed information about creating and by using multiple redo log copies.

Alternate network paths and servers

The availability of backed up data can be improved by configuring Data Protection


for SAP to use multiple Tivoli Storage Manager servers or multiple network
connections to a single Tivoli Storage Manager server. In this configuration, Data
Protection for SAP checks all servers and network connections for availability and
then does the backup even if some resources are unavailable. Policies can also be
set that use different Tivoli Storage Manager servers for different days of the week.

Messaging

Policies can be created that enable Data Protection for SAP to send different classes
of log messages to the Tivoli Storage Manager server.

Frontend and backend processing

Frontend and backend processing calls programs at specified times during backup
processing. See the description of the profile keywords BACKEND and
FRONTEND in “Profile parameter descriptions” on page 140.

Chapter 7. Tuning performance 109


Data transfer
When you use Data Protection for SAP for DB2, data is passed from disk through
to the network and finally to tape. A balanced configuration can help to prevent
bottlenecks and to ensure optimized performance.

Data throughput rate


Throughput rates differ for different environments because of different disk,
network bandwidth, server systems, number of tapes, and configuration settings.
When you are moving data, certain elements that are used in the movement of
data can be tuned to improve data throughput.

Throughput rates differ widely among various environments because of different


disk, network bandwidth, server systems, number of tapes, and configuration
settings. The information that is provided here concentrates on selected elements
that are involved in the movement of data. This information determines how to
use existing resources to their maximum efficiency and provide insight as to how
throughput can be improved.

Figure 25. High-level view of the data flow during backup

From a high-level view, the data packages must send these elements when it does
a backup with Data Protection for SAP for DB2 : Data is read from disk that is
processed by Data Protection for SAP, and sent through the network to tape or
disk storage media. If the system is not balanced, the disk I/O, network
bandwidth, and storage media rates might create a bottleneck. This situation can
cause other resources to remain idle. Overall data throughput is typically measured
per file or per entire backup operation. The results are documented as an average
throughput rate in the logfile as the average transmission rate. However,
identifying bottlenecks that are derived from log file messages is difficult. For this
analysis effort, Data Protection for SAP provides performance sensors that indicate
a bottleneck. These bottlenecks are located either in the elements that are
represented in blue (for disk) or in yellow (for network and tape respectively) in
the graphic.

110 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Data Protection for SAP for DB2 performance sensors
Data Protection for SAP for DB2 uses sensors that observe incoming and outgoing
data streams. They measure throughput and the idle time of the I/O threads in
comparison to the duration of the backup. This function provides a way to
determine whether the streams of incoming and outgoing Data Protection for SAP
data are balanced.

The method of transferring data packages depends on how Tivoli Storage Manager
is configured. In a standard configuration, the data packages are sent from the
Tivoli Storage Manager API Client through the network to the backup server. In an
environment that is configured for LAN-free operations, the data packages are
processed by the Tivoli Storage Manager API Client and the Tivoli Storage
Manager Storage Agent.
When a backup operation begins, filling the buffers is necessary before the effects

Figure 26. Performance Optimizing by Using Sensors

of a bottleneck are viewable.

Performance tuning for data transfer


During data transfer, a continuous stream of data is generated between the SAP
database server, the network, and the Tivoli Storage Manager server. The weakest
component in this stream decreases the overall data transfer rate.

Figure 27 on page 112 provides an overview of the three main components that are
involved during a Data Protection for SAP for DB2 data transfer:
v The SAP database server.
v The network.
v The Tivoli Storage Manager server, which is also referred to as a backup server.

Chapter 7. Tuning performance 111


Figure 27. Data Protection for SAP Data Transfer

Multiple servers
Data Protection for SAP for DB2 supports multiple servers, which can distribute
backup data among two (or more) backup servers. This feature helps eliminate
constraints that are frequently encountered among backup servers.

Figure 28. Multiple Servers

A server statement must be entered in the Data Protection for SAP profile for each
adapter of the backup server. A description for the SERVER keyword is given in
“Profile parameter descriptions” on page 140. The value of the MAX_SESSIONS
keyword is not greater than the sum of all SESSION values specified for the
SERVER statements that are used concurrently.

112 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Multiple sessions
You can use multiple tape drives simultaneously to increase the transfer rate to or
from the Tivoli Storage Manager server. Several backup sessions access the
database in parallel on the database server, and the data is written simultaneously
to several tape drives.

Figure 29. Parallel (Multiple) Sessions

The is used to define the number of parallel sessions to be established with the
Tivoli Storage Manager server for database backup, archive (backup of log files)
and restore. For a detailed description of how to use this keyword, see page
“Profile parameter descriptions” on page 140. When you run a database backup,
the data is typically written directly to tape drives on the Tivoli Storage Manager
server. The parameter that is specified in the MAX_SESSIONS keyword must
match the number of tape drives that are used simultaneously.

These must be available to the management class defined as


BRBACKUPMGTCLASS in the Data Protection for SAP profile as described on
page “Profile parameter descriptions” on page 140. When you set up the Tivoli
Storage Manager server, make sure not to activate collocation in the (tape) storage
pool that is defined for the management class that is chosen as
BRBACKUPMGTCLASS. In addition, ensure that as many tape drives for this
management class are available as the number of sessions that are defined in
MAX_SESSIONS. Multiple access to the same tape might slow down data transfer.

These must be available to the management class defined as


BRARCHIVEMGTCLASS in the Data Protection for SAP profile. If you are using
tape pools as primary pools for this management class, this consideration for
database backups also applies to disk storage pools. Several DB2 log archive
sessions can simultaneously use one or two independent disk storage pools.

The number of storage pools that are required depends on the number of backup
copies that are requested for a DB2 log file. See keyword REDOLOG_COPIES in
“Profile parameter descriptions” on page 140.

Multiplexing
Multiplexing uses parallel access points to data on the database server. This
configuration is useful when tape drives are used during database backup
operations on the backup server.

Chapter 7. Tuning performance 113


Figure 30. Multiplexing

This feature is provided by the PARALLELISM parameter available with the BACKUP
DATABASE and RESTORE DATABASE commands. Refer to your DB2 Command Reference
for details about these commands and the PARALLELISM parameter.

Multiple network paths


Data Protection for SAP for DB2 allows multiple network connections (paths) for
data transfer between the database server and the backup server. Parallel paths can
be used to eliminate network points of constraint.

Figure 31. Parallel (Multiple) Paths

For each additional path, more network adapters are required on both the
production and the backup server. A server statement must be entered in the Data
Protection for SAP profile for each adapter of the backup server. This scenario is
described for the SERVER keyword on page “Profile parameter descriptions” on
page 140. The value of the MAX_SESSIONS keyword is not greater than the sum
of all SESSION values specified for the SERVER statements that are used
concurrently. Detailed information about setting up multiple parallel network paths
is described in “Parallel backup paths and backup servers” on page 18.

Storage space
You can manage aspects of storage space to tune the performance of Tivoli Storage
Manager for ERP.

114 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Automated tablespace adaptations
Backup Object Manager can adapt the sizes of tablespace containers when it
creates the containers of the target databases during a redirected restore operation.

For example, tablespace container sizes might be increased to provide more space
or decreased to use storage more efficiently. Tablespaces can also be allocated with
similar sizes to make parallel I/O operations more efficient. These features are
supported by Backup Object Manager resizing and normalizing functions.

Tablespace normalization
To achieve optimal parallel I/O operation performance for a database, all
containers of a tablespace are to be the same size. During tablespace maintenance,
containers might be added or extended which creates different container sizes. As a
result, data is unevenly distributed among the containers, which can result in
decreased parallel I/O operation performance during table scans (sequential
prefetching).

Backup Object Manager provides an automated tablespace normalizing function


that allows the location and size of tablespace container to be redefined. This
function also helps prevent I/O-intensive tablespace rebalancing that can be
detected by DB2.

Figure 32. Tablespace Normalizing

This graphic shows that the original system tablespace consists of different-sized
containers. Although sequential prefetching allows three processes to
simultaneously read the data during table scans, the different container sizes and
uneven data distribution prevent parallel I/O during part of the scan. The degree
of parallelism decreases over time. To counteract this situation, adjust the

Chapter 7. Tuning performance 115


containers for each tablespace so that they are the same size. This type of
adjustment, in combination with a redirected restore operation, requires no further
resizing tasks for the tablespace containers after the restore completes.

Backup Object Manager simplifies the tablespace container resizing process by


providing an automatic tablespace normalizing function. It can be used in
combination with any mode of redirected restore facility by specifying the -N
option. Issue this command to resize each container of a tablespace to the average
size of all containers within the same tablespace during a redirected restore:
backom -c rr_db_type -aDB2 source alias,DB2 target alias -t timestamp -N

After the redirected restore completes successfully, all containers of a tablespace of


the target database are the same size. As a result, the continuous parallel I/O
performance of the physical layout of the restored database is optimized.

Scaling tablespace containers


Sufficient free space must be available in a tablespace for the database to function
properly. Backup Object Manager provides an automated table space scaling
function that allows the location and size of table space container to be redefined.
This function also helps prevent I/O-intensive table space rebalancing that can be
detected by DB2.

About this task

This graphic shows that 98% of the SYSCATSPACE table space of the original
system is being used. Disk 1 has 4% free space while 100% of the second container
is used. The free space available in a table space can be increased as part of the
redefinition feature during a redirected restore. The goal is to achieve an overall
filling rate for the target side of 70%. This rate can be achieved by manually
increasing the free space that the first container must provide at 20% and 40% for
the second container. This type of adjustment, in combination with a redirected
restore operation, requires no further resizing tasks for the table space containers
after the restore completes.

116 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Figure 33. Tablespace scaling

Backup Object Manager simplifies the table space resizing process by providing an
automatic table space scaling function. It can be used in combination with any
mode of redirected restore by specifying the -S option with a floating-point sizing
factor. Consider these factors when you resize table spaces:
v A value of '1' indicates that the target table space is 100% the size of the original
(nothing is changed).
v A value greater than one increases the target table space. For example, a value of
1.1 increases the target table space by 10% to a target value of 110% of the
original.
v A value less than 1 decreases the target table space. For example, a value of 0.9
decreases the target table space by 10% to a value of 90% of the original.
Therefore, manual adaptation of the table space containers can be replaced by the
following procedure by using the Backup Object Manager redirected restore
function:
1. Issue this Backup Object Manager query to determine the original fill rate of
the table space:
backom -c q_tdi -a DB2 source alias -t timestamp -m detailed

2. Calculate the table space scaling factor by using this formula:


scaling factor = original fill rate / new fill rate

For example:

Chapter 7. Tuning performance 117


scaling factor = 0.98 / 0.7 = 1.4

3. Issue this command to begin the Backup Object Manager redirected restore:
backom -c rr_db_type -a DB2 source alias,DB2 target alias -t timestamp ...
...-T SYSCATSPACE -s 1.4

After the redirected restore completes successfully, the SYSCATSPACE table


space on the target side is increased by 40% during table space container
redefinition. The new overall fill rate of the SYSCATSPACE in the target
database is now 70%.

118 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 8. Troubleshooting
To assist with troubleshooting and problem determination, diagnostic files and
system information are displayed in a centralized location. Investigating the details
in log files helps to troubleshoot problems.

About this task

Investigate and compare the log files of the application and the Tivoli Storage
Manager server activity log to find out the differences between successful and
unsuccessful operations.
v tdpdb2.SID.nodename.log, db2diag.log.

Look for one of these patterns when a problem occurs:


v The problem always occurs at the same time. If this condition is true, view the
appropriate log files to determine if scheduled processes are occurring
simultaneously. Examples of such processes are virus checker, automatic
updates, or batch jobs.
v The problem always occurs after another operation is done or the same
operation is done.
v The problem occurs when another application or process is processed in parallel.

Data Protection for SAP for DB2 log files:


v tdpdb2.SID.nodename.log
v db2diag.log

Troubleshooting common problems


If a problem occurs inconsistently, try to determine what the difference is when the
problem occurs, if any.

About this task

Compare the log files of the application in question ((tdpdb2.SID.nodename.log,


db2diag.log, Tivoli Storage Manager server activity log, and so forth.) to find out
the differences between successful and unsuccessful operations. Look for one of
these patterns when the problem occurs:
v The problem always occurs at the same time. If this condition is true, view the
appropriate log files to determine whether there are any scheduled processes
that occur simultaneously. Examples of such processes are virus checker,
automatic updates, or batch jobs.
v The problem always occurs after another operation is done or the same
operation is done.
v The problem occurs when another application or process is processed in parallel.

© Copyright IBM Corp. 1995, 2014 119


Reproducing problems
Use the checklist to check what caused the problem, and then attempt to reproduce
the problem.

About this task

When you encounter a problem that occurs during an operation that previously
ran successfully, review this list to determine the root cause of the problem.
v The Data Protection for SAP for DB2 setup changed.
v One (or more) of the DB2, SAP, Tivoli Storage Manager, operating system,
network, or hardware components changed.
v Patches or updates to one (or more) of the components were applied.
v Changes occur that originate by the system:
– Check whether the disks are running full with the UNIX df command.
– If network performance decreases, check whether additional hosts, additional
applications, or defects in software or hardware occurred. Compare operation
runs in the Administration Assistant Performance Monitor history view or
compare the tdpdb2.SID.nodename.log.
– If Tivoli Storage Manager server processing decreases, check whether more
clients or more operations were added. Information is also available in the
Tivoli Storage Manager server activity log.

If none of these changes caused the problem, view the last modified time stamp of
the configuration files (vendor.env, initSID.utl, dsm.sys, dsm.opt,
/etc/services, /etc/inittab, ...).. This UNIX command lists all files in the
/etc directory, which are modified during the previous five days:
find /etc -type f -ctime 5 -print

If you are able to identify changes that are made to the system, roll them back one
at a time and try to reproduce the problem. This method frequently reveals which
change or set of changes caused the problem.

Internet Protocol version 6 (IPv6) support


Data Protection for SAP supports both IPv4 and IPv6 for internal communication.

Data Protection for SAP for DB2 supports both IPv4 and IPv6 for internal
communication in that it runs in IPv4, IPv6, and mixed environments on AIX and
Linux. However, these products do not use IPv6. In a mixed environment, the
communication depends on the adapter network settings. There is no option to
enforce the use of a specific protocol other than by network configuration.
Specifically, the ProLE or acsd service listens for both IPv4 and IPv6 connection
requests if the system is configured accordingly. Connection requests to ProLE are
made for the addresses that are returned by the system for the respective port on
the local host. Connection requests to other systems such as the Administration
Assistant are made for the addresses that are specified by the user. IPv6 addresses
are supported when TCP/IP addresses are specified in a command line or in a
profile parameter such as TCP_ADDRESS. However, when the IP address and port are
specified in the IPv4 address:service or port format, then the format must be
changed to service or port@<IP address> if the IP address is specified in the IPv6
notation. If a dotted decimal IPv4 address, the traditional format can still be used.

120 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
The specification of IPv6 addresses assumes that Data Protection for SAP is used in
an environment in which IPv6 is supported by all hardware and software
components.

Setup requirements
When you are troubleshooting issues while using Data Protection for SAP products
there are items that you can check to ensure that the setup completed correctly.

Review these considerations to better understand the installation setup on UNIX or


Linux systems:
v Make sure an entry similar to this example is defined in the /etc/inittab file:
pd64:2:respawn:/usr/tivoli/tsm/tdp_r3/db264/prole -p tdpr3db264
Server component hostname 5126

pd64:2:respawn:/usr/tivoli/tsm/tdp_r3/db264/prole
-p tdpr3db264 Server component hostname 5126

The <Server component hostname> specifies the name or IP address of the host
on which the Administration Assistant Server component is running. 5126 is the
default port to which the Server component listens. These Server arguments are
only needed when you use the Administration Assistant.
The purpose of this entry is to start a daemon process for ProLE. This process
listens on the Data Protection for SAP for DB2 port tdpr3db264 for connections
with the shared library for DB2 (tdpr3db264) connections with the shared library
and sends performance-related information to the Administration Assistant
Server component. The port can have a different name; however, the name must
match the name in the /etc/services file as shown in this example:
tdpr3db264 57324/tcp

The lines are added to the /etc/services file during the installation process.

Review these considerations to better understand the installation setup on


Windows systems:
v Make sure that all files are installed.
v Verify that service ProLE Service is running and set to automatic startup. If this
service is not running, Data Protection for SAP does not function properly.
v The installer adds lines to the %SYSTEMROOT%\system32\drivers\etc\services file
similar to the example:
(Data Protection for SAP for DB2)
tdpr3db264 57324/tcp

The example shows the Data Protection for SAP 64-bit port.
v Make sure the Data Protection for SAP configuration file initSID.utl is in the
directory pointed to by the TDP_DIR environment variable.
v Make sure the Data Protection for SAP configuration file initSID.utl is and in
the directory pointed to by the TDP_DIR environment variable (on DB2).
v The vendor environment file vendor.env must contain the fully qualified path
and file name of the initSID.utl file for Data Protection for SAP for DB2.

Chapter 8. Troubleshooting 121


v The vendor environment file vendor.env is to contain the path of the location
where the Data Protection for SAP for DB2 runs logs that are written. If this
location is not specified, a temporary directory of the system is used.
v The names of the Tivoli Storage Manager servers that are specified in
initSID.utl must match the names in the dsm.sys file. If the Tivoli Storage
Manager API or Tivoli Storage Manager backup archive client are installed into
their default locations, then it is not necessary to set the DSMI_* variables. If the
variables are set, however, make sure that they specify the correct directories
and files. The user ID that runs the backups must have the correct permissions
to access all of files and directories that are specified by these variables.

Figure 34. SAP and Data Protection for SAP for DB2 configuration files on UNIX or Linux

On UNIX or Linux systems, the names of the Tivoli Storage Manager servers that
are specified in initSID.utl must match the names in the dsm.sys file. If the Tivoli
Storage Manager API or Tivoli Storage Manager backup archive client are installed
into their default locations, then it is not necessary to set the DSMI_* variables. If
the variables are set, however, make sure that they specify the correct directories
and files. The user ID that runs the backups must have the correct permissions to
access all of files and directories that are specified by these variables. Also, verify
that write permissions exist for the initSID.bki file as this file is the only one to
which Data Protection for SAP writes persistent information.

On Windows systems, the dsm.opt file is used instead of the dsm.sys file. However,
the content of this file is not relevant to Data Protection for SAP. The directory that
contains the dsm.opt file must also contain a server.opt file for each server that is
specified in the initSID.utl file. The environment variable DSMI_CONFIG must
specify an option file within this directory. DSMI_CONFIG is to specify the dsm.opt
file in this directory. The DSMI_DIR environment variable must also specify the
directory where the Tivoli Storage Manager API message text file is in. This
example shows a typical the c:\Program Files\Tivoli\tsm\api64 directory.

122 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Information to collect for support
When you contact support, you must be able to provide the following information.
v The Data Protection for SAP for DB2 version level.
v The operating system level and patches that were applied.
v The DB2 version level.
v The Tivoli Storage Manager server version.
v The Tivoli Storage Manager server operating system level.
v Data Protection for SAP configuration file (vendor.env, initSID.utl) including
Tivoli Storage Manager client configuration files (dsm.sys, dsm.opt)
v Data Protection for SAP profile (initSID.utl)
v The change history of the system components (if the process worked
previously).
More information might also be requested from the service representative.

Troubleshooting Data Protection for SAP for DB2 problems


Information about how to resolve errors that might occur during Data Protection
for SAP for DB2 operations is provided.

About this task

The following figure helps to isolate problems that occur when you back up or
restore your DB2 database.

Chapter 8. Troubleshooting 123


Figure 35. General problem isolation

After installation is completed (Step 1.1) and manual password handling is


specified, set the password (Step 1.2). When the operation completes successfully,
the informational messages BKI0051I: Password successfully verified for node
NODENAME on server SERVERNAME and BKI0024I: Return code is: 0. display for
each server that is configured within the initSID.utl file. An error message
displays when a problem occurred. The Administration Assistant can also be used.
The Configurator feature loads the configuration of the node on which problems
are encountered and allows the Administration Assistant to check the
configuration.

These errors are frequently encountered at Step 1.2:


BKI2001E: Socket error while connecting to ProLE at IP-Address:PORT:
Connection refused
On Windows, verify that the ProLE Service is running by viewing the
Computer Management Services screen or issue this command:
net start

A list of all running services displays. On UNIX or Linux, verify that the
background daemon is running by issuing this command:
ps -ef | grep prole

124 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Check the entry in /etc/services (UNIX or Linux) and
%SYSTEMROOT%\system32\drivers\etc\services (Windows). Compare the
port number from the error message with the port number within
/etc/services. Also, check the entry in /etc/inittab (UNIX or Linux). If
another port was set by using the option -pPORT, check this port as well.
If all of this effort does not help, start the ProLE from another shell on
UNIX or Linux with this command:
prole -p PORT

Issue this command on Windows:


prole -console -p PORT

Attempt to start backom again.


BKI5001E: Tivoli Storage Manager Error: Server not found in configuration
file On UNIX or Linux, the Tivoli Storage Manager server that is defined in the
initSID.utl file does not match the server that is specified in the dsm.sys
file. On Windows, the server.opt file might be missing.
BKI5001E: Tivoli Storage Manager Error: ANS1353E (RC53) Session rejected:
Unknown or incorrect ID entered
This message can display when the node in the server stanza of the UTL
file is not valid on the server.
HANG If backom hangs after the password is entered, the server IP address that is
specified in the UNIX or Linux dsm.sys file might be incorrect.

When Step 1.2 (setting the password) is successful, proceed to Step 1.3 and do a
backup by using the DB2 backup command. Verify that the settings are correct. If
the backup was successful, a message from DB2 is displayed:
Backup successful. The timestamp for this backup image is: timestamp

If an error message displays, find the message and information about how to
resolve the error.

When an error occurs, always view the Data Protection for SAP run log
tdpdb2.SID.nodename.log first. This log file is in the directory that is specified by
the TDP_DIR environment variable. If the variable is not specified, the log file is in
the system temporary directory. If the tdpdb2.SID.nodename.log file does not exist
(Step 2.2), then two cases are possible. The first case is that DB2 was unable to load
the shared library that contains the DB2 connector for Data Protection for SAP. The
second case is that an error was encountered before the Data Protection for SAP
library was called. In both cases, a DB2 error message is displayed on the
command line. It begins with the SQL prefix and is also written in the DB2
diagnostic log db2diag.log (Step 4.3). DB2 provides detailed error descriptions by
issuing this command:
db2 ? SQLnumber

Replacenumber with the appropriate message number. Try to resolve this problem
by using the DB2 documentation.

Chapter 8. Troubleshooting 125


If the tdpdb2.SID.nodename.log file exists, search for a message beginning with
BKIXXXXY where XXXX is a four-digit number, and Y is the letter I, W, or E. When
such a message occurs, the DB2 connector for Data Protection for SAP that loaded
correctly is called by DB2. In Step 3.1, the tdpdb2.SID.nodename.log file is created
and an error message that starts with BKI is recorded.

Location of log files


Text that is displayed on the screen during DB2 backup, DB2 restore, and BackOM
operations are typically written to log files.

DB2 also writes messages of internal operations, events, or status in the


administration notification log file (db2SID.nfy) and diagnostic log file
(db2diag.log). These log files are in the directory that is specified with the DB2
database management configuration parameter DIAGPATH. Query the DB2 database
management configuration with this command:
db2 get dbm cfg

Log files that contain information and messages


Data Protection for SAP processes are recorded in log files. Information about
backup operations can be used to determine which backup should be used to
restore your data.

The backint.log log file contains the Tivoli Storage Manager for ERP data for all
database and redo log file backup and restore operations that complete successfully
or fail.

These files are in the path indicated by the TDP_DIR environment variable. After
the installation, TDP_DIR points to the subdirectory tdplog of the path for the
Data Protection for SAP configuration files. If TDP_DIR is not set, or if a log file
cannot be created in the path pointed to by TDP_DIR, the log files are created in
path /tmp (UNIX or Linux) or in the path pointed to by environment variable
TEMP (Windows).

The Data Protection for SAP shared library writes to the tdpdb2.SID.<node
name>.log log file.

The Backup Object Manager writes to the backom.log log file.

These files are in the following paths:


v UNIX or Linux: $SAPDATA_HOME/sapbackup for backup and restore runs
v UNIX or Linux: $SAPDATA_HOME/saparch for redo log archive runs
Windows:
v %SAPDATA_HOME%\sapbackup for backup and restore runs
v %SAPDATA_HOME%\saparch for redo log archive runs
All log files that are written during a backup, restore, or archive operation are
listed in summary log files with start and end time stamps. The summary log files
are in the same directory as the log files themselves and have the following names:
v backSID.log
v restSID.log
v archSID.log

126 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
DB2 vendor reason codes
Data Protection for SAP for DB2 uses these reason codes, which might also be
displayed or logged by DB2 in the case of problems.
Table 7. DB2 vendor reason codes
Reason code Explanation User response
1 The library that is specified could Check the DB2 diagnostic log for
not be loaded. further details.
2 Communication error between Check the Data Protection for SAP
shared library and ProLE run log file
tdpdb2.SID.nodename.log for
further details.
6 Object that is specified cannot be There is no backup image on Tivoli
found on Tivoli Storage Manager. Storage Manager matching the
search criteria.
10 Invalid options that are specified Check the options string that is
with the options parameter of the specified and check the Data
DB2 backup/restore command. Protection for SAP run log file
tdpdb2.SID.nodename.log for
further details.
11 Initialization procedure for shared Check the Data Protection for SAP
library failed. run log file
tdpdb2.SID.nodename.log and the
DB2 diagnostic log file for further
details.
17 During end processing of either Check the Data Protection for SAP
backup/archive or restore/retrieve run log file
session or sessions, an error tdpdb2.SID.nodename.log for
occurred. further details.
18 An error occurred during reading Check the Data Protection for SAP
or writing data from or to Tivoli run log file
Storage Manager. tdpdb2.SID.nodename.log for
further details.
26 An error occurred during deleting Check the Data Protection for SAP
data from Tivoli Storage Manager. run log file
tdpdb2.SID.nodename.log for
further details.
29 A terminate request from DB2 Check the Data Protection for SAP
could not be handled correctly. run log file
tdpdb2.SID.nodename.log and the
DB2 diagnostic log file for further
details.
30 A severe error occurred. Check the DB2 diagnostic log file
for further details.

Chapter 8. Troubleshooting 127


128 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Chapter 9. Reference information
Data Protection for SAP reference information such as versioning and profile
information is provided.

Version numbers
When Tivoli Storage Manager for ERP backup version control is active, version
information is stored on the Tivoli Storage Manager Server.

When Tivoli Storage Manager for ERP backup versions is defined by the
MAX_VERSIONS keyword, version information is stored on the Tivoli Storage
Manager Server. The version number is increased only after successful backups.

Backups and restores in partitioned database environments


DB2 provides the Single System View (SSV) function, which allows the backup of
all partitions to be triggered with a new dedicated DB2 backup command option
ON ALL DBPARTITIONNUMS. Furthermore, partitioned database backups and
restores can be made by using the already established DB2 framework for
partitioned databases called db2_all.

Partitioned database backups and restores can be made by using the already
established DB2 framework for partitioned databases called db2_all. A requirement
of DB2 is to back up and restore the catalog partition separately from all other DB2
partitions. Thus, backup and restore operations of a partitioned database are
two-step scenarios, whereby the first step is to backup/restore the catalog partition
and the second step to back up and restore all other partitions in parallel. For more
information about DB2 backup operations, see “Use DB2 single system view for
backup” on page 69.

Data Protection for SAP uses the DB2 command db2_all for separation and
parallelization of the backup and restore commands. The db2_all command
provides special characters for handling partitions and for running commands in
parallel or sequentially. The DB2 Administration Guide contains further
information.

The DB2 db2_all command supports the following special characters or character
combinations:
v <<+N< Runs a command only on partition N
v <<-N< Runs a command on all partitions except on partition N
v " Substitute occurrences of () by the machine index and substitute
occurrences of ## by the partition number
v ; Runs the commands in parallel in the background and finishes the
command after all remote commands are completed.
By using these characters, each partition of the database can be backed up or
restored with its special adapted environment.

This list presents possible partitioned database backups and restores with Data
Protection for SAP for DB2:

© Copyright IBM Corp. 1995, 2014 129


Full offline backup
Full offline backup of all database partitions with two sessions, starting
with the catalog partition (shown as partition 0) followed by all other
partitions in parallel:
db2_all ’<<+0< db2 backup db SID load shared library open 2 sessions’
db2_all ’<<-0<; db2 backup db SID load shared library open 2 sessions’

Full restore of latest backup


Full restore of latest backup starting with the catalog partition (shown as
partition 0) followed by all other partitions (shown with three partitions) in
parallel using different number of sessions for some of the partitions.
Before you start restoring, a temporary environment script (this example
uses /db2/SID/EEEenv.sh) must be created. The /db2/SID directory must be
an NFS share between all hosts where the partitions are located.
export SESSION0=2
export SESSION1=2
export SESSION2=4
export SESSION3=4

Partitions 0 and 1 are restored with two sessions, and partitions 2 and 3 is
restored with four sessions. As a result, the following restore command
must be used:
db2_all ’<<+0<" ./db2/SID/EEEenv.sh; db2 restore db SID load shared library open
$SESSION##’
db2_all ’<<-0<" ./db2/SID/EEEenv.sh; db2 restore db SID load shared library open
$SESSION##’

The string '$SESSION##' in the db2_all command is replaced while


running it with the value provided by the environment variables
SESSION0 to SESSION3.
Full online backup
Full online backup of all database partitions, starting with the catalog
partition (shown as partition 1) followed by all other partitions in parallel
using different Data Protection for SAP profiles for each partition. To
support this scenario, one Data Protection for SAP profile (initSID.utl)
must be created and maintained for each partition. Each profile can have
different settings for the Tivoli Storage Manager node and management
class. The following profiles are needed for this example:
v initSID.utl.1 (profile for partition 1)
v initSID.utl.2 (profile for partition 2)
v initSID.utl.3 (profile for partition 3)
v initSID.utl.4 (profile for partition 4)
In addition, a Data Protection for SAP vendor environment file
(vendor.env) must be created and maintained for each partition. Each
vendor environment file has an XINT_PROFILE entry that refers to the
corresponding Data Protection for SAP profile. For example:
vendor.env.1 (environment for partition 1 ->
XINT_PROFILE=/db2/SID/vendor.env.1)
vendor.env.2 (environment for partition 2 ->
XINT_PROFILE=/db2/SID/vendor.env.2)
vendor.env.3 (environment for partition 3 ->
XINT_PROFILE=/db2/SID/vendor.env.3)

130 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
vendor.env.4 (environment for partition 4 ->
XINT_PROFILE=/db2/SID/vendor.env.4)

As a result, the following backup command must be used:


db2_all ’<<+1<" db2 backup db SID online load shared library options
/db2/SID/vendor.env.##’
db2_all ’<<-1<;" db2 backup db SID online load shared library options
/db2/SID/vendor.env.##’

The string vendor.env.## in the db2_all command is replaced while


running it with the values vendor.env.1 - vendor.env.4, whereby the
special characters '##' is substituted by the corresponding partition number.

Backup Object Manager


The Backup Object Manager manages DB2 log files that are archived with Data
Protection for SAP, BR*Tools BRARCHIVE, and files that are archived with Data
Protection for SAP and the DB2 Log Manager.

The following shows the Backup Object Manager syntax:

backom [ -? ] displays the syntax help.

Note: For the C shell, enclose the option string in single quotation marks (backom
’-?’).

backom -h [password|query|backup|restore|delete] displays the command online


help.
backom -c command [ command option ...]

Where ’command’ is one of the following choices:

Select for Password: password

Select for Query: q_all | q_db | q_ts | q_log | q_tdi | q_raw

Select for Backup: b_db

Select for Restore: r_db | r_ts | r_log | r_hfile | r_raw | r_tdi |


rr_db_interactive | rr_db_batch | rr_db_clone

Select for Delete: d_db | d_ts | d_log | d_raw

Where ’command option’ is one of the following choices:


-i instance
-a alias name
-n node number
-u userid
-p password -t timestamp | timerange
-l log number | log number range
-k log chain | log chain range
-f file name
-d destination directory
-e execution profile
-b buffer size

Chapter 9. Reference information 131


-s scaling factor
-N
-S sessions
-B number of buffers
-P parallelism
-D target database
-T tablespace
-R full | incremental | delta
-O
-L
-C
-x
-v
-m output mode

Backup Object Manager commands

There are six types of Backup Object Manager commands:


v Password command
v Query commands
v Backup command
v Restore commands
v Delete commands
Optional command options are listed in brackets [ ], parameter descriptions, that
must be replaced, are listed in angle brackets < >.

Backup Object Manager command options


Use the following options together with Backup Object Manager commands.
v -a database alias or -a original database alias,target database alias.
Denotes the name of the database for which an operation is requested. For a
redirected restore to a different database or of database cloning, the database
aliases of both the original and the target databases must be specified and
separated by a comma. When a redirected restore is requested that specifies a
single database alias, the database is restored to the original database.
v -b buffer size Denotes the size of DB2 backup or restore buffers, in 4-KB
allocation units (pages). The minimum is eight units. The buffer size is limited
by the memory available.
v -B number of buffers Denotes the number of DB2 buffers to be used for backup
or restore. The minimum number is 2. The number of buffers is limited by the
available memory.
v -C If specified for a redirected restore, this option indicates that the Backup
Object Manager is to run only a test of the setup but not start copying data.
v -d destination directory Denotes the destination path for restoring a file to
the file system.
v -D target database directory For a redirected restore, this option denotes the
fully qualified name of the target database directory. This command option is
ignored when the database alias of the target database is the same as the
database alias of the original database.
v -e execution profile Denotes the complete path of the Tivoli Storage Manager
for ERP for DB2 profile to be used with the Backup Object Manager. This option
overrides the profile name that is set in the XINT_PROFILE environment variable.

132 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v -f file name Denotes the name of a file in the file system. Unless the file
denotes a TDI image, the following wildcard characters are accepted: ???
denotes any single character. * denotes any number of any characters.
v -i DB2 instance Used in query commands to limit the database or table space
data to be displayed to a specific DB2 instance. With all other commands, this
command option is used to override the DB2 instance name that is defined in
the DB_INSTANCE environment variable.
v -k log chain | log chain range where log chain range = chain1 - chain2.
Denotes the log chain number or numbers of DB2 log file or files. DB2 log
chains can be specified either in the format Cnnnnnnn, where nnnnnnn is a
string of seven decimal digits or in the format mmmmmmm, where mmmmmmm
is a string of up to seven decimal digits that denote the log chain number.
v -l log number | log number range where log number range = log number 1 -
log number 2 Denotes the log serial numbers of DB2 log files. DB2 log numbers
can be specified either in the format Snnnnnnn.log (DB2 log file name), where
nnnnnnn is a string of seven decimal digits, or in the format mmmmmmm, where
mmmmmmm is a string of up to seven decimal digits that denote the log serial
number.
v -L If specified for a database backup, the DB2 log files are saved to Tivoli
Storage Manager with the database backup.
v -m output mode where output mode = short | normal | detailed denotes the
detail of information that is requested with a query command. The default is
“short” for information that is related to DB2 log files, “normal” for all other
kinds of information.
If you must override the default values generally, you might set environment
variables FULL_OUTPUT (for information about database backups),
TABLESPACE_OUTPUT (for information about table space backups) and LOG_OUTPUT
(for information about DB2 log file backups) to the values wanted.
v -N If specified, this command option causes all containers of a table space to be
allocated with the same size during a redirected restore.
v -n node number Denotes the DB2 node number. For the password command in a
DB2 partitioned environment: If for only one DB2 node/partition the password
must be set/changed, specify the command option -n node number. If the
node/partition number is not specified, the new password is saved to all
available node/partitioned based Data Protection for SAP configuration files. For
all other commands: If the node number is not specified, node NODE0000 is
assumed.
v -O If specified when you request a backup or table space restore operation, an
online backup or an online table space restore is run.
v -p password The password of the user ID specified in option -u.
v -P parallelism Denotes the degree of parallelism within DB2, which is the
number of buffer manipulator processes reading from or writing to table spaces
at the same time. The minimum parallelism is 1. The maximum is 1024.
v -R backup type where backup type = full | incremental | delta . Denotes
the type of backup requested. If no backup type is specified, a full backup is
done.
v -S sessionsDenotes the number of I/O sessions that are to be started by DB2.
The value of this command option must be less than or equal to the value of the
keyword MAX_SESSIONS in the Data Protection for SAP profile.
v -s scaling factor Denotes the positive floating point factor to be used for
resizing all containers of a table space during redirected restore. The default is 1,
indicating that the new table space is exactly the size of the original.

Chapter 9. Reference information 133


v -t timestamp | time range where time range = timestamp1-timestamp2
Denotes the time when a backup object was created. For database and table
space backups, this time stamp matches the time stamp that is listed in the DB2
Recovery History File. It consists of 14 decimal digits and has the format:
yyyymmddhhmmss where yyyy is the year; mm is the month of the year, 01 - 12;
dd is the day of the month, 01 - 31; hh is the hour of the day, 00 - 23; mm is the
minute of the hour, 00 - 59; ss is the second of the minute, 00 - 59. For restore
commands, an exact time stamp must be given. For query and delete
commands, a time range can be specified, or the time stamp can contain
wildcard characters. The following wildcard characters are accepted:
– ? denotes any single digit
– * denotes any number of any digits.
If a time stamp is not specified for a query, the result contains all eligible backup
object available on the Tivoli Storage Manager server. If a time stamp is not
specified for a restore, the newest object is retrieved from Tivoli Storage
Manager.
v -T tablespace list where tablespace list = tablespace[,tablespace list]
For a backup request, denotes the names of the table space or spaces to be
backed up. Table space names are separated by commas. If there is no table
space list that is specified, a full database backup is done.
v -u userid Denotes the DB2 user ID used for backing up or restoring a DB2
database, table space, or recovery history file if it is different from the current
login user ID.
v -v If set, all log messages are displayed on STDOUT.
v -x If specified, this option suppresses all confirmation requests. Otherwise,
confirmation requests are sought for restore commands that would overwrite
existing data, and for delete requests.
With the -c password option, -x causes the password to be changed on all
database partitions.

Backup command
Use the Backup Object Manager backup command, to back up a complete database
or selected table spaces of a database.

For more information about command options, see “Backup Object Manager
command options” on page 132.
v Back up the database data with these command options:backom -c b_db -a
database alias [-T tablespace list][-R backup type][-i instance] [-n node
number] [-u userid][-p password] [-b buffer size][-B number of buffers]
[-S sessions][-P parallelism] [-e execution profile] [-O] [-L] [-v]

Delete command
Use the Backup Object Manager delete commands to remove backup objects from
Tivoli Storage Manager that were sent by Data protection for DB2.

For information about the command options, see“Backup Object Manager


command options” on page 132.
v Delete the database backup or backups that are specified by the command
options from Tivoli Storage Manager: backom -c d_db -a database alias -t
timestamp | time range[-i instance] [-n node number] [-e execution
profile] [-x] [-v]

134 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
v Delete the table space backup or backups that are specified by the command
options from Tivoli Storage Manager: backom -c d_ts -a database alias -t
timestamp|time range [-i instance] [-n node number] [-e execution
profile] [-x] [-v]
v Delete the DB2 log file backup or backups that are specified by the command
options from Tivoli Storage Manager: backom -c d_log -a database alias -l
log number|log number range[-n node number] [-t timestamp|time range] [-e
execution profile][-x] [-v]
v Delete the file or files that are specified by the -f command option from Tivoli
Storage Manager:backom -c d_raw -f file name [ -e execution profile] [-x]
[-v]

Password command
The password command connects to the backup server, prompts for a new
password, and verifies the password that is entered with the backup server. If the
verification is successful, the new password is encrypted and stored in the Data
Protection for SAP for DB2 configuration file.

Successful password verification requires that the password entered must be the
active password for the corresponding node on the Tivoli Storage Manager server.
Issue this command to verify and save a Tivoli Storage Manager password:
backom -c password [-x] [-a DB2 alias name] [-n DB2 node number]
[-e execution profile]

Information about when to use the password command is provided in


“Determining the Tivoli Storage Manager password method” on page 61.

Query command
Use the query command to list backup objects that were sent to Tivoli Storage
Manager by Data Protection for DB2.

The objects that are displayed can be filtered with command options. For more
information about command options, see “Backup Object Manager command
options” on page 132.
v List all backup objects that are related to DB2 (database or table space backups
and DB2 log file backups):backom -c q_all [-i instance] [-a database
alias] [-n node number] [-t timestamp | time range] [-l log number | log
number range][-e execution profile] [-m output mode] [-v]
v List database backups:backom -c q_db [-i instance] [-a database alias] [-n
node number] [-t timestamp | time range] [-e execution profile] [-m
output mode] [-v]
v
v List table space backups:backom -c q_ts [-i instance] [-a database alias]
[-n node number] [-t timestamp | time range] [-e execution profile] [-m
output mode] [-v]
v List table space definition information (TDI) images that are related to a full DB2
database backup:backom -c q_tdi -a database alias -t timestamp [-i
instance][-n node number] [-e execution profile] [-m output mode] [-v]

Chapter 9. Reference information 135


v List DB2 log file backups: backom -c q_log [-a database alias] [-n node
number] [-t timestamp | time range] [-l log number | log number range]
[-e execution profile] [-m output mode] [-v]
v List backup objects available on Tivoli Storage Manager (database or table space
backups, DB2 log file backups, and file backups): backom -c q_raw [-f file
name] [-e execution profile][-m output mode] [-v]

Restore commands
Use the restore commands to restore any backup object that was created by Data
Protection for DB2.
v Restore the database with these command options:backom -c r_db -a database
alias [-n node number] [-u userid][-p password] [-t timestamp] [-b buffer
size] [-B number of buffers] [-S sessions] [-P parallelism] [-R restore
type] [-O][-e execution profile] [-x] [-v]
v Restore the database with these command options to a different location
(redirected restore) in automatic mode: backom -c rr_db_clone -a original
database alias,target database alias [-i instance] [-n node number] [-u
userid] [-p password][-t timestamp] [-b buffer size] [-B number of
buffers] [-S sessions] [-P parallelism][-D target database directory][-e
execution profile] [-s scaling factor] [-N] [-C] [-v]
v Restore the database with these command options to a different location
(redirected restore) in batch mode:backom -c rr_db_batch -a original database
alias,target database alias -f TDI image [-i instance] [-n node number]
[-u userid][-p password] [-t timestamp][-b buffer size][-B number of
buffers] [-S sessions] [-P parallelism][-D target database directory][-e
execution profile][-s scaling factor] [-N][-C] [-v]
v Restore the database with these command options to a different location
(redirected restore) in interactive mode:backom -c rr_db_interactive -a
original database alias,target database alias [-i instance] [-n node
number] [-u userid] [-p password ][-t timestamp] [-f modified TDI image]
[-b buffer size][-B number of buffers] [-S sessions][-P parallelism][-D
target database] [-e execution profile] [-s scaling factor][-N][-C] [-v]
v Restore the table spaces with these command options: backom -c r_ts -a
database alias [-n node number] [-u userid][-p password] [ -t timestamp]
[-b buffer size] [-B number of buffers] [-S sessions] [-P parallelism]
[-R restore type ] [-O][-e execution profile] [-x] [-v]
v Restore the DB2 Recovery History File of the database with these command
options: backom -c r_hfile -a database alias [-n node number][-t
timestamp] [-u userid] [-p password] [-b buffer size][-B number of
buffers] [-S sessions] [-P parallelism][-e execution profile] [-x] [-v]
v Restore the table space definition information (TDI) denoted by the command
options: backom -c r_tdi -t timestamp -a database alias [-d destination
directory] [-e execution profile] [-x] [-v]
v Retrieve the DB2 log files with these command options: backom -c r_log -a
database alias -l log number|log number range -d destination directory
[-n node number] [-t timestamp|time range] [-e execution profile] [-x]
[-v]
v Retrieve the file or files that are specified by the -f command option to the path
specified by command option -d:
backom -c r_raw -f file name-d destination directory [-e execution
profile] [-x] [-v]
This command can restore data to the destination directory. If a single segment

136 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
was used during the backup, the data can be restored to DB2 from the
destination directory after retrieval. If two or more segments were used during
the backup, the data can be restored to the destination directory but cannot be
restored to DB2.

BACKOM command examples


Commands for certain tasks such as verifying and saving a Tivoli Storage Manager
password are shown in the following examples.
v Use the following command to verify and save a Tivoli Storage Manager
password:
backom -c password

v Use the following command to create a list of all available backup objects sent to
Tivoli Storage Manager by Tivoli Storage Manager for ERP for DB2:
backom -c q_all

v Use the following command to create a list of all DB2 log files for the SAMPLE
database. The log number is greater than 123 and it is created in November 2002
with normal output detail level:
backom -c q_log -a SAMPLE -l 124-9999999 -t 200211* -m normal
backom -c q_log -a SAMPLE -l S0000124.log-S9999999.log -t 200211* -m normal

v Use the following command to create a list of DB2 log files for log chains 5 - 15
for the SAMPLE database. The log numbers range is 98 - 180 and it is archived
from 4 p.m. to 8.30 p.m.:
backom -c q_log -a SAMPLE -k C0000005-C0000015 -l 98-180 -t ????????16*-????????2030*

v Use the following command to create a list of all table space backups. The list is
for partition NODE0001, in the SAMPLE database SAMPLE, and for the backups
that were created in November 2002 from 4 p.m. to 5 p.m.:
backom -c q_ts -a SAMPLE -n NODE0001 -t 200211??16*

v Use the following command to backup online database SAMPLE by using two
I/O sessions and four backup buffers:
backom -c b_db -a SAMPLE -S 2 -B 4 -O

v Use the following command to backup the table spaces SYSCATSPACE and
USERSPACE1 of database SAMPLE, by using the execution profile
initSAMPLE.utl at /db2/SAMPLE/config:
backom -c b_db -a SAMPLE -T SYSCATSPACE,USERSPACE1 -e /db2/SAMPLE/config/initSAMPLE.utl

v Use the following command to restore a table space of database SAMPLE with
the table space backup created on November 27, 2002, at 6:32:15 p.m.:
backom -c r_ts -a SAMPLE -t 20021127183215

v Use the following command to restore database SAMPLE with the latest backup:
backom -c r_db -a SAMPLE

Chapter 9. Reference information 137


v Use the following command to delete all DB2 log files for database SAMPLE
that were created before June 2002:
backom -c d_log -a SAMPLE -t 1900*-20020601000000

v Use the following command to delete all versions of files that contain “tmp” in
their path or file names that were sent to Tivoli Storage Manager by Tivoli
Storage Manager for ERP:
backom -c d_raw -f *tmp*

Crontab example
UNIX or Linux cron jobs can be scheduled with the crontab command. This
command starts an editing session that creates a crontab file. The cron jobs and the
appropriate times are defined within the crontab file.

The file can be customized with this command:


crontab -e

In this example, a cron job starts the shell script backup.ksh at 11:30 p.m. Monday
through Friday and uses DB2 backup to back up the SAP database. This example
shows the entry in the crontab file that starts the script for this scenario:
30 23 * * 1,2,3,4,5 /usr/bin/su - db2c21 -c "/db2/C21/sapscripts/backup.ksh"

Crontab file sample


The following sample output, shows the root crontab jobs.
# ---------------------------------------------------------------------------
# crontab.sample:
# Sample crontab file to be included in the root crontab jobs.
# ---------------------------------------------------------------------------
# Task:
# Submits backup/archive commands at regularly scheduled intervals
# using two simple shell scripts containing backup/archive commands
# and TSM commands.
# ---------------------------------------------------------------------------
# ***** NOTE ***** NOTE ***** NOTE *****
#
# This file is intended only as a model and should be
# carefully tailored to the needs of the specific site.
#
# ***** NOTE ***** NOTE ***** NOTE *****
# ---------------------------------------------------------------------------
#
# Remarks on the crontab file format:
#
# Each crontab file entry consists of a line with six fields, separated
# by spaces and tabs, that contain, respectively:
# o The minute (0 through 59)
# o The hour (0 through 23)
# o The day of the month (1 through 31)
# o The month of the year (1 through 12)
# o The day of the week (0 through 6 for Sunday through Saturday)
# o The shell command
# Each of these fields can contain the following:
# o A number in the specified range

138 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
# o Two numbers separated by a dash to indicate an inclusive range
# o A list of numbers separated by commas
# o An * (asterisk); meaning all allowed values
#
# ---------------------------------------------------------------------------
#
# For the following examples, the system id (alias) of the DB2 database
# is assumed to be ’C21’ and the username ’db2c21’.
#
# ---------------------------------------------------------------------------
# Full database backup, scheduled every Friday at 8:00 p.m.
#
0 20 * * 5
# /usr/bin/su - db2c21 -c "/db2/C21/sqllib/scripts/backup.ksh"
#
# ---------------------------------------------------------------------------
# Save redo logs, scheduled twice a day at 11:30 a.m. and at 5:30 p.m.
# Monday through Friday
#
30 11,17 * * 1,2,3,4,5
/usr/bin/su - db2c21 -c "/db2/C21/sqllib/scripts/archive.ksh"

Data Protection for SAP profile


The Data Protection for SAP for DB2 profile provides keyword parameters that
customize how Data Protection for SAP operates. A sample profile initSID.utl is
provided on the product media.

During installation on Windows systems, the sample profile (along with all other
files) is placed in the C:\Program Files\Tivoli\TDP4SAP directory.

The profile is copied to the profile path during installation if no other profile exists
there. Data Protection for SAP reads the profile pointed to by environment variable
XINT_PROFILE (shared library, BackOM) or sent as a parameter (BackOM)
immediately before a backup or restore operation.

These rules apply to the keyword syntax:


v Each line is analyzed separately.
v Keywords can start in any column of the line.
v Keywords must not be preceded by any string, except blanks.
v If a keyword is encountered several times, the last one is used.
v File processing ends when the END keyword is encountered or the end of file is
reached.
v The comment symbol is the number sign (#). Scanning of the current line stops
when the comment symbol is encountered. No comment is allowed between the
keyword and the value or values. For example:
#BRARCHIVEMGTCLASS MLOG1 <-- correct
BRARCHIVEMGTCLASS MLOG1 # <-- correct
BRARCHIVEMGTCLASS # MLOG1 <-- incorrect
v Although some keywords are required, most are optional. Each of the optional
keywords has a preset default value.

Chapter 9. Reference information 139


Profile parameter descriptions
The default value is underlined in these descriptions and applies if the parameter
is not specified.
ADSMNODE node_name
Specifies a node_name that is registered to the Tivoli Storage Manager
server as a Tivoli Storage Manager node. This parameter must be defined
with the respective SERVER statement, as shown in the sample profile. You
can assign a different node name to your database system with this option.
It is used if you have several SAP for DB2 database systems in your
network with the same name, for example, SID, and they all use the same
Tivoli Storage Manager server. This keyword must not be set when
automated password handling is selected. It is to be set for manual
password-handling.
BACKEND pgmname [parameterlist]
Specifies a program pgmname that is called by IBM Tivoli Storage Manager
for Enterprise Resource Planning for DB2 after the backup function
completed and before program control is returned to DB2. If pgmname is
not a fully qualified path, the default search path is used to locate the
program. If not specified, no backend processing is finished.
Example for UNIX or Linux:
BACKEND write operator@remotesite Backup of SAP database object completed.

This process sends a message to a remote user when the backup is


finished.
BACKUPIDPREFIX 6-charstring | SAP___
Specifies a six-character prefix that is used to create a backup identifier for
each archived object. If not specified, the default value is SAP___.All
partitions of a partitioned DB2 database have the same BACKUPIDPREFIX.
BRARCHIVEMGTCLASS management_class [management_class...]
Specifies the Tivoli Storage Manager management classes that Tivoli
Storage Manager for ERP uses to back up offline DB2 log files. Each
parameter string can consist of up to 30 characters. Specify a separate
BRARCHIVEMGTCLASS for each log file copy requested. As a result, make sure
the number of different BRARCHIVE management classes that are
specified must be greater than or equal to the number of log file copies.
This parameter must be defined with the respective SERVER statement, as
shown in the sample profile.
To use different Tivoli Storage Manager servers for backup and archive
data, the value “:SKIP:” can be used to define a server stanza with no
archive management classes. This value is allowed for the parameter
BRARCHIVEMGTCLASS only.
BRBACKUPMGTCLASS management_class [management_class...]
Specifies the Tivoli Storage Manager management classes Tivoli Storage
Manager for ERP uses to back up the DB2 database. The parameter string
can consist of up to 30 characters. This parameter must be defined with the
respective SERVER statement, as shown in the sample profile.
BUFFCOPY SIMPLE|PREVENT|AUTO
This optional parameter controls how Tivoli Storage Manager for ERP uses
the internal buffers for transferring data during a backup. If set to SIMPLE,
data buffers are copied when they are sent between Tivoli Storage Manager
components. This option is the default. If set to PREVENT, the original data

140 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
buffers are sent between Tivoli Storage Manager components. For this
mode, BUFFSIZE is restricted to a maximum of 896 KB. Furthermore, it
cannot be selected when the Tivoli Storage Manager client encryption or
client compression features are activated. If set to AUTO, Tivoli Storage
Manager for ERP runs in PREVENT mode whenever the configuration
supports it. Otherwise, SIMPLE mode is automatically selected. This
parameter has no effect on restore operations.
BUFFSIZE n|131072
This parameter specifies the block size (in bytes) for the buffers that are
used when it interacts with DB2. The size of the buffers that are sent to the
Tivoli Storage Manager API is the value of BUFFSIZE increased by
approximately 20 bytes. The valid range is 4096 (4 KB) - 32 MB.
Inappropriate values are adjusted automatically. If BUFFCOPY is set to
PREVENT, the value of BUFFSIZE must not exceed 896 KB. If not specified,
the default value is 131072 (128 KB) for UNIX or Linux systems and 32768
(32 KB) for Windows systems. In most cases, these values are appropriate.
If you plan to increase the size of internal buffers, make sure that sufficient
storage is available. The number of buffers that are acquired by Tivoli
Storage Manager for ERP correlates to the number of sessions (keyword
SESSIONS). By activating RL_COMPRESSION, the number of buffers is doubled.
CONFIG_FILE path/SID.bki
Specifies the configuration file initSID.bki for Tivoli Storage Manager for
ERP to store all variable parameters such as passwords and the date of the
last password change. During processing, the string %DB2NODE is replaced
automatically by the current DB2 node of a partitioned database or by
“NODE0000”otherwise. This parameter is required.
END Specifies the end of the parameter definitions. Tivoli Storage Manager for
ERP stops searching the file for keywords when END is encountered.
FRONTEND pgmname [parameterlist]
Specifies a program pgmname that is called by Tivoli Storage Manager for
ERP in a backup run before the connection to the Tivoli Storage Manager
server is established. If pgmname is not a fully qualified path, the default
search path is used to find the program. If not specified, front-end
processing is not done.
Example for UNIX or Linux:
FRONTEND write operator@remotesite Backup of SAP database
object is starting.

This process sends a message to a remote user before backup begins.


LOG_SERVER servername [verbosity]
The servername value specifies the name of the Tivoli Storage Manager
server to which log messages are sent. The servername must match one of
the servers that are listed in a SERVER statement in order for Tivoli
Storage Manager for ERP messages to be logged in the Tivoli Storage
Manager server activity log. The verbosity value can be one of these
specifications: ERROR, WARNING, or DETAIL. This value determines which
messages are sent. The default value is WARNING, which means that error
and warning messages are sent. ERROR sends only error messages. DETAIL
sends all message types (errors, warnings, and informational messages). If
there is no LOG_SERVER statement in the profile, log messages are not sent
to any of the Tivoli Storage Manager servers.

Chapter 9. Reference information 141


MAX_SESSIONS n
Specifies the maximum number of parallel Tivoli Storage Manager client
sessions that Tivoli Storage Manager for ERP establishes For a direct
backup or restore on tape drives, the number of sessions must be less than
or equal to the number of tape drives available for the backup. Make sure
that the MOUNTLIMIT (mountl) parameter in the device class is set to the
number of available tape drives. Make sure that the MAXNUMMP parameter of
the node is set to the number of available tape drives. The value of
keyword MAX_SESSIONS must be less than or equal to the sum of the
SESSIONS values specified in the SERVER statements of the currently
available servers.
MAX_VERSIONS n|0
The n value defines the maximum number of database backup versions to
be kept in backup storage. The default setting for this value is 0, meaning
that backup version control is disabled. Every time a full backup completes
successfully, the version count is increased by an increment of 1 and stored
in the Tivoli Storage Manager for ERP configuration file. This value is also
assigned to the table space files and to all subsequent DB2 log file backups.
If the number of versions that are kept in backup storage is larger than the
specified maximum number of backup versions (stored by the parameter
MAX_VERSIONS), the oldest version is deleted, together with the
corresponding table space, incremental, and log file backups until only the
specified maximum number of most recent versions remain. For
partitioned DB2 databases, a backup version control is done on a partition
basis. Therefore, full backups must always be initiated for all partitions at
the same time, for example by the DB2 script db2_all. For details on the
db2_all script, see your DB2 documentation. Also, consider these
characteristics:
v When Tivoli Storage Manager for ERP deletes an old full backup, all
partial backups older than this full backup are also deleted.
v If the backups are distributed over multiple Tivoli Storage Manager
servers and one of the servers is temporarily unavailable at the time of a
new full backup, it is not possible to find all the backup versions. This
situation might result in retaining a backup that would otherwise delete
it.
v Every database partition needs its own configuration file. Partitions of a
partitioned database must have the same BACKUPIDPREFIX.
Tivoli Storage Manager uses the value of the RETVER parameter (specified
when a copy group is defined) to give files an expiration date. Use only
one of these methods to control how long you keep backups:
v If you use Tivoli Storage Manager for ERP backup version control, you
must bypass this expiration function. Set the Tivoli Storage Manager
parameter RETVER=9999 so that the files are not considered expired and
are not deleted by Tivoli Storage Manager.
v If you use the Tivoli Storage Manager expiration function, turn off the
maximum number of full database backups versions control. Deactivate
Tivoli Storage Manager for ERP backup version control by setting
MAX_VERSIONS=0.
PASSWORDREQUIRED NO|YES
Specifies whether Tivoli Storage Manager requires a password to be
supplied by the Tivoli Storage Manager client. This situation depends on
the Tivoli Storage Manager installation. If not specified, the default is

142 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
PASSWORDREQUIRED YES, which implements manual password handling. This
parameter must be defined with the respective SERVER statement, as shown
in the sample profile.
REDOLOG_COPIES n|1
Specifies the number of copies Tivoli Storage Manager for ERP stores for
each processed DB2 log file. The valid range is 1 - 9. If not specified, Tivoli
Storage Manager for ERP stores one copy of each log file. The number of
different management classes for archived logs (keyword
BRARCHIVEMGTCLASS specified must be greater than or equal to the number
of log file copies specified. The number of different management classes
that are specified must be greater than or equal to the number of log file
copies specified.
RL_COMPRESSION NO|YES
If set to YES, Tivoli Storage Manager for ERP runs a null block compression
of the data before they are sent over the network. Although RL
compression introduces more CPU load, throughput can be improved
when the network is the bottleneck. It is not advised to use RL
compression together with the Tivoli Storage Manager API compression. If
not specified, the default value is NO meaning null block compression is not
done. RL_COMPRESSION is only run if a full database backup was started.
The offline log files are not compressed.
SEGMENTSIZE size[GB|TB]
This keyword specifies the maximum size of the segments that are split
from large backup objects. The required size value must be a positive
integer equal to or greater than 1. Consider these characteristics when you
specify this parameter:
v The scale units (GB or TB) are not required. GB is the default value.
v When you specify the scale units (GB or TB), you can use lowercase
letters, uppercase letters, or a combination of both cases. However, you
cannot specify single-character abbreviations (G or T).
v When this parameter is not specified, one backup object per DB2 backup
session is transferred to Tivoli Storage Manager.
v If the specified segment size is less than the DB2 block size specified
during the backup, the specified segment size is ignored at run time.
The specified DB2 backup block size is used instead.
The following example sets the maximum size of the backup objects
segments on Tivoli Storage Manager to 100 GB:
SEGMENTSIZE 100 GB
You can also specify the command in the following way:
SEGMENTSIZE 100
SERVER servername
This keyword specifies the name of the Tivoli Storage Manager server to
which Tivoli Storage Manager for ERP backups are to be stored. This
statement begins a server section in the Tivoli Storage Manager for ERP
profile. At least one server section is required. Server sections are at the
end of the profile. A server section ends before a following SERVER
keyword, before the END keyword, or at the end of the profile. These
dependent keywords are applicable in a server section:
v ADSMNODE
v BRARCHIVEMGTCLASS
v BRBACKUPMGTCLASS

Chapter 9. Reference information 143


v PASSWORDREQUIRED
v SESSIONS
v TCP_ADDRESS
v USE_AT
The server name must be defined in the Tivoli Storage Manager profiles
dsm.sys (UNIX, Linux) or servername.opt (for Windows). To set up
alternate or parallel paths, each path is denoted by its own logical server
name and corresponding server section, although these logical names refer
to the same server. In this case, the Tivoli Storage Manager profiles specify
the same TCP/IP address for these server names. To set up alternate or
parallel servers, each server is represented by one or more server
statements and the corresponding server sections (depending on the
number of paths to the server). In this case, the Tivoli Storage Manager
profiles specify different TCP/IP addresses for the different servers.
Different server names result in different server entries in the
Administration Assistant View Tivoli Storage Manager Server Utilization
function while identical server names are considered to point to the same
Tivoli Storage Manager server even if they are specified in different Tivoli
Storage Manager for ERP profiles throughout the system landscape. Do
NOT use any profile keywords, ADSM, or TSM as the server name.
SESSIONS n|1
The n value specifies the number of parallel sessions Tivoli Storage
Manager for ERP uses for the server. This keyword is required in every
server section. This parameter must be defined with the respective SERVER
statement, as shown in the sample profile.
TCP_ADDRESSIP address of server
Specifies the IP address of the Tivoli Storage Manager server in dotted
decimal notation. This parameter overrides the value for the parameter
TCPSERVERADDRESS in the Tivoli Storage Manager client system options file
(dsm.sys) on UNIX or Linux or in the client options file (servername.opt)
on Windows. This parameter must be defined with the respective SERVER
statement, as shown in the sample profile.
TRACE FILEIO_MIN | FILEIO_MAX | COMPR_MIN | COMPR_MAX |
MUX_MIN | MUX_MAX | TSM_MIN | TSM_MAX | ASYNC_MIN |
ASYNC_MAX | APPLICATION_MIN | APPLICATION_MAX | SYSCALL_MIN
| SYSCALL_MAX | COMM_MIN | COMM_MAX | DEADLOCK_MIN |
DEADLOCK_MAX | PROLE_MIN | PROLE_MAX | BLAPI_MIN |
BLAPI_MAX | SOCKET_DATA | ALL | OFF
This parameter writes trace information to the file specified with the
TRACEFILE parameter. Arguments to TRACE can be any combination of the
possible components and levels that are separated by spaces. A trace is
written only if both TRACE and TRACEFILE are specified. Do not use this
parameter unless instructed to use it by Tivoli Storage Manager for ERP
support. Using it can significantly deteriorate the performance of Tivoli
Storage Manager for ERP.
TRACEFILE path
Specifies the name and location of the trace file for Tivoli Storage Manager
for ERP to store all trace information. When TRACE is used, path specifies
the full path and the name of file. If the value of TRACEFILE contains the
string %BID, this string is replaced by the backup ID to get the path and
name of the trace file used. For example, specifying /tmp/%BID.trace yields
a trace file /tmp/myBackup.trace for backup ID myBackup. A trace is
written only if both TRACE and TRACEFILE are specified.

144 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
TRACEMAX n
Specifies the maximum size of the trace file in KB. The valid range is 4096
(4 MB) - unlimited. If not specified, the trace file size is unlimited.
USE_AT days
Specifies the days that the Tivoli Storage Manager server (specified with
the corresponding SERVER keyword) is used. The days value can be
numbers in the range 0 (Sunday) - 6 (Saturday). Multiple numbers can be
used when separated by spaces. If not specified, the default is to use the
Tivoli Storage Manager server on all days. This parameter must be defined
with the respective SERVER statement. The parameter USE_AT has no effect
on actions other than on a backup.

Sample profile file for UNIX or Linux


A sample profile file (initSID.utl) is included in the Tivoli Storage Manager for
ERP installation package.
#--------------------------------------------------------------------------
#
# Data Protection for SAP (R) interface for DB2 UDB
#
# Sample profile for Data Protection for SAP (R) Version 7.1
#
#--------------------------------------------------------------------------
#
# See the ’Data Protection for SAP (R) Installation &
# User’s Guide’ for a full description.
#
# For a comment symbol the character ’#’ can be used.
# Everything following this character will be interpreted as comment.
#
# Data Protection for SAP (R) accesses its profile
# in "read only" mode. All variable parameters like passwords, date of
# last password change, current version number will be written into the file
# specified with the CONFIG_FILE parameter. The passwords will be encrypted.

#--------------------------------------------------------------------------
# Prefix of the ’Backup ID’ which is stored in the description field of
# the Tivoli Storage Manager archive function.
# Maximum 6 characters.
# Default: none.
#--------------------------------------------------------------------------
BACKUPIDPREFIX SID___

#--------------------------------------------------------------------------
# Number of parallel sessions to be established.
# Note: This number must not exceed the number of tape drives simultaneously
# available to the node on the Tivoli Storage Manager servers to be accessed.
# The valid range of MAX_SESSIONS is from 1 and 32.
# Default: none.
#--------------------------------------------------------------------------
MAX_SESSIONS 1 # Tivoli Storage Manager client sessions

#--------------------------------------------------------------------------
# Number of backup copies of the DB2 log files.
# The valid range of REDOLOG_COPIES is from 1 to 9.
# Default: 1.
#--------------------------------------------------------------------------
#REDOLOG_COPIES 2

#--------------------------------------------------------------------------

Chapter 9. Reference information 145


# Specifies the block size for disk I/O (in bytes).
# The default values have been chosen from our performance experiments in
# standard hardware environments.
# The valid range of BUFFSIZE is from 4KB to 32MB.
# Default: 131072 (128 KB) on UNIX, 32768 (32 KB) on Windows.
#--------------------------------------------------------------------------
BUFFSIZE 131072 # block size in bytes

#--------------------------------------------------------------------------
# This optional parameter controls how Data Protection for SAP(R) uses
# the internal buffers for transferring data during a backup.
# Valid values: SIMPLE | PREVENT | AUTO
# Default: SIMPLE
#--------------------------------------------------------------------------
#BUFFCOPY AUTO

#--------------------------------------------------------------------------
# Name of a program to be called before the backup task is started.
# Default: none.
#--------------------------------------------------------------------------
#FRONTEND pgmname parameterlist

#--------------------------------------------------------------------------
# Name of a program to be called after the backup task is completed.
# Default: none.
#--------------------------------------------------------------------------
#BACKEND pgmname parameterlist

#--------------------------------------------------------------------------
# Maximum number of data base backup versions to be kept.
# Note: Version control by Data Protection for SAP (R) is only activated
# only activated if the parameter MAX_VERSION is not 0.
# The valid range of MAX_VERSIONS is from 0 to 9999.
# A value of 0 means no versioning.
# Default: 0, no versioning.
#--------------------------------------------------------------------------
#MAX_VERSIONS 4

#--------------------------------------------------------------------------
# Specifies whether a null block compression of the data is to be performed
# before transmission to Tivoli Storage Manager.
# Although RL compression introduces additional CPU load, throughput can be
# improved when the network is the bottleneck. RL compression in Data
# Protection for SAP(R) should not be used together with
# Tivoli Storage Manager API compression.
# Default: NO
#--------------------------------------------------------------------------
#RL_COMPRESSION YES # NO is default

#--------------------------------------------------------------------------
# Controls generation of a trace file.
# Note: We recommend using the trace function only in cooperation with
# Data Protection for SAP (R) support.
# Default: OFF.
#--------------------------------------------------------------------------
#TRACE OFF
#TRACEFILE /db2/C21/sqllib/log/tdpr3.trace

#--------------------------------------------------------------------------
# Denotes the maximum size of the trace file in KB.

146 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
# If not specified, the trace file size is unlimited.
#--------------------------------------------------------------------------
#TRACEMAX max. size # trace file size in KB

#--------------------------------------------------------------------------
# Specify the full path of the configuration file.
# Default: none.
#--------------------------------------------------------------------------
CONFIG_FILE /db2/C21/sqllib/%DB2NODE/initSID.bki

#--------------------------------------------------------------------------
# Denotes if Data Protection for SAP (R) shall send error/status
# information to a Tivoli Storage Manager server.
# The servername must match one of the servers listed in a SERVER statement.
# Valid values for verbosity are ERROR | WARNING | DETAIL.
# Default: none.
#--------------------------------------------------------------------------
#LOG_SERVER servername [verbosity]
#LOG_SERVER server_a ERROR

#**************************************************************************
# Statement for servers and paths.
# Multiple servers may be defined.
#**************************************************************************

SERVER server_a # Servername, as defined in dsm.sys


SESSIONS 2 # Maximum number of sessions
# to server_a
PASSWORDREQUIRED YES # Use a password
ADSMNODE NODE # Tivoli Storage Manager Nodename
BRBACKUPMGTCLASS MDB # Mgmt-Classes for database backup
BRARCHIVEMGTCLASS MLOG1 MLOG2 # Mgmt-Classes for redo log backup
# TCP_ADDRESS 192.168.1.1 # IP address of network interface
# on server_a
# Overrides IP address of dsm.sys
# USE_AT 0 1 2 3 4 5 6 # Days when server_a is used for
# backup
#**************************************************************************
# USE_AT : 0=Su 1=Mo 2=Tu 3=We 4=Th 5=Fr 6=Sa
# The valid range of USE_AT is from 0 to 6.
# Default: all days
#**************************************************************************

#SERVER server_b # Servername, as defined in dsm.sys


# SESSIONS 2 # Maximum number of sessions
# to server_b
# PASSWORDREQUIRED YES # Use a password
# ADSMNODE NODE # Tivoli Storage Manager Nodename
# BRBACKUPMGTCLASS MDB # Mgmt-Classes for database backup
# BRARCHIVEMGTCLASS MLOG1 MLOG2 # Mgmt-Classes for redo log backup
# TCP_ADDRESS 192.168.1.1 # IP address of network interface
# on server_b
# Overrides IP address of dsm.sys
# USE_AT 0 1 2 3 4 5 6 # Days when server_b is used for
# backup
#**************************************************************************
# USE_AT : 0=Su 1=Mo 2=Tu 3=We 4=Th 5=Fr 6=Sa
# Default: all days
#**************************************************************************

#--------------------------------------------------------------------------

Chapter 9. Reference information 147


# End of profile

END

Sample Data Protection for SAP for DB2 profile (Windows)


The sample profile file (initSID.utl) is included in the Tivoli Storage Manager for
ERP installation package.
#--------------------------------------------------------------------------
#
# Data Protection for SAP (R) interface for DB2 UDB
#
# Sample profile for Data Protection for SAP (R)
# Version 6.2 for Windows 2000/2003
#
#--------------------------------------------------------------------------
#
# See the ’Data Protection for SAP (R) Installation & User’s Guide’ for
# a full description.
#
# For a comment symbol the character ’#’ can be used.
# Everything following this character will be interpreted as comment.
#
# Data Protection for SAP (R) accesses its profile in "read only" mode.
# All variable parameters like passwords, date of last password
# change, current version number will be written into the file specified
# with the CONFIG_FILE parameter. The passwords will be encrypted.

#--------------------------------------------------------------------------
# Prefix of the ’Backup ID’ which is used for communication with the
# SAP® BR*Tools and stored in the description field of the
# Tivoli Storage Manager archive function.
# Must be 6 characters.
# Default: none.
#--------------------------------------------------------------------------
BACKUPIDPREFIX SID___

#--------------------------------------------------------------------------
# Number of parallel sessions to be established.
# Note: This number must not exceed the number of tape drives simultaneously
# available to the node on the Tivoli Storage Manager servers to be accessed.
# The valid range of MAX_SESSIONS is from 1 and 32.
# Default: none.
#--------------------------------------------------------------------------
MAX_SESSIONS 1 # Tivoli Storage Manager client sessions

#--------------------------------------------------------------------------
# Number of backup copies of the DB2 log files.
# The valid range of REDOLOG_COPIES is from 1 to 9.
# Default: 1.
#--------------------------------------------------------------------------
#REDOLOG_COPIES 2

#--------------------------------------------------------------------------
# Specifies the block size for disk I/O (in bytes).
# The default values have been chosen from our performance experiments in
# standard hardware environments.
# The valid range of BUFFSIZE is from 4KB to 32MB.
# Default: 131072 (128 KB) on UNIX, 32768 (32 KB) on Windows.
#--------------------------------------------------------------------------
BUFFSIZE 32768 # block size in bytes

148 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
#--------------------------------------------------------------------------
# This optional parameter controls how Data Protection for SAP(R) uses
# the internal buffers for transferring data during a backup.
# Valid values: SIMPLE | PREVENT | AUTO
# Default: SIMPLE
#--------------------------------------------------------------------------
#BUFFCOPY AUTO

#--------------------------------------------------------------------------
# Name of a program to be called before the backup task is started.
# Default: none.
#--------------------------------------------------------------------------
#FRONTEND pgmname parameterlist

#--------------------------------------------------------------------------
# Name of a program to be called after the backup task is completed.
# Default: none.
#--------------------------------------------------------------------------
#BACKEND pgmname parameterlist

#--------------------------------------------------------------------------
# Maximum number of data base backup versions to be kept.
# Note: Version control by Data Protection for SAP (R) is
# only activated if the parameter MAX_VERSION is not 0.
# The valid range of MAX_VERSIONS is from 0 to 9999.
# Default: 0
#--------------------------------------------------------------------------
#MAX_VERSIONS 4

#--------------------------------------------------------------------------
# Specifies whether a null block compression of the data is to be performed
# before transmission to Tivoli Storage Manager.
# Although RL compression introduces additional CPU load, throughput can be
# improved when the network is the bottleneck. RL compression in Data
# Protection for SAP(R) should not be used together with
# Tivoli Storage Manager API compression.
# Default: NO
#--------------------------------------------------------------------------
#RL_COMPRESSION YES

#--------------------------------------------------------------------------
# Controls generation of a trace file.
# Note: We recommend using the trace function only in cooperation with
# Data Protection for SAP (R) support.
# Default: OFF
#--------------------------------------------------------------------------
#TRACE OFF
#TRACEFILE c:\sqllib\tdp_r3\log\tdpr3.trace

#--------------------------------------------------------------------------
# Denotes the maximum size of the trace file in KB.
# If not specified, the trace file size is unlimited.
#--------------------------------------------------------------------------
#TRACEMAX max. size # trace file size in KB

#--------------------------------------------------------------------------
# Specify the full path of the configuration file.
# Default: none.
#--------------------------------------------------------------------------

Chapter 9. Reference information 149


CONFIG_FILE c:\sqllib\tdp_r3\%DB2NODE\initSID.bki

#--------------------------------------------------------------------------
# Denotes if Data Protection for SAP (R) shall send
# error/status information to a Tivoli Storage Manager server.
# The servername must match one of the servers listed in a SERVER statement.
# Valid values for verbosity are ERROR | WARNING | DETAIL.
# Default: none.
#--------------------------------------------------------------------------
#LOG_SERVER servername [verbosity]
#LOG_SERVER server_a ERROR

#**************************************************************************
# Statement for servers and paths.
# Multiple servers may be defined.
#**************************************************************************

SERVER server_a # Servername, as defined in dsm.sys


SESSIONS 2 # Maximum number of sessions
# to server_a
PASSWORDREQUIRED YES # Use a password
ADSMNODE NODE # Tivoli Storage Manager Nodename
BRBACKUPMGTCLASS MDB # Mgmt-Classes for database backup
BRARCHIVEMGTCLASS MLOG1 MLOG2 # Mgmt-Classes for redo log backup
# TCP_ADDRESS 192.168.1.1 # IP address of network interface
# on server_a
# Overrides IP address of dsm.sys
# USE_AT 0 1 2 3 4 5 6 # Days when server_a is used for
# backup
#**************************************************************************
# USE_AT : 0=Su 1=Mo 2=Tu 3=We 4=Th 5=Fr 6=Sa
# The valid range of USE_AT is from 0 to 6.
# Default: all days
#**************************************************************************

#SERVER server_b # Servername, as defined in dsm.sys


# SESSIONS 2 # Maximum number of sessions
# to server_b
# PASSWORDREQUIRED YES # Use a password
# ADSMNODE NODE # Tivoli Storage Manager Nodename
# BRBACKUPMGTCLASS MDB # Mgmt-Classes for database backup
# BRARCHIVEMGTCLASS MLOG1 MLOG2 # Mgmt-Classes for redo log backup
# TCP_ADDRESS 192.168.1.1 # IP address of network interface
# on server_b
# Overrides IP address of dsm.sys
# USE_AT 0 1 2 3 4 5 6 # Days when server_b is used for
# backup
#**************************************************************************
# USE_AT : 0=Su 1=Mo 2=Tu 3=We 4=Th 5=Fr 6=Sa
# Default: all days
#**************************************************************************

#--------------------------------------------------------------------------
# End of profile

END

150 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
The custom SQL file
The custom SQL file must be only implemented or modified by IBM support
personnel. The support requirement is detailed knowledge of the process that is
involved and the internal Administration Assistant for Data Protection for SAP
database.

The custom SQL file must be named customSQLFile.txt and placed in the
installation directory or folder of the Administration Assistant. For example:
C:\Program Files\tdpr3assi\customSQLFile.txt

The custom SQL file contains this structure:


# CUSTOM SQL FILE Comment

sqlSQL statement/sqldescription ... /param


sqlSQL statement/sqldescription ... /param
...

As an aid to explaining the entry structure, it is shown in the following with each
tag set in a separate line:
sqlSQL statement/sql
descriptionDescription of the SQL statement/description
programid0/programid
actionid0/actionid
displaygroup1,3/displaygroup
backuptype2/backuptype
executionmode0/executionmode
paramparameter-value1/param
paramparameter-value2/param
...
paramparameter-valuen/param

Each entry must be coded in a single line.

The tag definitions are as follows:


Table 8. Contents of the Custom SQL File
Tag Definition
# Comment line
sql An SQL statement that defines which data is to be sent.
Note:
1. Only SELECT statements are processed.
2. A semicolon at the end of the line is not allowed.
3. The maximum line length is 400 characters.
description Description of the SQL statement (maximum length: 300 characters)
programid Specifies the program that handles the result of the SQL statement.
v programid 0: Administration Assistant
actionid Defines the manner in which the result is handled, depending on the
programid (currently, the only value for actionid is 0):
v (programid 0: Administration Assistant): Send email when threshold
exceeded (SQL statement returns data)
displaygroup List of display group IDs separated by commas, or ALL for all display
groups.

Chapter 9. Reference information 151


Table 8. Contents of the Custom SQL File (continued)
Tag Definition
system List of system IDs separated by commas, or ALL for all systems.
backuptype List of backup types that are separated by commas, or ALL for all
backup types.
v 0: Archive
v 1: Partial backup
v 2: Incremental backup
v 3: Full backup
executionmode executionmode sets the time that the entry is performed (For example,
the SQL statement that is issued):
v 0: Entry is done after each backup run
v 1: Entry is done periodically
param Parameters that are needed by the programs. The number of
parameters depends on the selected program and action. Multiple
parameters are coded by using repeating param/param tag pairs.
v (programid 0: Administration Assistant):
– One parameter, consisting of the email address list (separated by
semicolons)

Consider these facts about the custom SQL file:


v Each entry in the file must be on a single line.
v If executionmode is 1, the system, displaygroup, and backuptype tags are ignored,
and the SQL statement is done periodically.
v If executionmode is 0, the SQL statement is done after the backup completes, but
only if the system tag matches the system on which the backup was run, or the
displaygroup tag matches the displaygroup that the system belongs to.
Furthermore, the backuptype tag must match the backup type of the backup run.
v The system and displaygroup tags are mutually exclusive.
v The custom SQL file is reloaded periodically by the Administration Assistant
Server component. Restarting the server is not necessary.

Define thresholds using the custom SQL file


A custom threshold can be defined in the custom SQL file.

The corresponding entry has the following values for the indicated tags:
Table 9. Tags for Defining Thresholds in the Custom SQL File
Tag Value
sql An SQL statement that returns data when the threshold is exceeded.
programid 0 (Administration Assistant)
actionid 0 (send email when threshold exceeded)
executionmode 1 (run periodically)
param (Optional) One or more email addresses that are separated by
semicolons. If no email address is given, only a panel indication is
given that the threshold is exceeded.
Note: Multiple email addresses are given in a single param/param tag
pair, not in multiple pairs.

152 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Sample custom SQL file
A sample custom SQL file for the Administration Assistant is shown in the
following example.
# CUSTOM SQL FILE FOR THE ADMINISTRATION ASSISTANT
#
# This file should only be changed by an IBM Employee
# After the changes you have to check this file using CustomSQLFilecheck
#
# NOTE: Each entry must be coded in one line. The multi-line format
# shown below is for illustration purposes only.
#
#
# Sample threshold definition: backup size > 500 GB, display group 1, backup type 2
#
sqlselect * from AdminAssistant.tsmrun where amount > 500000000000/sql
descriptionAmount over 500 GB/description
programid0/programid
actionid0/actionid
displaygroup1/displaygroup
backuptype2/backuptype
executionmode0/executionmode
[email protected]/param
#

Protecting Data for SAP for DB2 files and samples


Use the file samples to assist you with Data Protection for SAP for DB2 operations.

Procedure
v Review the out put samples for dsm.opt, the include/exclude statement, and
dsm.sys.
v Use the planning sheet to help you plan the installation parameters for Data for
SAP for DB2 .

Scheduling a report, shell script sample (UNIX)


The scheduledReport.sh file is provided in the Data Protection for SAP for DB2
package and is copied to the Administration Assistant for Data Protection for SAP
installation.
#--------------------------------------------------------------------------
#
# Tivoli Storage Manager for ERP. Data Protection for SAP for DB2
#
# Sample command file for the Administration Assistant scheduling client
#
# --------------------------------------------------------------------------
# ***** NOTE ***** NOTE ***** NOTE *****
#
# This script is provided as a model and should be
# carefully tailored to the needs of the specific site.
#
# ***** NOTE ***** NOTE ***** NOTE *****
#--------------------------------------------------------------------------
export CLASSPATH=/reporting/Admt.jar:$CLASSPATH
export PATH=/usr/bin:$PATH
java -classpath $CLASSPATH com.ibm.bkit.schedulerIF.Sched_Main xxx.xxx.xxx.xxx...
... 1099 myReport ADMIN admin directory=/myreports log=/tmp/reportlogs

Chapter 9. Reference information 153


Scheduling a report, sample command file (Windows)
The scheduledReport.cmd file is provided in the Data Protection for SAP for DB2
package, and is copied to the Administration Assistant for Data Protection for SAP
Server component installation.
#--------------------------------------------------------------------------
#
# Tivoli Storage Manager for ERP. Data Protection for SAP for DB2
#
# Sample command file for the Administration Assistant scheduling client
#
# --------------------------------------------------------------------------
# ***** NOTE ***** NOTE ***** NOTE *****
#
# This script is provided as a model and should be
# carefully tailored to the needs of the specific site.
#
# ***** NOTE ***** NOTE ***** NOTE *****
#--------------------------------------------------------------------------
set CLASSPATH=C:\ProgramFiles\reporting\Admt.jar
set PATH=C:\Program Files\IBM\Java142\jre\bin:%PATH%
java -cp %CLASSPATH% com.ibm.bkit.schedulerIF.Sched_Main xxx.xxx.xxx.xxx ...
... 1099 myReport ADMIN admin directory=C:\reports log=C:\reportlogs

Client user options file sample (UNIX, Linux)


************************************************************************
* Tivoli Storage Manager *
* *
* Sample Client User Options file for Unix platforms *
************************************************************************

SErvername server_a
Replace On
Tapeprompt No
DOM /usr/sap /sapmnt/C21 /usr/sap/trans /db2/C21

Client user options file sample (Windows)


Data Protection for SAP for DB2 requires a client options file dsm.opt to be present
in the location indicated by environment variable DSMI_CONFIG. The specific options
that are used by Data Protection for SAP for each server are taken from file
server.opt in the same path.
*************************************************************************
*
* DSM.OPT (for Data Protection for SAP)
*
* This file is intentionally left empty. It must be present in the location
* indicated by environment variable DSMI_CONFIG. The specific options used
* by Data Protection for SAP for each server however are taken from files
* server.opt residing in the same path.
*
* Please note: This client options file is not meant to be used by other
* TSM clients.
*
*************************************************************************

154 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Client system options file sample (dsm.sys)
The system options file lists information that includes the buffersize and
compression status. The following sample shows the typical output.
************************************************************************
* IBM Tivoli Storage Manager *
* *
* Sample Client System Options file for Unix platforms *
************************************************************************

SErvername server_a
COMMmethod TCPip
TCPPort 1500
TCPServeraddress your_ITSM_server_1
TCPBuffsize 32
TCPWindowsize 24
Compression Off
InclExcl /usr/lpp/adsm/bin/inclexcl.list

SErvername server_b
COMMmethod TCPip
TCPPort 1500
TCPServeraddress your_ITSM_server_2
TCPBuffsize 32
TCPWindowsize 24
Compression Off
InclExcl /usr/lpp/adsm/bin/inclexcl.list

Include/exclude list sample (UNIX, Linux)


The include/exclude list shows the files and directories that are included or
excluded for backup operations.
* ---------------------------------------------------------------------------
* inclexcl.list:
* Sample include/exclude list
* ---------------------------------------------------------------------------
* Task:
* Include/Exclude list of files and directories for TSM incremental backups
* ---------------------------------------------------------------------------
* ***** NOTE ***** NOTE ***** NOTE *****
*
* This file is intended only as a model and should be
* carefully tailored to the needs of the specific site.
*
* ***** NOTE ***** NOTE ***** NOTE *****
* ---------------------------------------------------------------------------
*
* For all UNIX systems
*
exclude /unix
exclude /.../core
exclude /u/.../.*sh_history
exclude /home/.../.*sh_history
*
* Note: It is recommended to perform system backups on a regular
* basis. Consequently, you can exclude at least the following
* directories:
*
exclude /usr/games/.../*
exclude /usr/bin/.../*
exclude /usr/lbin/.../*
exclude /usr/mbin/.../*
exclude /usr/sbin/.../*
* ---------------------------------------------------------------------------
*

Chapter 9. Reference information 155


* For those using AFS, exclude the cache filesystem or file
*
* exclude /usr/vice/cache/*
* exclude /var/vice/cache/*
* or
* exclude /afscfs
* ---------------------------------------------------------------------------
*
* This stuff is either not worthwhile to be included or should be backed up
* using DB2 backup techniques and the SAP utility brarchive.
*
exclude /db2/C21/log_archive/C21/*
* exclude /db2/C21/sapreorg/.../* (There may be important scripts
* located, check it out and decide.)
exclude /db2/C21/sapdata*/.../*
exclude /db2/C21/sapraw*/.../*
* ---------------------------------------------------------------------------
*
* With the above include/exclude list we implicitly include everything not
* excluded above. Especially for DP for SAP, this means including:
* /sapmnt/C21 > 300 MB
* /usr/sap > 50 MB
* /db2/C21 > 200 MB
* and UNIX related > 350 MB
* ---------------------------------------------------------------------------

Include/exclude list sample (Windows)


The include/exclude list is intended for the standard client user option file. The
purpose is to exclude files that are easy to restore. Also, exclude files that are
already saved by Data Protection for SAP for DB2 from routine Tivoli Storage
Manager incremental backups. Typically, such files are Windows system files and
DB2 database files.
*************************************************************************
* This Include-Exclude list is used for incremental backups of file
* systems by the Tivoli Storage Manager command-line backup client.
* Therefore the name of this file has to be set under the keyword InclExcl
* in the standard Tivoli Storage Manager client user option file "dsm.opt".
*
* Since the backup of the DB2 database is done by
* Data Protection for SAP(R) and not by Tivoli Storage
* Manager command-line backup client, the DB2 database should be excluded
* from backups by the Tivoli Storage Manager command-line backup client.
*
* Note 1:
* The environment variable DSM_CONFIG contains the full file name of
* the Tivoli Storage Manager client user option file "dsm.opt".
* Note 2:
* This Include-Exclude is not used by Data Protection for SAP(R)
*
*************************************************************************
Exclude *:\...\*.swp
Exclude *:\...\*.obj
Exclude *:\...\*.csm
Exclude *:\...\*.dsk
Exclude *:\...\*.bak
Exclude *:\...\win386.swp
Exclude *:\...\386spart.par
Exclude *:\...\pagefile.sys
Exclude *:\...\*.par
Exclude *:\...\SYSTEM32\CONFIG\*.*
Exclude *:\...\SYSTEM32\CONFIG\...\*
Exclude *:\IBMBIO.COM
Exclude *:\IBMDOS.COM
*
*Exclude the following DB2 database files:

156 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
*
Exclude *:\db2\C21\log_archive\C21\...\*
Exclude *:\db2\C21\sapreorg\...\*
Exclude *:\db2\C21\sapdata*\...\*

Client options files sample


Data Protection for SAP for DB2 requires a corresponding client option file
server.opt for each Tivoli Storage Manager server. These files must be in the same
directory. This directory must also contain the client options file dsm.opt, which is
specified in the environment variable DSMI_CONFIG.
*************************************************************************
*
* SERVER.OPT
*
* Data Protection for SAP (R) obtains the necessary information about
* a Tivoli Storage Manager server ’server’ from a client option file
* called ’server.opt’. For each Tivoli Storage Manager server a
* corresponding client option file is required.
*
* Note: This file contains the client options for the Tivoli Storage Manager
* server called ’server_a’.
*
* Please see the Tivoli Storage Manager documentation for details.
*
*************************************************************************
COMMmethod TCPIP
COMPression OFF
*NODEname C21
TCPPort 1500
TCPServeraddress xxx.xxx.xxx.xxx
PASSWORDACCESS PROMPT
TCPBUFFSIZE 31
TCPWINDOWSIZE 32

Vendor environment file sample


A DB2 vendor environment file (vendor.env) is created from the information that is
entered in the installation dialog panels during installation. A sample DB2 vendor
environment file is included in the Data Protection for SAP for DB2 installation
package.

Note

Ensure that there are no blanks within the paths that are specified for the
vendor-specific environment variables of the vendor environment file. DB2 is
unable to handle embedded blanks. For a standard Windows installation, the Data
Protection for SAP profile is at
c:\Program Files\Tivoli\tsm\tdp_r3\db264\initSID.utl

Sample DB2 vendor environment file for UNIX or Linux:


XINT_PROFILE=/db2/C21/tdpr3/initC21.utl
TDP_DIR=/db2/C21/tdpr3/tdplog
BACKOM_LOCATION=/usr/tivoli/tsm/tdp_r3/db264/backom

Sample DB2 vendor environment file for Windows:


XINT_PROFILE=c:\db2\C21\tdpr3\initC21.utl
TDP_DIR=c:\db2\C21\tdpr3\tdplog
BACKOM_LOCATION=c:\tivoli\tsm\tdp_r3\db264\backom.exe

Chapter 9. Reference information 157


Planning sheet for the base product
Use the planning sheet to assist you when you are installing and configuring Data
Protection for SAP .

Collect the information in this planning sheet before you install Data Protection for
SAP . This table is also provided in file form as planning_sheet_db2 for UNIX and
Linux and planning_sheet_db2.txt for Windows.
Table 10. Installation Parameters for Data Protection for SAP
UNIX
or
Linux Windows Installation parameter
X X DB2 database SID.
X X Tivoli Storage Manager server name or IP address:
Tivoli Storage Manager node name: Tivoli Storage Manager node that is configured on the
X X
Tivoli Storage Manager server that is named for the backup of the SID previously listed.
Tivoli Storage Manager management classes for database and log file backups. Management
X X classes that are configured for the database backup and for the backup of log files.

Default: MDB for database backups, MLOG1 and MLOG2 for log file backups.
Path where the Tivoli Storage Manager API are in (contents of environment variable DSMI_DIR):
X
Default: C:\Program Files\Common Files\tivoli\TSM\api64
Path to client option file of Tivoli Storage Manager (contents of environment variable
X
DSMI_CONFIG).
Path to Tivoli Storage Manager log files (contents of environment variable DSMI_LOG): The Tivoli
Storage Manager API creates the file dsierror.log in this path.
X
Default: C:\temp
Installation path for Data Protection for SAP executable files:
X
C:\Program Files\Tivoli\TSM\tdp_r3\db264
Options:
v Use of the Administration Assistant. The Administration Assistant is to be installed before
X X Data Protection for SAP so that the interface between the two can be automatically
established.
v Use of DB2 Log Manager for log archiving.

Administration Assistant planning sheet


Collect the information in this planning sheet before you install the Administration
Assistant for Data Protection for SAP.

This table is also provided in file form as planning_sheet_aa for UNIX and Linux,
and planning_sheet_aa.txt for Windows.
Table 11. Installation parameters for the Administration Assistant for Data Protection for SAP
Installation
Option Installation Parameter

Decision whether the Administration Assistant is to be installed on a single host (typical installation) or
Installation type distributed across multiple hosts (custom installation).

Default: Single-host

158 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Table 11. Installation parameters for the Administration Assistant for Data Protection for SAP (continued)
Installation
Option Installation Parameter

Server/client Decision whether the Administration Assistant Server component and clients communicate in nonsecure mode
communication through HTTP or secure mode through HTTPS.
mode
Default: Nonsecure

Decision as to which DBMS the Administration Assistant is to use. Select either the installation of the bundled
Database type Apache Derby package or the use of an existing Apache Derby or IBM DB2 installation.

Default: Installation of Apache Derby as bundled with product.

If you want to migrate data from an existing Administration Assistant environment, enter the directory that
Data migration contains the *.aa files.

Default: No migration.

Software Decision whether to install only the English version of the program or all globalization versions.
language
Default: English-only

Host name or IP address:

Default: Host name of current system

Port number for Data Protection for SAP for DB2 (ProLE) connect. This port number must be made known to
all instances of Data Protection for SAP that are to be managed and monitored by this Server component
instance.

Default: 5126

Port number for client connect in non-secure mode (HTTP).


Parameters
Default: 80
applying to the
Administration
Port number for client connect in secure mode (HTTPS).
Assistant Server
component
Default: 443

RMI registry port number

Default: 1099

Port number for performance data from Database Agent

Default: 5129

Port number for communication with Database Agent

Default: 5128

Host name or IP address:

Parameters Default: Host name of current system


applying to the
Administration Port number for Data Protection for SAP (ProLE) connection
Assistant
Database Agent Default: 5125
component
Port number for communication with Administration Assistant Server component

Default: 5127

Chapter 9. Reference information 159


Table 11. Installation parameters for the Administration Assistant for Data Protection for SAP (continued)
Installation
Option Installation Parameter

Host name or IP address:


Parameters
Default: Host name of current system
applying to the
Administration
Port number for database connect
Assistant
Database
Default: 1527
component
(Apache Derby) User ID and password to access internal database.

Default: None

Host name or IP address:

Parameters Default: Host name of current system


applying to the
Administration Port number for database connect
Assistant
Database Default: 50000
component (IBM
DB2) User ID and password of the system user for which the DB2 instance is to be installed that the internal
database is to access.

Default: None
Installation directory (on each host)
Installation
directory
Default: /opt/tivoli/tsm/tdp_r3_assist on UNIX and Linux, or C:\Program Files\tdpr3assi on Windows.
Location of mail.jar (JavaMail)
Product Support
Default: None
Location of activation.jar (Java Beans Activation Framework):
Product Support
Default: None
History file directory (on Server component host)

Default: history (in installation directory)


History file
History file retention time (days). Can be changed through the Administration Assistant client.

Default: 14

160 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Table 11. Installation parameters for the Administration Assistant for Data Protection for SAP (continued)
Installation
Option Installation Parameter
Information about the public key infrastructure (PKI):
v Keystore name. Keystore contains the private and public keys of the Administration Assistant Server
component when it runs in secure mode. If you do not yet have a public key infrastructure, the keystore can
be created during the installation process.
v Keystore password. Password ensuring the consistency of the keystore. The server's key pair must be protected
by the same password.
v Truststore name. Truststore containing a set of trusted certificates. When it runs in secure mode, the
Administration Assistant's server certificate must be verified against this truststore when the server is
started.
v Truststore password. Password ensuring the consistency of the truststore. This variable is required only if a
Secure trusted certificate must be imported into the truststore during the installation process.
Communication v Certificate file. Path of the certificate file in case you already have a server certificate that is issued by a
certificate authority.
v Certificate creation information. Information about the X.500 distinguished name and on the validity period
that is required in case a new self-signed certificate is created during the installation process. The X.500
distinguished name provides information about the common name, organizational unit, organization name,
locality name, state name, and country code. For details on this information, refer to the X.500 and X.509
standards.
v New certificate file name. If the public key of a newly created server key pair must be distributed to client
systems, it is exported to this file.
v CSR file name. If the newly created server key pair is used to request a certificate that is signed by a
Certificate Authority, the Certificate Signing Request is written to this file.

DB2 JDBC Universal Driver. The corresponding packages are bundled with your IBM DB2 installation.
v db2jcc.jar location :Default: None
v db2jcc_license_cu.jar location: Default: None

Internal database The Administration Assistant database is enabled for automatic storage and has a set of one or more associated
that is managed storage paths. Enter at least one disk or path that DB2 is allowed to assign and allocate for its table space
by DB2 containers.

Default: None

The name of the internal database is predefined and cannot be changed.

Default: AADB

Database directory:

Default: aaDBSupport (in installation directory)

Internal database Name of the internal database


that is managed
by Apache Derby Default: “adminAssistant”

Retention time for data in database (days). (To save this data, the backup facilities that are offered by Derby
can be used.)

Default: 175
Option: English-only or all languages
Documentation
Default: English-only

Chapter 9. Reference information 161


Network settings for Tivoli Storage Manager
When you are using Tivoli Storage Manager with Data Protection for SAP, you can
improve performance by making updates to the configuration files. Before you edit
configuration files, save a backup copy.

The performance adjustments for Tivoli Storage Manager are completed by editing
the following files:
v Tivoli Storage Manager server option file dsmserv.opt
v Tivoli Storage Manager backup-archive client option file dsm.sys (UNIX and
Linux systems), or server.opt (Windows systems).

This table shows the corresponding Tivoli Storage Manager configuration file
attributes with the values.
Table 12. Tuning Tivoli Storage Manager Configuration File Attributes
Attributes Value Description
TCPBuffsize 32 Specifies the size, in KB, of the buffer that is used
for TCP/IP send requests. This option affects
whether Tivoli Storage Manager sends the data
directly from the session buffer or copies the data to
the TCP buffer. A buffer size of 32 KB forces Tivoli
Storage Manager to copy data to its communication
buffer and flush the buffer when it fills.
TCPNODelay YES Specifies whether the server is to send small
amounts of data or allow TCP/IP to buffer the data.
Disallowing buffering might improve throughput
but more packets are sent over the network.
TCPWindowsize Specifies the size, in KB, which is used for the
640 (AIX) TCP/IP sliding window for the client node. This size
63 (others) is used when data is sent or received. The range of
values is 0 - 2048.

Networks with large bandwidth delay


For networks with a large bandwidth-delay, activate the TCP enhancements as
specified in RFC1323.

For example, the network on an AIX system can be configured with the no
command. This command sets or displays current network attributes in the kernel.
Details about the no command are available in the man page of no of your operating
system.

This table shows the network attributes with their advised values:
Table 13. Tuning of network settings
Attributes Value Description
rfc1323 1 Enables TCP enhancements as specified by RFC
1323, TCP Extensions for High Performance. The
default is 0. A value of 1 specifies that all TCP
connections attempts to negotiate the RFC
enhancements.

162 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Table 13. Tuning of network settings (continued)
Attributes Value Description
sb_max 131072 Specifies the maximum buffer size that is allowed for
a socket. The default is 65536 bytes. From the point
of view of performance recommendations, the sb_max
value is to be twice the TCPWindowsize set within the
Tivoli Storage Manager configuration file dsm.sys.

Set these values by issuing these commands by the root user on the appropriate
system:
no -o rfc1323=1
no -o sb_max=131072

The no command does not do range checking. It accepts all values. If used
incorrectly, the command might cause the system to become inoperable. These
changes are lost at system restart. To permanently change the values, edit the
/etc/rc.net file.

SP switch (RISC 6000)


If an SP switch (RISC 6000) is used, the rpoolsize and spoolsize values must be
set as shown in the following table.
Table 14. Tuning of SP switch buffer pools
Attributes Value Description
rpoolsize 1048576 The receive pool is a buffer pool for incoming data.
The size for values is in bytes.
spoolsize 1048576 The send pool is a buffer for outgoing data. The size
for values is in bytes.

The buffer pool settings can be changed by using the hgcss command. After the
changes are made, restart the node.

Chapter 9. Reference information 163


164 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Appendix A. Tivoli support information
You can find support information for Tivoli and other IBM products from various
sources.

From the IBM Support Portal at http://www.ibm.com/support/entry/portal/, you


can select the products that you are interested in and search for a wide variety of
relevant information.

Communities and other learning resources


In addition to product documentation, many forms of assistance are available to
help you get started as you deploy and use the Tivoli Storage Manager family of
products. These resources can also help you to solve problems that you might
have.

You can use forums, wikis, and other social media tools to ask questions, talk to
experts, and learn from others.

User groups
Tivoli Global Storage Virtual User Group
Access this user group at http://www.tivoli-ug.org/storage.
This group makes it possible for individuals from many different industries
and types of organizations to share information and work directly with the
IBM product experts. Local chapters also exist where members meet in
person to share experiences and hear from guest speakers.
ADSM.ORG
Access this mailing list at http://adsm.org.
This independently managed Storage Management discussion forum
started when Tivoli Storage Manager was known as ADSTAR Distributed
Storage Manager (ADSM). The members of this forum have many years of
experience with Tivoli Storage Manager in almost every type of IT
environment.
To subscribe to the forum, send an email to [email protected]. The
body of the message must contain the following text: SUBSCRIBE ADSM-L
your_first_name your_family_name.

Tivoli Storage Manager community on Service Management


Connect

Access Service Management Connect at http://www.ibm.com/developerworks/


servicemanagement. In the Storage Management community of Service
Management Connect, you can connect with IBM in the following ways:
v Become involved with transparent development, an ongoing, open engagement
between users and IBM developers of Tivoli products. You can access early
designs, sprint demonstrations, product roadmaps, and prerelease code.
v Connect one-on-one with the experts to collaborate and network about Tivoli
and the Tivoli Storage Manager community.
v Read blogs to benefit from the expertise and experience of others.

© Copyright IBM Corp. 1995, 2014 165


v Use wikis and forums to collaborate with the broader user community.

Tivoli Storage Manager wiki on developerWorks®

Access this wiki at https://www.ibm.com/developerworks/servicemanagement/


sm/index.html.

Find the latest best practices, white papers, and links to videos and other
resources. When you log on, you can comment on content, or contribute your own
content.

Tivoli Support Technical Exchange

Find information about upcoming Tivoli Support Technical Exchange webcasts at


http://www.ibm.com/software/sysmgmt/products/support/supp_tech_exch.html.
Replays of previous webcasts are also available.

Learn from technical experts who share their knowledge and then answer your
questions. The sessions are designed to address specific technical issues and
provide in-depth but narrowly focused training.

Other social media sites


LinkedIn
You can join groups on LinkedIn, a social media site for professionals. For
example:
v Tivoli Storage Manager Professionals: http://www.linkedin.com/
groups/Tivoli-Storage-Manager-Professionals-54572
v TSM: http://www.linkedin.com/groups?gid=64540
Twitter
Follow @IBMStorage on Twitter to see the latest news about storage and
storage software from IBM.

Tivoli education resources

Use these education resources to help you increase your Tivoli Storage Manager
skills:
Tivoli Education and Certification website
View available education at http://www.ibm.com/software/tivoli/
education.
Use the Search for Training link to find local and online offerings of
instructor-led courses for Tivoli Storage Manager.
Education Assistant
Access resources at http://publib.boulder.ibm.com/infocenter/ieduasst/
tivv1r0/index.jsp.
Scroll to view the list of available training videos. Recorded product
demonstrations are also available on a YouTube channel.

166 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Searching knowledge bases
If a problem occurs while you are using one of the Tivoli Storage Manager family
of products, you can search several knowledge bases.

Begin by searching the IBM product documentation at http://www.ibm.com/


support/knowledgecenter/. You can enter words, phrases, or message numbers in
the Search field to find relevant topics.

Searching the Internet


If you cannot find an answer to your question in the IBM Knowledge Center,
search the Internet for the information that might help you resolve the problem.

To search multiple Internet resources, go to the IBM support website at


http://www.ibm.com/support/entry/portal/. You can search for information
without signing in.

Sign in using your IBM ID and password if you want to customize the site based
on your product usage and information needs. If you do not already have an IBM
ID and password, click Sign in at the top of the page and follow the instructions
to register.

From the support website, you can search various resources:


v IBM technotes.
v IBM downloads.
v IBM Redbooks® publications.
v IBM Authorized Program Analysis Reports (APARs). Select the product and click
Downloads to search the APAR list.

Using IBM Support Assistant


IBM Support Assistant is a complimentary software product that can help you with
problem determination. It is available for some Tivoli Storage Manager and Tivoli
Storage FlashCopy Manager products.

IBM Support Assistant helps you gather support information when you must open
a problem management record (PMR), which you can then use to track the
problem. The product-specific plug-in modules provide you with the following
resources:
v Support links
v Education links
v Ability to submit problem management reports

You can find more information and download the IBM Support Assistant web page
at http://www.ibm.com/software/support/isa.

You can also install the stand-alone IBM Support Assistant application on any
workstation. You can then enhance the application by installing product-specific
plug-in modules for the IBM products that you use. Find add-ons for specific
products at http://www.ibm.com/support/docview.wss?uid=swg27012689.

Appendix A. Tivoli support information 167


Finding product fixes
A product fix to resolve a software problem might be available from the IBM
software support website.

Procedure

Determine what fixes are available by checking the IBM software support website
at http://www.ibm.com/support/entry/portal/.
If you previously customized the site based on your product usage:
1. Click the link for the product, or a component for which you want to
find a fix.
2. Click Downloads, and then click Search for recommended fixes.
If you have not previously customized the site:
Click Downloads and search for the product.

Receiving notification of product fixes


You can receive notifications about fixes, flashes, upgrades, and other news about
IBM products.

Procedure
1. From the support page at http://www.ibm.com/support/entry/portal/, click
Sign in and sign in using your IBM ID and password. If you do not have an
ID and password, click register now and complete the registration process.
2. Click Manage all my subscriptions in the Notifications pane.
3. Click the Subscribe tab, and then click Tivoli.
4. Select the products for which you want to receive notifications and click
Continue.
5. Specify your notification preferences and click Submit.

Contacting IBM Software Support


You can contact IBM Software Support if you have an active IBM subscription and
support contract, and if you are authorized to submit problems to IBM.

Procedure
1. Ensure that you have completed the following prerequisites:
a. Set up a subscription and support contract.
b. Determine the business impact of the problem.
c. Describe the problem and gather background information.
2. Follow the instructions in “Submitting the problem to IBM Software Support”
on page 170.

168 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Setting up and managing support contracts
You can set up and manage your Tivoli support contracts by enrolling in IBM
Passport Advantage. The type of support contract that you need depends on the
type of product you have.

Procedure

Enroll in IBM Passport Advantage in one of the following ways:


v Online: Go to the Passport Advantage website at http://www.ibm.com/
software/lotus/passportadvantage/, click How to enroll, and follow the
instructions.
v By telephone: For critical, system-down, or high-severity issues, you can call
1-800-IBMSERV (1-800-426-7378) in the United States. For the telephone number
to call in your country, go to the IBM Software Support Handbook web page at
http://www14.software.ibm.com/webapp/set2/sas/f/handbook/home.html
and click Contacts.

Determining the business impact


When you report a problem to IBM, you are asked to supply a severity level.
Therefore, you must understand and assess the business impact of the problem
you are reporting.

Severity level Description


Severity 1 Critical business impact: You are unable to use the program,
resulting in a critical impact on operations. This condition
requires an immediate solution.
Severity 2 Significant business impact: The program is usable but is
severely limited.
Severity 3 Some business impact: The program is usable with less
significant features (not critical to operations) unavailable.
Severity 4 Minimal business impact: The problem causes little impact on
operations, or a reasonable circumvention to the problem has
been implemented.

Describing the problem and gathering background information


When explaining a problem to IBM, it is helpful to be as specific as possible.
Include all relevant background information so that IBM Software Support
specialists can help you solve the problem efficiently.

To save time, know the answers to these questions:


v What software versions were you running when the problem occurred?
v Do you have logs, traces, and messages that are related to the problem
symptoms? IBM Software Support is likely to ask for this information.
v Can the problem be re-created? If so, what steps led to the failure?
v Have any changes been made to the system? For example, hardware, operating
system, networking software, and so on.
v Are you using a workaround for this problem? If so, be prepared to explain it
when you report the problem.

Appendix A. Tivoli support information 169


Submitting the problem to IBM Software Support
You can submit the problem to IBM Software Support online or by telephone.
Online
Go to the IBM Software Support website at http://www.ibm.com/
support/entry/portal/Open_service_request/Software/
Software_support_(general). Sign in to access IBM Service Requests and
enter your information into the problem submission tool.
By telephone
For critical, system-down, or severity 1 issues, you can call 1-800-IBMSERV
(1-800-426-7378) in the United States. For the telephone number to call in
your country, go to the IBM Software Support Handbook web page at
http://www14.software.ibm.com/webapp/set2/sas/f/handbook/
home.html and click Contacts.

170 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Appendix B. Accessibility features for the Tivoli Storage
Manager product family
Accessibility features help users who have a disability, such as restricted mobility
or limited vision to use information technology products successfully.

Accessibility features

The IBM Tivoli Storage Manager family of products includes the following
accessibility features:
v Keyboard-only operation using standard operating-system conventions
v Interfaces that support assistive technology such as screen readers

The command-line interfaces of all products in the product family are accessible.

Tivoli Storage Manager Operations Center provides the following additional


accessibility features when you use it with a Mozilla Firefox browser on a
Microsoft Windows system:
v Screen magnifiers and content zooming
v High contrast mode

The Operations Center and the Tivoli Storage Manager Server can be installed in
console mode, which is accessible.

The IBM Knowledge Center is enabled for accessibility. Read about the accessibility
features online at http://www.ibm.com/support/knowledgecenter/doc/
kc_help.html#accessibility.

Vendor software

The Tivoli Storage Manager product family includes certain vendor software that is
not covered under the IBM license agreement. IBM makes no representation about
the accessibility features of these products. Contact the vendor for the accessibility
information about its products.

IBM and accessibility

See the IBM Human Ability and Accessibility Center (http://www.ibm.com/able)


for information about the commitment that IBM has to accessibility.

© Copyright IBM Corp. 1995, 2014 171


172 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Notices
This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing


IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,


contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:

Intellectual Property Licensing


Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.


Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM websites are provided for


convenience only and do not in any manner serve as an endorsement of those
websites. The materials at those websites are not part of the materials for this IBM
product and use of those websites is at your own risk.

© Copyright IBM Corp. 1995, 2014 173


IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who want to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758
U.S.A.

Such information may be available, subject to appropriate terms and conditions,


including in some cases, payment of a fee.

The licensed program described in this information and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.

Any performance data contained herein was determined in a controlled


environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of


those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

This information is for planning purposes only. The information herein is subject to
change before the products described become available.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which


illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample

174 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows: © (your company name) (year). Portions of
this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.
_enter the year or years_.

If you are viewing this information in softcopy, the photographs and color
illustrations may not appear.

Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “Copyright and
trademark information” at http://www.ibm.com/legal/copytrade.shtml.

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, other


countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other company, product, or service names might be trademarks or service marks


of others.

Privacy policy considerations


IBM Software products, including software as a service solutions, (“Software
Offerings”) may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings
can help enable you to collect personally identifiable information. If this Software
Offering uses cookies to collect personally identifiable information, specific
information about this offering’s use of cookies is set forth below.

This Software Offering does not use cookies or other technologies to collect
personally identifiable information.

If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies

Notices 175
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.

For more information about the use of various technologies, including cookies, for
these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details the
section entitled “Cookies, Web Beacons and Other Technologies” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.

176 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Glossary
This glossary provides terms and definitions for backup data. See also server storage,
Tivoli Storage Manager, Tivoli Storage FlashCopy storage pool, storage pool volume.
Manager, and associated products.
active file system
A file system to which space management
The following cross-references are used in this
has been added. With space management,
glossary:
tasks for an active file system include
v See refers you from a nonpreferred term to the automatic migration, reconciliation,
preferred term or from an abbreviation to the selective migration, and recall. See also
spelled-out form. inactive file system.
v See also refers you to a related or contrasting
active policy set
term.
The activated policy set that contains the
policy rules currently in use by all client
For other terms and definitions, see the IBM
nodes assigned to the policy domain. See
Terminology website at www.ibm.com/software/
also policy domain, policy set.
globalization/terminology.
active version
The most recent backup copy of a file
A stored. The active version of a file cannot
absolute mode be deleted until a backup process detects
In storage management, a backup that the user has either replaced the file
copy-group mode that specifies that a file with a newer version or has deleted the
is considered for incremental backup even file from the file server or workstation.
if the file has not changed since the last See also backup version, inactive version.
backup. See also mode, modified mode. activity log
access control list (ACL) A log that records normal activity
In computer security, a list associated messages that are generated by the server.
with an object that identifies all the These messages include information about
subjects that can access the object and server and client operations, such as the
their access rights. start time of sessions or device I/O errors.

access mode adaptive subfile backup


An attribute of a storage pool or a storage A type of backup that sends only changed
volume that specifies whether the server portions of a file to the server, instead of
can write to or read from the storage pool sending the entire file. Adaptive subfile
or storage volume. backup reduces network traffic and
increases the speed of the backup.
ACK See acknowledgment.
administrative client
acknowledgment (ACK) A program that runs on a file server,
The transmission of acknowledgment workstation, or mainframe that
characters as a positive response to a data administrators use to control and monitor
transmission. the server. See also backup-archive client.
ACL See access control list. administrative command schedule
activate A database record that describes the
To validate the contents of a policy set planned processing of an administrative
and then make it the active policy set. command during a specific time period.
See also central scheduler, client schedule,
active-data pool schedule.
A named set of storage pool volumes that
contain only active versions of client administrative privilege class
See privilege class.

© Copyright IBM Corp. 1995, 2014 177


administrative session node and a client schedule. An association
A period of time during which an identifies the name of a schedule, the
administrator user ID communicates with name of the policy domain to which the
a server to perform administrative tasks. schedule belongs, and the name of a
See also client node session, session. client node that performs scheduled
operations.
administrator
A person responsible for administrative audit To check for logical inconsistencies
tasks such as access authorization and between information that the server has
content management. Administrators can and the actual condition of the system.
also grant levels of authority to users. The storage manager can audit
information about items such as volumes,
agent node
libraries, and licenses. For example, when
A client node that has been granted proxy
a storage manager audits a volume, the
authority to perform operations on behalf
server checks for inconsistencies between
of another client node, which is the target
information about backed-up or archived
node.
files that are stored in the database and
aggregate the actual data that are associated with
An object, stored in one or more storage each backup version or archive copy in
pools, consisting of a group of logical files server storage.
that are packaged together. See also
authentication rule
logical file, physical file.
A specification that another user can use
aggregate data transfer rate to either restore or retrieve files from
A performance statistic that indicates the storage.
average number of bytes that were
authority
transferred per second while processing a
The right to access objects, resources, or
given operation.
functions. See also privilege class.
application client
authorization rule
A program that is installed on a system to
A specification that permits another user
protect an application. The server
to either restore or retrieve a user's files
provides backup services to an
from storage.
application client.
authorized user
archive
A user who has administrative authority
To copy programs, data, or files to
for the client on a workstation. This user
another storage media, usually for
changes passwords, performs open
long-term storage or security. See also
registrations, and deletes file spaces.
retrieve.
AutoFS
archive copy
See automounted file system.
A file or group of files that was archived
to server storage automatic detection
A feature that detects, reports, and
archive copy group
updates the serial number of a drive or
A policy object containing attributes that
library in the database when the path
control the generation, destination, and
from the local server is defined.
expiration of archived files. See also copy
group. automatic migration
The process that is used to automatically
archive-retention grace period
move files from a local file system to
The number of days that the storage
storage, based on options and settings
manager retains an archived file when the
that are chosen by a root user on a
server is unable to rebind the file to an
workstation. See also demand migration,
appropriate management class. See also
threshold migration.
bind.
automounted file system (AutoFS)
association
A file system that is managed by an
The defined relationship between a client

178 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
automounter daemon. The automounter
daemon monitors a specified directory
path, and automatically mounts the file
system to access data.

B
backup-archive client
A program that runs on a workstation or
file server and provides a means for users
to back up, archive, restore, and retrieve
files. See also administrative client.
backup copy group
A policy object containing attributes that
control the generation, destination, and
expiration of backup versions of files. A
backup copy group belongs to a
management class. See also copy group.
backup retention grace period
The number of days the storage manager
retains a backup version after the server
is unable to rebind the file to an
appropriate management class.
backup set
A portable, consolidated group of active
versions of backup files that are generated
for a backup-archive client.
backup set collection
A group of backup sets that are created at
the same time and which have the same
backup set name, volume names,
description, and device classes. The server
identifies each backup set in the collection
by its node name, backup set name, and
file type.
backup version
A file or directory that a client node
backed up to storage. More than one
backup version can exist in storage, but
only one backup version is the active
version. See also active version, copy
group, inactive version.
bind To associate a file with a management
class name. See also archive-retention
grace period, management class, rebind.

Glossary 179
the server and used on client nodes in
C conjunction with client options files.
cache To place a duplicate copy of a file on client options file
random access media when the server An editable file that identifies the server
migrates a file to another storage pool in and communication method, and
the hierarchy. provides the configuration for backup,
cache file archive, hierarchical storage management,
A snapshot of a logical volume created by and scheduling.
Logical Volume Snapshot Agent. Blocks client-polling scheduling mode
are saved immediately before they are A method of operation in which the client
modified during the image backup and queries the server for work. See also
their logical extents are saved in the cache server-prompted scheduling mode.
files.
client schedule
CAD See client acceptor daemon. A database record that describes the
central scheduler planned processing of a client operation
A function that permits an administrator during a specific time period. The client
to schedule client operations and operation can be a backup, archive,
administrative commands. The operations restore, or retrieve operation, a client
can be scheduled to occur periodically or operating system command, or a macro.
on a specific date. See also administrative See also administrative command
command schedule, client schedule. schedule, central scheduler, schedule.
client A software program or computer that client/server
requests services from a server. See also Pertaining to the model of interaction in
server. distributed data processing in which a
program on one computer sends a request
client acceptor to a program on another computer and
A service that serves the Java applet for awaits a response. The requesting
the web client to web browsers. On program is called a client; the answering
Windows systems, the client acceptor is program is called a server.
installed and run as a service. On AIX,
UNIX, and Linux systems, the client client system-options file
acceptor is run as a daemon. A file, used on AIX, UNIX, or Linux
system clients, containing a set of
client acceptor daemon (CAD) processing options that identify the
See client acceptor. servers to be contacted for services. This
client domain file also specifies communication methods
The set of drives, file systems, or volumes and options for backup, archive,
that the user selects to back up or archive hierarchical storage management, and
data, using the backup-archive client. scheduling. See also client user-options
file, options file.
client node
A file server or workstation on which the client user-options file
backup-archive client program has been A file that contains the set of processing
installed, and which has been registered options that the clients on the system use.
to the server. The set can include options that
determine the server that the client
client node session contacts, and options that affect backup
A session in which a client node operations, archive operations,
communicates with a server to perform hierarchical storage management
backup, restore, archive, retrieve, migrate, operations, and scheduled operations.
or recall requests. See also administrative This file is also called the dsm.opt file.
session. For AIX, UNIX, or Linux systems, see also
client option set client system-options file. See also client
A group of options that are defined on system-options file, options file.

180 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
closed registration copy backup
A registration process in which only an A full backup in which the transaction log
administrator can register workstations as files are not deleted so that backup
client nodes with the server. See also open procedures that use incremental or
registration. differential backups are not disrupted.
collocation copy group
The process of keeping all data belonging A policy object containing attributes that
to a single-client file space, a single client control how backup versions or archive
node, or a group of client nodes on a copies are generated, where backup
minimal number of sequential-access versions or archive copies are initially
volumes within a storage pool. located, and when backup versions or
Collocation can reduce the number of archive copies expire. A copy group
volumes that must be accessed when a belongs to a management class. See also
large amount of data must be restored. archive copy group, backup copy group,
backup version,management class.
collocation group
A user-defined group of client nodes copy storage pool
whose data is stored on a minimal A named set of volumes that contain
number of volumes through the process copies of files that reside in primary
of collocation. storage pools. Copy storage pools are
used only to back up the data that is
commit point
stored in primary storage pools. A copy
A point in time when data is considered
storage pool cannot be a destination for a
to be consistent.
backup copy group, an archive copy
communication method group, or a management class (for
The method by which a client and server space-managed files). See also destination,
exchange information. See also primary storage pool, server storage,
Transmission Control Protocol/Internet storage pool, storage pool volume.
Protocol.
communication protocol D
A set of defined interfaces that permit
computers to communicate with each daemon
other. A program that runs unattended to
perform continuous or periodic functions,
compression such as network control.
A function that removes repetitive
characters, spaces, strings of characters, or damaged file
binary data from the data being processed A physical file in which read errors have
and replaces characters with control been detected.
characters. Compression reduces the database backup series
amount of storage space that is required One full backup of the database, plus up
for data. to 32 incremental backups made since
configuration manager that full backup. Each full backup that is
A server that distributes configuration run starts a new database backup series.
information, such as policies and A number identifies each backup series.
schedules, to managed servers according See also database snapshot, full backup.
to their profiles. Configuration database snapshot
information can include policy and A complete backup of the entire database
schedules. See also enterprise to media that can be taken off-site. When
configuration, managed server, profile. a database snapshot is created, the current
conversation database backup series is not interrupted.
A connection between two programs over A database snapshot cannot have
a session that allows them to incremental database backups associated
communicate with each other while with it. See also database backup series,
processing a transaction. See also session. full backup.

Glossary 181
data center out-of-space condition on a file system for
In a virtualized environment, a container which hierarchical storage management
that holds hosts, clusters, networks, and (HSM) is active. Files are migrated to
data stores. server storage until space usage drops to
the low threshold that was set for the file
data deduplication
system. If the high threshold and low
A method of reducing storage needs by
threshold are the same, one file is
eliminating redundant data. Only one
migrated. See also automatic migration,
instance of the data is retained on storage
selective migration, threshold migration.
media. Other instances of the same data
are replaced with a pointer to the retained desktop client
instance. The group of backup-archive clients that
includes clients on Microsoft Windows,
data manager server
Apple, and Novell NetWare operating
A server that collects metadata
systems.
information for client inventory and
manages transactions for the storage destination
agent over the local area network. The A copy group or management class
data manager server informs the storage attribute that specifies the primary storage
agent with applicable library attributes pool to which a client file will be backed
and the target volume identifier. up, archived, or migrated. See also copy
storage pool.
data mover
A device that moves data on behalf of the device class
server. A network-attached storage (NAS) A named set of characteristics that are
file server is a data mover. applied to a group of storage devices.
Each device class has a unique name and
data storage-management application-
represents a device type of disk, file,
programming interface (DSMAPI)
optical disk, or tape.
A set of functions and semantics that can
monitor events on files, and manage and device configuration file
maintain the data in a file. In an HSM 1. For a storage agent, a file that contains
environment, a DSMAPI uses events to the name and password of the storage
notify data management applications agent, and information about the
about operations on files, stores arbitrary server that is managing the
attribute information with a file, supports SAN-attached libraries and drives that
managed regions in a file, and uses the storage agent uses.
DSMAPI access rights to control access to
2. For a server, a file that contains
a file object.
information about defined device
data store classes, and, on some servers, defined
In a virtualized environment, the location libraries and drives. The information
where virtual machine data is stored. is a copy of the device configuration
information in the database.
deduplication
The process of creating representative disaster recovery manager (DRM)
records from a set of records that have A function that assists in preparing and
been identified as representing the same using a disaster recovery plan file for the
entities. server.
default management class disaster recovery plan
A management class that is assigned to a A file that is created by the disaster
policy set. This class is used to govern recover manager (DRM) that contains
backed up or archived files when a file is information about how to recover
not explicitly associated with a specific computer systems if a disaster occurs and
management class through the scripts that can be run to perform some
include-exclude list. recovery tasks. The file includes
information about the software and
demand migration
The process that is used to respond to an

182 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
hardware that is used by the server, and failure of an operation, a user action, or
the location of recovery media. the change in state of a process. See also
enterprise logging, receiver.
domain
A grouping of client nodes with one or event record
more policy sets, which manage data or A database record that describes actual
storage resources for the client nodes. See status and results for events.
also policy domain.
event server
DRM See disaster recovery manager. A server to which other servers can send
events for logging. The event server
DSMAPI
routes the events to any receivers that are
See data storage-management
enabled for the sending server's events.
application-programming interface.
exabyte (EB)
dynamic serialization
For processor, real and virtual storage
Copy serialization in which a file or
capacities and channel volume, 2 to the
folder is backed up or archived on the
power of 60 or 1 152 921 504 606 846 976
first attempt regardless of whether it
bytes. For disk storage capacity and
changes during a backup or archive. See
communications volume, 1 000 000 000
also shared dynamic serialization, shared
000 000 000 bytes.
static serialization, static serialization.
exclude
The process of identifying files in an
E include-exclude list. This process prevents
EA See extended attribute. the files from being backed up or
migrated whenever a user or schedule
EB See exabyte. enters an incremental or selective backup
EFS See Encrypted File System. operation. A file can be excluded from
backup, from space management, or from
Encrypted File System (EFS) both backup and space management.
A file system that uses file system-level
encryption. exclude-include list
See include-exclude list.
enterprise configuration
A method of setting up servers so that the expiration
administrator can distribute the The process by which files, data sets, or
configuration of one of the servers to the objects are identified for deletion because
other servers, using server-to-server their expiration date or retention period
communication. See also configuration has passed.
manager, managed server, profile, expiring file
subscription. A migrated or premigrated file that has
enterprise logging been marked for expiration and removal
The process of sending events from a from storage. If a stub file or an original
server to a designated event server. The copy of a premigrated file is deleted from
event server routes the events to a local file system, or if the original copy
designated receivers, such as to a user of a premigrated file is updated, the
exit. See also event. corresponding migrated or premigrated
file is marked for expiration the next time
error log reconciliation is run.
A data set or file that is used to record
error information about a product or extend
system. To increase the portion of available space
that can be used to store database or
estimated capacity recovery log information.
The available space, in megabytes, of a
storage pool. extended attribute (EA)
Names or value pairs that are associated
event An occurrence of significance to a task or with files or directories. There are three
system. Events can include completion or

Glossary 183
classes of extended attributes: user management support that is required. If
attributes, system attributes, and trusted no space management support is
attributes. required, the operation is passed to the
operating system, which performs its
external library
normal functions. The file system
A collection of drives that is managed by
migrator is mounted over a file system
the media-management system other than
when space management is added to the
the storage management server.
file system.
file system state
F The storage management mode of a file
file access time system that resides on a workstation on
On AIX, UNIX, or Linux systems, the which the hierarchical storage
time when the file was last accessed. management (HSM) client is installed. A
file system can be in one of these states:
file age native, active, inactive, or global inactive.
For migration prioritization purposes, the
number of days since a file was last frequency
accessed. A copy group attribute that specifies the
minimum interval, in days, between
file device type incremental backups.
A device type that specifies the use of
sequential access files on disk storage as FSID See file space ID.
volumes. FSM See file system migrator.
file server full backup
A dedicated computer and its peripheral The process of backing up the entire
storage devices that are connected to a server database. A full backup begins a
local area network that stores programs new database backup series. See also
and files that are shared by users on the database backup series, database
network. snapshot, incremental backup.
file space fuzzy backup
A logical space in server storage that A backup version of a file that might not
contains a group of files that have been accurately reflect what is currently in the
backed up or archived by a client node, file because the file was backed up at the
from a single logical partition, file system, same time as it was being modified.
or virtual mount point. Client nodes can
restore, retrieve, or delete their file spaces fuzzy copy
from server storage. In server storage, A backup version or archive copy of a file
files belonging to a single file space are that might not accurately reflect the
not necessarily stored together. original contents of the file because it was
backed up or archived the file while the
file space ID (FSID) file was being modified.
A unique numeric identifier that the
server assigns to a file space when it is
stored in server storage. G
file state GB See gigabyte.
The space management mode of a file
General Parallel File System (GPFS™)
that resides in a file system to which
A high-performance shared-disk file
space management has been added. A file
system that can provide data access from
can be in one of three states: resident,
nodes in a clustered system environment.
premigrated, or migrated. See also
See also information lifecycle
migrated file, premigrated file, resident
management.
file.
gigabyte (GB)
file system migrator (FSM)
For processor storage, real and virtual
A kernel extension that intercepts all file
storage, and channel volume, 10 to the
system operations and provides any space

184 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
power of nine or 1,073,741,824 bytes. For
disk storage capacity and communications
volume, 1,000,000,000 bytes.
global inactive state
The state of all file systems to which
space management has been added when
space management is globally deactivated
for a client node.
Globally Unique Identifier (GUID)
An algorithmically determined number
that uniquely identifies an entity within a
system. See also Universally Unique
Identifier.
GPFS See General Parallel File System.
GPFS node set
A mounted, defined group of GPFS file
systems.
group backup
The backup of a group containing a list of
files from one or more file space origins.
GUID See Globally Unique Identifier.

H
hierarchical storage management (HSM)
A function that automatically distributes
and manages data on disk, tape, or both
by regarding devices of these types and
potentially others as levels in a storage
hierarchy that range from fast, expensive
devices to slower, cheaper, and possibly
removable devices. The objectives are to
minimize access time to data and
maximize available media capacity. See
also hierarchical storage management
client, recall, storage hierarchy.
hierarchical storage management client (HSM
client) A client program that works with the
server to provide hierarchical storage
management (HSM) for a system. See also
hierarchical storage management,
management class.
HSM See hierarchical storage management.
HSM client
See hierarchical storage management
client.

Glossary 185
systems. An inode contains the node,
I type, owner, and location of a file.
ILM See information lifecycle management. inode number
image A file system or raw logical volume that A number specifying a particular inode
is backed up as a single object. file in the file system.
image backup IP address
A backup of a full file system or raw A unique address for a device or logical
logical volume as a single object. unit on a network that uses the Internet
Protocol standard.
inactive file system
A file system for which space
management has been deactivated. See J
also active file system.
job file
inactive version A generated file that contains
A backup version of a file that is either configuration information for a migration
not the most recent backup version, or job. The file is XML format and can be
that is a backup version of a file that no created and edited in the hierarchical
longer exists on the client system. Inactive storage management (HSM) client for
backup versions are eligible for expiration Windows client graphical user interface.
processing according to the management See also migration job.
class assigned to the file. See also active
journal-based backup
version, backup version.
A method for backing up Windows clients
include-exclude file and AIX clients that exploits the change
A file containing statements to determine notification mechanism in a file to
the files to back up and the associated improve incremental backup performance
management classes to use for backup or by reducing the need to fully scan the file
archive. See also include-exclude list. system.
include-exclude list journal daemon
A list of options that include or exclude On AIX, UNIX, or Linux systems, a
selected files for backup. An exclude program that tracks change activity for
option identifies files that should not be files residing in file systems.
backed up. An include option identifies
journal service
files that are exempt from the exclusion
In Microsoft Windows, a program that
rules or assigns a management class to a
tracks change activity for files residing in
file or a group of files for backup or
file systems.
archive services. See also include-exclude
file.
incremental backup
K
The process of backing up files or KB See kilobyte.
directories, or copying pages in the
database, that are new or changed since kilobyte (KB)
the last full or incremental backup. See For processor storage, real and virtual
also selective backup. storage, and channel volume, 2 to the
power of 10 or 1,024 bytes. For disk
individual mailbox restore storage capacity and communications
See mailbox restore. volume, 1,000 bytes.
information lifecycle management (ILM)
A policy-based file-management system
for storage pools and file sets. See also
General Parallel File System.
inode The internal structure that describes the
individual files on AIX, UNIX, or Linux

186 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
local shadow volume
L Data that is stored on shadow volumes
LAN See local area network. localized to a disk storage subsystem.
LAN-free data movement LOFS See loopback virtual file system.
The movement of client data between a logical file
client system and a storage device on a A file that is stored in one or more server
storage area network (SAN), bypassing storage pools, either by itself or as part of
the local area network. an aggregate. See also aggregate, physical
LAN-free data transfer file, physical occupancy.
See LAN-free data movement. logical occupancy
leader data The space that is used by logical files in a
Bytes of data, from the beginning of a storage pool. This space does not include
migrated file, that are stored in the file's the unused space created when logical
corresponding stub file on the local file files are deleted from aggregate files, so it
system. The amount of leader data that is might be less than the physical
stored in a stub file depends on the stub occupancy. See also physical occupancy.
size that is specified. logical unit number (LUN)
library In the Small Computer System Interface
1. A repository for demountable (SCSI) standard, a unique identifier used
recorded media, such as magnetic to differentiate devices, each of which is a
disks and magnetic tapes. logical unit (LU).
2. A collection of one or more drives, logical volume
and possibly robotic devices A portion of a physical volume that
(depending on the library type), which contains a file system.
can be used to access storage volumes. logical volume backup
library client A back up of a file system or logical
A server that uses server-to-server volume as a single object.
communication to access a library that is Logical Volume Snapshot Agent (LVSA)
managed by another storage management Software that can act as the snapshot
server. See also library manager. provider for creating a snapshot of a
library manager logical volume during an online image
A server that controls device operations backup.
when multiple storage management loopback virtual file system (LOFS)
servers share a storage device. See also A file system that is created by mounting
library client. a directory over another local directory,
local also known as mount-over-mount. A
1. Pertaining to a device, file, or system LOFS can also be generated using an
that is accessed directly from a user automounter.
system, without the use of a LUN See logical unit number.
communication line. See also remote.
LVSA See Logical Volume Snapshot Agent.
2. For hierarchical storage management
products, pertaining to the destination
of migrated files that are being
moved. See also remote.
local area network (LAN)
A network that connects several devices
in a limited area (such as a single
building or campus) and that can be
connected to a larger network.

Glossary 187
storage for Tivoli Storage Manager servers
M that run on operating systems other than
macro file z/OS.
A file that contains one or more storage megabyte (MB)
manager administrative commands, For processor storage, real and virtual
which can be run only from an storage, and channel volume, 2 to the
administrative client using the MACRO 20th power or 1,048,576 bytes. For disk
command. See also Tivoli Storage storage capacity and communications
Manager command script. volume, 1,000,000 bytes.
mailbox restore metadata
A function that restores Microsoft Data that describes the characteristics of
Exchange Server data (from IBM Data data; descriptive data.
Protection for Microsoft Exchange
backups) at the mailbox level or migrate
mailbox-item level. To move data to another location, or an
application to another computer system.
managed object
A definition in the database of a managed migrated file
server that was distributed to the A file that has been copied from a local
managed server by a configuration file system to storage. For HSM clients on
manager. When a managed server UNIX or Linux systems, the file is
subscribes to a profile, all objects that are replaced with a stub file on the local file
associated with that profile become system. On Windows systems, creation of
managed objects in the database of the the stub file is optional. See also file state,
managed server. premigrated file, resident file, stub file.

managed server migration


A server that receives configuration The process of moving data from one
information from a configuration manager computer system to another, or an
using a subscription to one or more application to another computer system.
profiles. Configuration information can migration job
include definitions of objects such as A specification of files to migrate, and
policy and schedules. See also actions to perform on the original files
configuration manager, enterprise after migration. See also job file, threshold
configuration, profile, subscription. migration.
management class migration threshold
A policy object that users can bind to each High and low capacities for storage pools
file to specify how the server manages the or file systems, expressed as percentages,
file. The management class can contain a at which migration is set to start and
backup copy group, an archive copy stop.
group, and space management attributes.
See also bind, copy group, hierarchical mirroring
storage management client, policy set, The process of writing the same data to
rebind. multiple disks at the same time. The
mirroring of data protects it against data
maximum transmission unit (MTU) loss within the database or within the
The largest possible unit of data that can recovery log.
be sent on a given physical medium in a
single frame. For example, the maximum mode A copy group attribute that specifies
transmission unit for Ethernet is 1500 whether to back up a file that has not
bytes. been modified since the last time the file
was backed up. See also absolute mode,
MB See megabyte. modified mode.
media server modified mode
In a z/OS® environment, a program that In storage management, a backup
provides access to z/OS disk and tape copy-group mode that specifies that a file

188 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
is considered for incremental backup only storage (NAS) file server. Data for the
if it has changed since the last backup. A NAS node is transferred by a NAS file
file is considered a changed file if the server that is controlled by the network
date, size, owner, or permissions of the data management protocol (NDMP). A
file have changed. See also absolute NAS node is also called a NAS file server
mode, mode. node.
mount limit native file system
The maximum number of volumes that A file system that is locally added to the
can be simultaneously accessed from the file server and is not added for space
same device class. The mount limit management. The hierarchical storage
determines the maximum number of manager (HSM) client does not provide
mount points. See also mount point. space management services to the file
system.
mount point
A logical drive through which volumes native format
are accessed in a sequential access device A format of data that is written to a
class. For removable media device types, storage pool directly by the server. See
such as tape, a mount point is a logical also non-native data format.
drive associated with a physical drive. For
NDMP
the file device type, a mount point is a
See Network Data Management Protocol.
logical drive associated with an I/O
stream. See also mount limit. NetBIOS (Network Basic Input/Output System)
A standard interface to networks and
mount retention period
personal computers that is used on local
The maximum number of minutes that
area networks to provide message,
the server retains a mounted
print-server, and file-server functions.
sequential-access media volume that is
Application programs that use NetBIOS
not being used before it dismounts the
do not have to handle the details of LAN
sequential-access media volume.
data link control (DLC) protocols.
mount wait period
network-attached storage file server (NAS file
The maximum number of minutes that
server)
the server waits for a sequential-access
A dedicated storage device with an
volume mount request to be satisfied
operating system that is optimized for
before canceling the request.
file-serving functions. A NAS file server
MTU See maximum transmission unit. can have the characteristics of both a
node and a data mover.
N Network Basic Input/Output System
See NetBIOS.
Nagle algorithm
An algorithm that reduces congestion of Network Data Management Protocol (NDMP)
TCP/IP networks by combining smaller A protocol that allows a network
packets and sending them together. storage-management application to
control the backup and recovery of an
named pipe NDMP-compliant file server, without
A type of interprocess communication installing vendor-acquired software on
that permits message data streams to pass that file server.
between peer processes, such as between
a client and a server. network data-transfer rate
A rate that is calculated by dividing the
NAS file server total number of bytes that are transferred
See network-attached storage file server. by the data transfer time. For example,
NAS file server node this rate can be the time that is spent
See NAS node. transferring data over a network.
NAS node node A file server or workstation on which the
A client node that is a network-attached

Glossary 189
backup-archive client program has been contacting for space management services.
installed, and which has been registered For example, a stub file can be orphaned
to the server. when the client system-options file is
modified to contact a server that is
node name
different than the one to which the file
A unique name that is used to identify a
was migrated.
workstation, file server, or PC to the
server.
node privilege class
P
A privilege class that gives an packet In data communication, a sequence of
administrator the authority to remotely binary digits, including data and control
access backup-archive clients for a specific signals, that are transmitted and switched
client node or for all clients in a policy as a composite whole.
domain. See also privilege class.
page A defined unit of space on a storage
non-native data format medium or within a database volume.
A format of data that is written to a
storage pool that differs from the format partial-file recall mode
that the server uses for operations. See A recall mode that causes the hierarchical
also native format. storage management (HSM) function to
read just a portion of a migrated file from
storage, as requested by the application
O accessing the file.
offline volume backup password generation
A backup in which the volume is locked A process that creates and stores a new
so that no other system applications can password in an encrypted password file
access it during the backup operation. when the old password expires.
Automatic generation of a password
online volume backup
prevents password prompting.
A backup in which the volume is
available to other system applications path An object that defines a one-to-one
during the backup operation. relationship between a source and a
destination. Using the path, the source
open registration
accesses the destination. Data can flow
A registration process in which users can
from the source to the destination, and
register their workstations as client nodes
back. An example of a source is a data
with the server. See also closed
mover (such as a network-attached
registration.
storage [NAS] file server), and an
operator privilege class example of a destination is a tape drive.
A privilege class that gives an
pattern-matching character
administrator the authority to disable or
See wildcard character.
halt the server, enable the server, cancel
server processes, and manage removable physical file
media. See also privilege class. A file that is stored in one or more
storage pools, consisting of either a single
options file
logical file, or a group of logical files that
A file that contains processing options.
are packaged together as an aggregate.
See also client system-options file, client
See also aggregate, logical file, physical
user-options file.
occupancy.
originating file system
physical occupancy
The file system from which a file was
The amount of space that is used by
migrated. When a file is recalled, it is
physical files in a storage pool. This space
returned to its originating file system.
includes the unused space that is created
orphaned stub file when logical files are deleted from
A file for which no migrated file can be aggregates. See also logical file, logical
found on the server that the client node is occupancy, physical file.

190 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
plug-in primary storage pool
A separately installable software module A named set of volumes that the server
that adds function to an existing program, uses to store backup versions of files,
application, or interface. archive copies of files, and files migrated
from client nodes. See also copy storage
policy domain
pool, server storage, storage pool, storage
A grouping of policy users with one or
pool volume.
more policy sets, which manage data or
storage resources for the users. The users privilege class
are client nodes that are associated with A level of authority that is granted to an
the policy domain. See also active policy administrator. The privilege class
set, domain. determines which administrative tasks the
administrator can perform. See also
policy privilege class
authority, node privilege class, operator
A privilege class that gives an
privilege class, policy privilege class,
administrator the authority to manage
storage privilege class, system privilege
policy objects, register client nodes, and
class.
schedule client operations for client
nodes. Authority can be restricted to profile
certain policy domains. See also privilege A named group of configuration
class. information that can be distributed from a
configuration manager when a managed
policy set
server subscribes. Configuration
A group of rules in a policy domain. The
information can include registered
rules specify how data or storage
administrator IDs, policies, client
resources are automatically managed for
schedules, client option sets,
client nodes in the policy domain. Rules
administrative schedules, storage manager
can be contained in management classes.
command scripts, server definitions, and
See also active policy set, management
server group definitions. See also
class.
configuration manager, enterprise
premigrated file configuration, managed server.
A file that has been copied to server
profile association
storage, but has not been replaced with a
On a configuration manager, the defined
stub file on the local file system. An
relationship between a profile and an
identical copy of the file resides both on
object such as a policy domain. Profile
the local file system and in server storage.
associations define the configuration
Premigrated files occur on UNIX and
information that is distributed to a
Linux file systems to which space
managed server when it subscribes to the
management has been added. See also file
profile.
state, migrated file, resident file.
premigrated files database
A database that contains information
Q
about each file that has been premigrated quota
to server storage. 1. For HSM on AIX, UNIX, or Linux
premigration systems, the limit (in megabytes) on
The process of copying files that are the amount of data that can be
eligible for migration to server storage, migrated and premigrated from a file
but leaving the original file intact on the system to server storage.
local file system. 2. For HSM on Windows systems, a
premigration percentage user-defined limit to the space that is
A space management setting that controls occupied by recalled files.
whether the next eligible candidates in a
file system are premigrated following
threshold or demand migration.

Glossary 191
During the reconciliation process, data
R that is identified as no longer needed is
randomization removed.
The process of distributing schedule start recovery log
times for different clients within a A log of updates that are about to be
specified percentage of the schedule's written to the database. The log can be
startup window. used to recover from system and media
raw logical volume failures. The recovery log consists of the
A portion of a physical volume that is active log (including the log mirror) and
comprised of unallocated blocks and has archive logs.
no journaled file system (JFS) definition. register
A logical volume is read/write accessible To define a client node or administrator
only through low-level I/O functions. ID that can access the server.
rebind registry
To associate all backed-up versions of a A repository that contains access and
file with a new management class name. configuration information for users,
For example, a file that has an active systems, and software.
backup version is rebound when a later
version of the file is backed up with a remote
different management class association. For hierarchical storage management
See also bind, management class. products, pertaining to the origin of
migrated files that are being moved. See
recall To copy a migrated file from server also local.
storage back to its originating file system
using the hierarchical storage resident file
management client. See also selective On a Windows system, a complete file on
recall. a local file system that might also be a
migrated file because a migrated copy can
receiver exist in server storage. On a UNIX or
A server repository that contains a log of Linux system, a complete file on a local
server and client messages as events. For file system that has not been migrated or
example, a receiver can be a file exit, a premigrated, or that has been recalled
user exit, or the server console and from server storage and modified. See
activity log. See also event. also file state.
reclamation restore
The process of consolidating the To copy information from its backup
remaining data from many location to the active storage location for
sequential-access volumes onto fewer, use. For example, to copy information
new sequential-access volumes. from server storage to a client
reclamation threshold workstation.
The percentage of space that a retention
sequential-access media volume must The amount of time, in days, that inactive
have before the server can reclaim the backed-up or archived files are kept in the
volume. Space becomes reclaimable when storage pool before they are deleted.
files are expired or are deleted. Copy group attributes and default
reconciliation retention grace periods for the domain
The process of ensuring consistency define retention.
between the original data repository and retrieve
the larger system where the data is stored To copy archived information from the
for backup. Examples of larger systems storage pool to the workstation for use.
where the data is stored for backup are The retrieve operation does not affect the
storage servers or other storage systems. archive version in the storage pool. See
also archive.

192 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
root user selective recall
A system user who operates without The process of copying user-selected files
restrictions. A root user has the special from server storage to a local file system.
rights and privileges needed to perform See also recall, transparent recall.
administrative tasks.
serialization
The process of handling files that are
S modified during backup or archive
processing. See also shared dynamic
SAN See storage area network. serialization, shared static serialization,
schedule static serialization.
A database record that describes client server A software program or a computer that
operations or administrative commands to provides services to other software
be processed. See also administrative programs or other computers. See also
command schedule, client schedule. client.
scheduling mode server options file
The type of scheduling operation for the A file that contains settings that control
server and client node that supports two various server operations. These settings
scheduling modes: client-polling and affect such things as communications,
server-prompted. devices, and performance.
scratch volume server-prompted scheduling mode
A labeled volume that is either blank or A client/server communication technique
contains no valid data, that is not defined, where the server contacts the client node
and that is available for use. See also when tasks must be done. See also
volume. client-polling scheduling mode.
script A series of commands, combined in a file, server storage
that carry out a particular function when The primary, copy, and active-data storage
the file is run. Scripts are interpreted as pools that are used by the server to store
they are run. See also Tivoli Storage user files such as backup versions, archive
Manager command script. copies, and files migrated from
Secure Sockets Layer (SSL) hierarchical storage management client
A security protocol that provides nodes (space-managed files). See also
communication privacy. With SSL, active-data pool, copy storage pool,
client/server applications can primary storage pool, storage pool
communicate in a way that is designed to volume, volume.
prevent eavesdropping, tampering, and session
message forgery. A logical or virtual connection between
selective backup two stations, software programs, or
The process of backing up certain files or devices on a network that allows the two
directories from a client domain. The files elements to communicate and exchange
that are backed up are those that are not data for the duration of the session. See
excluded in the include-exclude list. The also administrative session.
files must meet the requirement for session resource usage
serialization in the backup copy group of The amount of wait time, processor time,
the management class that is assigned to and space that is used or retrieved during
each file. See also incremental backup. a client session.
selective migration shadow copy
The process of copying user-selected files A snapshot of a volume. The snapshot
from a local file system to server storage can be taken while applications on the
and replacing the files with stub files on system continue to write data to the
the local file system. See also demand volumes.
migration, threshold migration.

Glossary 193
shadow volume special file
The data stored from a snapshot of a On AIX, UNIX, or Linux systems, a file
volume. The snapshot can be taken while that defines devices for the system, or
applications on the system continue to temporary files that are created by
write data to the volumes. processes. There are three basic types of
special files: first-in, first-out (FIFO);
shared dynamic serialization
block; and character.
A value for serialization that specifies that
a file must not be backed up or archived SSL See Secure Sockets Layer.
if it is being modified during the
stabilized file space
operation. The backup-archive client
A file space that exists on the server but
retries the backup or archive operation a
not on the client.
number of times; if the file is being
modified during each attempt, the stanza A group of lines in a file that together
backup-archive client will back up or have a common function or define a part
archive the file on its last try. See also of the system. Stanzas are usually
dynamic serialization, serialization, shared separated by blank lines or colons, and
static serialization, static serialization. each stanza has a name.
shared library startup window
A library device that is used by multiple A time period during which a schedule
storage manager servers. See also library. must be initiated.
shared static serialization static serialization
A copy-group serialization value that A copy-group serialization value that
specifies that a file must not be modified specifies that a file must not be modified
during a backup or archive operation. The during a backup or archive operation. If
client attempts to retry the operation a the file is in use during the first attempt,
number of times. If the file is in use the backup-archive client cannot back up
during each attempt, the file is not backed or archive the file. See also dynamic
up or archived. See also dynamic serialization, serialization, shared dynamic
serialization, serialization, shared dynamic serialization, shared static serialization.
serialization, static serialization.
storage agent
snapshot A program that enables the backup and
An image backup type that consists of a restoration of client data directly to and
point-in-time view of a volume. from storage attached to a storage area
network (SAN).
space-managed file
A file that is migrated from a client node storage area network (SAN)
by the hierarchical storage management A dedicated storage network tailored to a
(HSM) client. The HSM client recalls the specific environment, combining servers,
file to the client node on demand. systems, storage products, networking
products, software, and services.
space management
See hierarchical storage management. storage hierarchy
A logical order of primary storage pools,
space monitor daemon
as defined by an administrator. The order
A daemon that checks space usage on all
is typically based on the speed and
file systems for which space management
capacity of the devices that the storage
is active, and automatically starts
pools use. The storage hierarchy is
threshold migration when space usage on
defined by identifying the next storage
a file system equals or exceeds its high
pool in a storage pool definition. See also
threshold.
storage pool.
sparse file
storage pool
A file that is created with a length greater
A named set of storage volumes that is
than the data it contains, leaving empty
the destination that is used to store client
spaces for the future addition of data.

194 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
data. See also active-data pool, copy
storage pool, primary storage pool,
storage hierarchy.
storage pool volume
A volume that has been assigned to a
storage pool. See also active-data pool,
copy storage pool, primary storage pool,
server storage, volume.
storage privilege class
A privilege class that gives an
administrator the authority to control how
storage resources for the server are
allocated and used, such as monitoring
the database, the recovery log, and server
storage. See also privilege class.
stub A shortcut on the Windows file system
that is generated by the hierarchical
storage management (HSM) client for a
migrated file that allows transparent user
access. A stub is the sparse file
representation of a migrated file, with a
reparse point attached.
stub file
A file that replaces the original file on a
local file system when the file is migrated
to storage. A stub file contains the
information that is necessary to recall a
migrated file from server storage. It also
contains additional information that can
be used to eliminate the need to recall a
migrated file. See also migrated file,
resident file.
stub file size
The size of a file that replaces the original
file on a local file system when the file is
migrated to server storage. The size that
is specified for stub files determines how
much leader data can be stored in the
stub file. The default for stub file size is
the block size defined for a file system
minus 1 byte.
subscription
In a storage environment, the process of
identifying the subscribers to which the
profiles are distributed. See also
enterprise configuration, managed server.
system privilege class
A privilege class that gives an
administrator the authority to issue all
server commands. See also privilege class.

Glossary 195
tombstone object
T A small subset of attributes of a deleted
tape library object. The tombstone object is retained
A set of equipment and facilities that for a specified period, and at the end of
support an installation's tape the specified period, the tombstone object
environment. The tape library can include is permanently deleted.
tape storage racks, mechanisms for Transmission Control Protocol/Internet Protocol
automatic tape mounting, a set of tape (TCP/IP)
drives, and a set of related tape volumes An industry-standard, nonproprietary set
mounted on those drives. of communication protocols that provides
tape volume prefix reliable end-to-end connections between
The high-level-qualifier of the file name applications over interconnected networks
or the data set name in the standard tape of different types. See also communication
label. method.
target node transparent recall
A client node for which other client nodes The process that is used to automatically
(called agent nodes) have been granted recall a migrated file to a workstation or
proxy authority. The proxy authority file server when the file is accessed. See
allows the agent nodes to perform also selective recall.
operations such as backup and restore on trusted communications agent (TCA)
behalf of the target node, which owns the A program that handles the sign-on
data. password protocol when clients use
TCA See trusted communications agent. password generation.
TCP/IP
See Transmission Control U
Protocol/Internet Protocol.
UCS-2 A 2-byte (16-bit) encoding scheme based
threshold migration on ISO/IEC specification 10646-1. UCS-2
The process of moving files from a local defines three levels of implementation:
file system to server storage based on the Level 1-No combining of encoded
high and low thresholds that are defined elements allowed; Level 2-Combining of
for the file system. See also automatic encoded elements is allowed only for
migration, demand migration, migration Thai, Indic, Hebrew, and Arabic; Level
job, selective migration. 3-Any combination of encoded elements
are allowed.
throughput
In storage management, the total bytes in UNC See Universal Naming Convention.
the workload, excluding overhead, that
Unicode
are backed up or restored, divided by
A character encoding standard that
elapsed time.
supports the interchange, processing, and
timeout display of text that is written in the
A time interval that is allotted for an common languages around the world,
event to occur or complete before plus many classical and historical texts.
operation is interrupted.
Unicode-enabled file space
Tivoli Storage Manager command script Unicode file space names provide support
A sequence of Tivoli Storage Manager for multilingual workstations without
administrative commands that are stored regard for the current locale.
in the database of the Tivoli Storage
Universally Unique Identifier (UUID)
Manager server. The script can run from
The 128-bit numeric identifier that is used
any interface to the server. The script can
to ensure that two components do not
include substitution for command
have the same identifier. See also Globally
parameters and conditional logic. See also
Unique Identifier.
macro file, script.

196 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Universal Naming Convention (UNC) volume history file
The server name and network name A file that contains information about
combined. These names together identify volumes that have been used by the
the resource on the domain. server for database backups and for
export of administrator, node, policy, or
UTF-8 Unicode Transformation Format, 8-bit
server data. The file also has information
encoding form, which is designed for ease
about sequential-access storage pool
of use with existing ASCII-based systems.
volumes that have been added, reused, or
The CCSID value for data in UTF-8
deleted. The information is a copy of
format is 1208. See also UCS-2.
volume information that is recorded in
UUID See Universally Unique Identifier. the server database.
Volume Shadow Copy Service (VSS)
V A set of Microsoft application-
programming interfaces (APIs) that are
validate used to create shadow copy backups of
To check a policy set for conditions that volumes, exact copies of files, including
can cause problems if that policy set all open files, and so on.
becomes the active policy set. For
example, the validation process checks VSS See Volume Shadow Copy Service.
whether the policy set contains a default VSS Backup
management class. A backup operation that uses Microsoft
version Volume Shadow Copy Service (VSS)
A backup copy of a file stored in server technology. The backup operation
storage. The most recent backup copy of a produces an online snapshot
file is the active version. Earlier copies of (point-in-time consistent copy) of
the same file are inactive versions. The Microsoft Exchange data. This copy can
number of versions retained by the server be stored on local shadow volumes or on
is determined by the copy group Tivoli Storage Manager server storage.
attributes in the management class. VSS Fast Restore
virtual file space An operation that restores data from a
A representation of a directory on a local snapshot. The snapshot is the VSS
network-attached storage (NAS) file backup that resides on a local shadow
system as a path to that directory. volume. The restore operation retrieves
the data by using a file-level copy
virtual mount point method.
A directory branch of a file system that is
defined as a virtual file system. The VSS Instant Restore
virtual file system is backed up to its own An operation that restores data from a
file space on the server. The server local snapshot. The snapshot is the VSS
processes the virtual mount point as a backup that resides on a local shadow
separate file system, but the client volume. The restore operation retrieves
operating system does not. the data by using a hardware assisted
restore method (for example, a FlashCopy
virtual volume operation).
An archive file on a target server that
represents a sequential media volume to a VSS offloaded backup
source server. A backup operation that uses a Microsoft
Volume Shadow Copy Service (VSS)
volume hardware provider (installed on an
A discrete unit of storage on disk, tape or alternate system) to move IBM Data
other data recording medium that Protection for Microsoft Exchange data to
supports some form of identifier and the Tivoli Storage Manager server. This
parameter list, such as a volume label or type of backup operation shifts the
input/output control. See also scratch backup load from the production system
volume, server storage, storage pool, to another system.
storage pool volume.

Glossary 197
VSS Restore
A function that uses a Microsoft Volume
Shadow Copy Service (VSS) software
provider to restore VSS Backups (IBM
Data Protection for Microsoft Exchange
database files and log files) that reside on
Tivoli Storage Manager server storage to
their original location.

W
wildcard character
A special character such as an asterisk (*)
or a question mark (?) that can be used to
represent one or more characters. Any
character or set of characters can replace
the wildcard character.
workload partition (WPAR)
A partition within a single operating
system instance.
workstation
A terminal or personal computer at which
a user can run applications and that is
usually connected to a mainframe or a
network.
worldwide name (WWN)
A 64-bit, unsigned name identifier that is
unique.
WPAR See workload partition.
WWN See worldwide name.

198 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
Index
A alternate/parallel backup paths (continued)
example for performance 41
accessibility features 171 reasons to use 18
activate policy set 60 alternate/parallel backup servers 42, 109
adaptation archiving
of tablespace 115 inactive data 18
Adaptive File Sequencing 107 authorizing Administration Assistant users 87
administration assistant automation options
migration 36 backup version control 109
upgrading 36 frontend/backend processing 109
Administration Assistant 39, 99 multiple log file copies 70
administer users 12 selectable management classes 109
administering userids 87 availability improvements
authorizing users 87 with alternate/parallel paths and servers 109
concepts 9 with multiple log files 70
configuration tool 12 with multiple redo log copies 109
configure systems 12
configuring 87
customizing 12
Database Agent 9 B
Database component 9 backup
installation planning sheets 158 database command 3
manage report templates 12 full offline 130
monitor operations 12 full online 130
overview 12 incremental 8, 107
problem support 12 objects 131
Server component 9 offline 85
starting and stopping 89 online 85
threshold definitions 50 operation reporting 104
view performance data 12 parallel 107
Administration Assistant client path 107
prerequisites 32 performance optimization
setting up 48 multiplexing 113
verifying the installation 49 simulating 92
Administration Assistant database start in non-partitioned environment 69
changing password for 90 start in partitioned environment 129
Administration Assistant scheduling client start in partitioned environment via SSV 129
command line interface 11 status reporting 101, 104
creating reports from 88 terminating 18
prerequisites 32 windows 8
setting up 50 backup object
Administration Assistant Server segmentation 47, 71
specifying 87 Backup Object Manager 4
Administration Assistant Server component commands 131
secure connection to clients 47 backup paths
Administration Assistant Server component configuration alternate/parallel 107
file 11, 48, 49 profile examples 18
Administration Assistant server-level components backup scheduler
initial installation 33 Windows sample 68
installation planning 32 backup server
installing 33 managing data 106
prerequisites 32 performance optimization 16
uninstalling 33 profile examples 18
upgrade installation 33 backup status
verifying the installation 49 monitoring 99
Advanced Copy Services (ACS) xi backup strategy
alternate / parallel backup paths 107 sample 67
alternate network paths and servers 106 backup-archive client 1, 8
alternate path 109 balanced configuration 95
alternate paths 41 BRARCHIVE 129
alternate/parallel backup paths BRBACKUP 129
example for availability 41 buffer copies 108

© Copyright IBM Corp. 1995, 2014 199


buffer size 108 Data Protection for SAP installation package 24, 157
Data Protection for SAP installation packages 24
Data Protection for SAP profile 139
C data throughput 97, 110
actual rate 93
client options file 57, 64, 65, 157
Database Server
client system options file
performance optimization 15
UNIX and Linux example 155
DB2
Windows example 157
single system view (SSV) backup 69
client user options file
DB2 Failure Types 8
UNIX and Linux example 154
DB2 Log Manager 6
client/server connection paths 18
DB2 vendor environment file
cloning 80
sample 157
of a database 74
DB2 Version 8.2
collocation 113
rules when using 44
Command Line Processor (CLP) 3
vendor environment file 44
command syntax
definition information
Backup Object Manager 131
sample 75
CommonStore 8
delete command 134
compression 16, 107
device class 16, 59
null block 108
disability 171
Tivoli Storage Manager 108
disaster recovery 42
configuration 54
disk
configuration files
layout 15
creation of 46
disk I/O
configuration matrix for Tivoli Storage Manager password
actual rate 91
settings 63, 64
disk sorting
Configuration tasks 54
manual 107
configuring 39
distributed file system 51
Configuring 39
DMS 86
console 25
drill-down 98
copies of log files 70
DSMI_CONFIG 29
copy group 60
DSMI_DIR 29
crontab 138
DSMI_LOG 29
file example 138
custom SQL example 153
custom SQL file 151, 152
custom SQL file (sample) 153 E
customer support Enterprise Storage Server 13
contacting 168 environment variable
customization DB2_INSTANCE 133
Administration Assistant 12 DSMI_CONFIG 29
DSMI_DIR 29
DSMI_LOG 29
D TDP_DIR 27, 29, 126
XINT_PROFILE 27, 29
data block 3, 4
example 42
data compression
examples
hardware vs. software 57
alternate/parallel paths for availability 41
null block 108
alternate/parallel paths for disaster recovery 42
Tivoli Storage Manager 108
alternate/parallel paths for increased performance 41
Data Protection for SAP 23, 39
client system options file (UNIX and Linux) 155
architecture and properties 1
client system options file (Windows) 157
components 1
client user options file (UNIX) 154
database utilities 1
client user options file (Windows) 154
installation planning sheets 158
crontab file 138
integration with Administration Assistant 2
full offline batch backup (Windows) 70
integration with SAP 2
include/exclude list (UNIX and Linux) 155
introduction 1
include/exclude list (Windows) 156
migration 35
offline backup shell script 71
overview 1
scheduled batch backup (Windows) 70
profile
Tivoli Storage Manager profiles for UNIX and Linux 154
keyword descriptions 139
Tivoli Storage Manager profiles for Windows 154
migration 36
Windows sample 148
reporting 105
shared library 2, 4
upgrading 35

200 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
F keywords (continued)
BUFFSIZE 108
file sequencing 107 REDOLOG_COPIES 70
fixes, obtaining 168 RL_COMPRESSION 108
FlashCopy and snapshots syntax for all keywords 139
backup 13 knowledge bases, searching 167
devices 13
restore 13
FlashCopy Manager xi
full offline backup 130 L
full offline batch backup LAN-free backup 15
Windows example 70 performance optimization 16
full online backup 130 locking
full restore 130 individual tablespace 107
log files
creating multiple copies 70
G how to find 126
location 126
glossary 177 Log Manager
built in 44
LOGARCHMETHn configuration parameters 27, 30
H logging 109
HACMP 19, 52, 53
sample stop script 53
hardware compression 57 M
compared with Tivoli Storage Manager client software management classes 109
compression 57 Tivoli Storage Manager server configuration 60
high availability 19 manual sorting of files 107
MAX_VERSIONS 129
message file
I how to find 126
IBM Support Assistant 167 migration
inactive data Data Protection for SAP 35
archiving of 8, 18 of administration assistant 36
include/exclude list profile 36
UNIX and Linux example 155 monitoring Data Protection for SAP 12
Windows example 156 multiple network paths 114
incremental backup 8, 107 multiple paths 162
individual tablespace locking 107 multiple redo log copies 109
installation package 24, 157 multiple servers 112
installing when restoring 19
Administration Assistant prerequisites 32 multiple sessions 107, 113
Administration Assistant server-level components 33 multiplexing 16, 113
Administration Assistant, installation verification 49 when restoring 19
verifying TSM options 65
Installing 23, 25
installing Data Protection for SAP 23, 24 N
on Windows 29 network
password handling 63 performance optimization 16
planning for installation 24 throughput rate 91
prerequisites 24 new for version xiii
verifying the installation 31 node
installing Tivoli Storage Manager for ERP number of mount points 61
initial installation 26 Tivoli Storage Manager server 61
on AIX, Linux, Solaris 26 non-partitioned environment
integration of Data Protection for SAP starting backup 69
with Administration Assistant 2 nonpartitioned environment
with SAP 2 starting restore 73
Internet, searching for problem resolution 167, 168 normalizing of tablespaces 115
IPv6 120 null block data compression 108

K O
keyboard 171 offline backup shell script
keywords example 71
BRARCHIVEMGTCLASS 70, 109 offline log file 8
BRBACKUPMGTCLASS 109

Index 201
optimizing problem determination (continued)
backup 110 determining business impact for IBM Software
restore 19 Support 169
submitting a problem to IBM Software 170
production system 80
P productivity options
managing data on the backup server 106
parallel backup and restore
reporting 99
number of parallel sessions to specify 142
profile keywords
parallel backup paths
syntax 139
sample 2 for increased performance 41
profiles
parallel backup servers
example of Tivoli Storage Manager for UNIX and
alternate 109
Linux 154
parallel path 107
Tivoli Storage Manager example for Windows 154
example for increased performance 41
ProLE 27, 28, 29, 87, 88
parallel sessions 107, 162
publications
partition 46, 129, 130, 133, 137, 142
download xi
partitioned environment
starting backup / restore 129
Passport Advantage 169
password command 135 Q
password handling query command 135
configuration matrix (UNIX or Linux) 63
configuration matrix (Windows) 64
set the password 63
path
R
recovery
alternate 109
time for 8
backup 107
Recovery History File 4, 73, 134
performance 98
redirected restore 85
performance monitoring 110
automatic mode 74
Administration Assistant 12
batch mode 78
using sensors 111
interactive mode 79
performance optimization 96
plausibility checks 83
Backup Server 16
prerequisite 85
by changing buffer size 108
using Backup Object Manager 84
by compressing data 107, 108
REDOLOG_COPIES 70
by disk sorting 107
remote shares (Windows)
by multiplexing 113
implementing configuration files on 30
by using multiple network paths 107, 114
reports 99
example 2 41
creating 102
by using multiple servers 107, 112
modifying the output 102
by using multiple sessions 107, 113
on backup performance 99
CPU power 15, 16
on failed actions 102
data transfer 107
on simulations 91
dedicated backbone network 16
types 105
disk layout 15
UNIX scheduling sample 153
general considerations 111
using templates 88, 106
I/O paths 15
using the Administration Assistant Client 89, 105
LAN-free backup 16
Windows scheduling sample 154
network bandwidth 16
restore
options for 107
database command 4
settings for Tivoli Storage Manager 162
full restore 130
size of database 15
performance optimization
volume manager 15
multiplexing 113
Performance tuning 95
redirected 78, 79, 85
permissions
simulating 92
granting for Administration Assistant client 33
start in nonpartitioned environment 73
policy
start in partitioned environment 129
definition 60
retention 18
domain 60
RISC 6000
set 60
buffer pool settings 163
activate 60
RL_COMPRESSION 107
policy file
RL_COMPRESSION profile keyword 108
granting permissions for Administration Assistant
RMAN 39
client 33
printing reports 99, 105
problem determination 119
describing problem for IBM Software Support 169

202 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2
S tablespace (continued)
creation of 85
sample Data Protection for SAP profile locking 107
UNIX or Linux 145 normalizing 78, 115
Windows 148 scaling 116
SAP-DB2 Administration Tools 2 tape drives
Scaling of tablespaces 116 using hardware compression with 57
scheduled batch backup TDP_DIR 27, 29
Windows example 70 template
scheduling client for creating reports 88
command line interface 11 terminating the backup job 18
creating reports 88 test system 80
setting up 50 threshold definitions
scope via custom SQL file 151
of Data Protection for SAP 8 Tivoli Storage Manager 54
security settings client software compression 57
authorizing Administration Assistant users 87 configuration file customization 162
server data compression 108
installing Administration Assistant components 33 network settings 162
SERVER 39 options files 65
SERVER statement 41, 42 passwords 61
SERVERNAME 39 performance optimization 162
servers profile example for UNIX and Linux 154
alternate/parallel 107 profile example for Windows 154
sessions Tivoli Storage Manager API
multiple (parallel) 16, 17, 18, 41, 42, 90, 91, 92, 93, 96, 97, client configuration 24
107, 113, 130, 142 Tivoli Storage Manager client 54
single 17, 98 configuration 54
setup requirements 121 configuration on UNIX or Linux 55
shared library 4 configuration on Windows 57
SID 27, 29, 40, 69, 119, 125, 126, 130, 139, 158 Tivoli Storage Manager for ERP 13
silent mode 25 Tivoli Storage Manager passwords
simulating configuration matrix to set keywords 63, 64
backup and restore 92 Tivoli Storage Manager server
simulation adding 59
reporting on 91 configuration 58
single system view (SSV) backup 69 configuration, prerequisites 58
snapshot management classes 60
devices 13 node definition 61
software compression vs. hardware compression performance considerations 58
Windows 57 policy definition 60
software support storage device setup 59
describing problem for IBM Software Support 169 storage pool definition 59
determining business impact for IBM Software storing data on 17
Support 169 tracing 99
submitting a problem 170 transaction rate
Software Support of Data Protection for SAP 8
contacting 168 trimming the database 8
sorting troubleshooting 119, 121
files 107 IBM support 123
SP Switch reproducible problems 120
buffer pool settings 163 TSM for Advanced Copy Services 13
storage device setup
Tivoli Storage Manager server 59
storage pool 58, 113
definition 59 U
support contract 169 uninstalling Data Protection for SAP
support information 165 from UNIX 28
support subscription 169 from Windows 31
SYSCATSPACE 118 upgrading
Data Protection for SAP 23, 35
Tivoli Storage Manager for ERP 26
T user authorization for Administration Assistant
user exit 6
87

tablespace 4, 15, 69, 73, 133, 134, 135, 136, 137 userids
automated adaptations 115 administering 87
container 75 util_file_online 107
definition information 75, 86, 135

Index 203
V
validate
policy set 60
vendor API 3
vendor environment file 43, 44, 130
VENDOROPT configuration parameter 27, 30
verifying
installation of the Administration Assistant 49
the Data Protection for SAP installation 31
versioning 129
volume 15, 58, 59, 70
manager settings 15

W
Web browser
prerequisite for Administration Assistant 33

X
XINT_PROFILE 27, 29, 132

204 IBM Tivoli Storage Manager for Enterprise Resource Planning Installation and User's Guide for DB2


Product Number: 5608-E05

Printed in USA

You might also like