Professional Documents
Culture Documents
Best Practices:
ADINT/TSM
Installation and Configuration
by
Rainer Diederichs
IBM Deutschland Research & Development GmbH
Boeblingen
30 September 2012
Trademarks
IBM, AIX, FlashCopy, Power and Tivoli are registered Trademarks of IBM Corporation in the United
States and other countries
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in
the United States, other countries, or both.
SAP, SAP MaxDB, R/3, APO, LiveCache are trademarks or registered trademarks of SAP AG
UNIX is a registered trademark of The Open Group in the United States and other countries.
Table of contents
A
A.1
A.2
A.3
Set-up/Overview
Preinstallation
TSM server
5
7
7
A1.1
A1.2
A1.3
A1.4
A1.5
7
7
7
7
8
8
executables
configuration files
8
8
9
9
A.4
SAP MaxDB
B.
ADINT/TSM installation
11
B1.1
11
11
11
11
11
11
11
B1.2
Modes of installation
B1.1.1 silent installation
B1.1.2 console installation
types of installation
B1.2.1 first time installation
B1.2.2 upgrade installation from release 2.3.X
B1.2.3 update installation within release 2.4
12
C. Postinstallation
13
13
15
15
15
15
16
16
16
17
17
17
18
18
18
19
19
19
19
Change History:
2012-09-13 p. 17 para C2.1.1
Dear reader,
we appreciate your feedback.
Please send us your comments or suggestions to
backint@de.ibm.com
Set-up Overview
ADINT/TSM is an intelligent interface program consisting of 2 executables
adint2, the intelligent controler
adintagent, the multithreaded data mover
These executables are placed in the installation path pointed to by an environment/system variable
ADINT.
ADINT/TSM serves two interfaces, SAP MaxDB as well as Tivoli Storage Manager (TSM), and
therfore needs configuration parameters for both. Since ADINT/TSM is an intelligent interface
program, it uses an additional set of configuration parameters to control its own operation.
Configuration parameters are contained in 2 configuration files
init<SID>.utl (edible)
internparamfile.adi (non-edible passwords/keys)
to be placed in the configuration path pointed to by an environment/system variable ADA_OPT.
On the TSM side ADINT connects to the TSM Client API for communication with the TSM server.
The TSM API has its own executables and configuration files, which are placed in standard paths
during the TSM client install process. For this description we assume a standard TSM installation.
All relevant files/executables with their paths and owners are shown in table 1 for a Windows and
UNIX environment.
Topic
\Program Files\Tivoli\TSM\adint
adint2.exe
ADINT
adintagent.exe
init<SID>.utl
ADA_OPT
internparamfile.adi
'system'
'system'
UNIX
install path
/usr/tivoli/tsm/adint64 (AIX)
/opt/tivoli/tsm/adint64 (other UNIX)
adint2
ADINT
adintagent
init<SID>.utl
ADA_OPT
internparamfile.adi
<MaxDB
Instance owner>
<MaxDB
Instance owner>
\maxdb\adint
apienu.dll
dscenu.txt
dsm.opt
<server>.opt
dsierror.log
/usr/tivoli/tsm/client/api/bin64 (AIX)
/opt/tivoli/tsm/client/api/bin64 (other UNIX)
/usr/tivoli/tsm/client/api/bin64 (AIX)
configuration path
/opt/tivoli/tsm/client/api/bin64 (other UNIX)
libApiTSM64.a
EN_US
dsm.opt
link to dsm.sys
log path
dsierror.log
install path
/maxdb/adint
DSMI_DIR
'system'
DSMI_CONFIG
'system'
DSMI_LOG
default
preset
default
preset
Note: TSM client has 2 sets of environment variables named DSM_ for b/a client and DSMI_for api
client.
On the database side ADINT/TSM connects to a pipe interface, which will be customized through
database commands (dbmcli) following the installation of ADINT/TSM.
In the following we will describe the complete ADINT/TSM setup process in 3 steps
preinstallation (configuration of ADINT/TSM, API and TSM server)
installation of ADINT/TSM (installer)
postinstallation (customizing ADINT/TSM and TSMand SAP MaxDB interfaces)
Sample names used throughout the document are shown in italic letters.
Recommendations/explanations to various topics are placed in boxes.
A. Preinstallation
A.1 TSM server
Define
A1.1 target TSM server, e.g. > server_a
A1.2 node name, e.g. maxdb_T01
This node name defines a client with its assigned TSM server resources.
We recommend to define within a database server a dedicated node for a MaxDB instance to
A1.3
storage
needed specific
as backup
repository
(management
classes).
keep
the database
definitions
separate
from those
of other components and avoid
MaxDB
offers
3
types
of
backups
for
which
specific
media
inadvertent changes. We also recommend to use a node name, pools
which can
linksbe
theselected,
node to e.g.
the SID,
full database backup
> mgmtclass_a
e.g.maxdb_<SID>,
to better
identify related(tape)
information.
incremental database backup > mgmtclass_b (can be same as full backup) (tape/disk)
log backup > mgmtclass_c (disk or disk-tape hierarchical)
storage selection should be based on data volume: tape for large chunks of data, disk for
segemented data like logs. Hierarchical storage pools (disk-tape) are optimum for log backups
(server internal disk-tape migration)
selected managementclasses must have an archive copygroup defined
the number of mount points, i.e. physical tape drives, must at minimum be equal to the
number of parallel sessions
separate management classes are strongly recommended for data and log backups to
protect against media failures.
different management classes for the 2 log copies should be defined if the dual log copy
function is activated
A1.4 Backup data retention
Selection can be made between TSM server based retention (per backup object) or
ADINT/TSM based retention (per backup generation).
> TSM: RETVER=20 ADINT/TSM (init<SID>.utl): MAX_VERSIONS 0
TSM expires each object individually n days after it is checked in by RETVER= n|unlimited..
ADINT/TSM expires complete backup generations (full data backup plus susequent
incremental and log backups) within a specified retention threshhold by MAX_VERSION n.
A new version number is assigned each time a full backup has completed successfully.
The ADINT/TSM method is to be preferred if full backup cycles are irregular or longer (several
days).
Only one method should be activated at a time for a predictible process.
e.g. TSM expiration:
RETVER=20 > MAX_VERSION 0
ADINT/TSM expiration:
MAX_VERSION 20 > RETVER=unlimited
n.a.
<nodename>
ADINT/TSM
profileto leave
PASSWORDREQUIRED
NO1. This will help us
We recommend
the default name used YES
by the installer, see table
init<SID>.utl
NODENAME
<nodename>
n.a.
with remote trouble shooting.
(each serverstatement)
1) The MaxDB instance owner must have read and write permission for the specified path
At the end of the preinstall step you should have a verified list of key parameters values required
for the installation and subsequent postinstall steps. The responsible administrators should be
involved wherever necessary to make sure the data is complete and current..
We recommended to enter the actual values into the list below to be used as source during
installation as well as documentation of the environment for later reference.
Parameter
sample
value
required for
upgrade inst.
required for
update inst.
SAP MaxDB
server name
<dbserv>
C2.1 X
C2.2
<SID>
B2- X
#5
C2.1
SAP MaxDB
instance owner name
<instance
owner>
B2
#6
Instance owner
password
C2.2 X
SAP MaxDB
administrator name
<dbm_user>
C2.1 X
C2.2
admin password
<dbm_pwd>
C2.1 X
C2.2
<usage key>
C3.3 X
ADINT/TSM installation
directory
OS specific,
see fig. 1
B2- X, default
#3
C2.1
ADINT/TSM
configuration directory
OS specific,
see fig. 1
B2- X
#4
C2.2
OS specific,
see fig. 1
X, default
<server_a>
B2
#7
<maxdb_<SID>> B2
#7
TSM node password
<node pwd>
C3.1 X
C3.2
<mgmtclass_a> B2
#7
<mgmtclass_b> B2
#7
<mgmtclass_c> B2
#7
10
B. ADINT/TSM Installation
B1.1 Modes of installation
The installer supports 2 special installation modes
B1.1.1 Silent installation
The installation options must be recorded at first in a response file by issuing
<ADINT/TSM installation package> -DRECORDFILE=<record filename>
The installation options in the response file are stored in human-readable format and can be
modified if the silent install process is to be repeated on different systems with, for example,
different SAP MaxDB SIDs.
The silent installation function is then started with the response file
<ADINT/TSM installation package> -i silent -f <record filename>
B1.1.2 Console installation
For target systems that do not have a window manager, the setup program supports an
installation in console mode.
Console mode suppresses the graphical wizard panels of a GUI installation and displays data
entered and messages on the console or in a command prompt window.
To start console install specify the following command:
<ADINT/TSM installation package> -i console
Installation options can also be recorded in console mode for use as response file of a silent
installation
<ADINT/TSM installation package> -i console -DRECORDFILE=<record filename>
11
Nr. Topic
1
2
3
4
5
6
UNIX/
Windows
Used with
Inst. type
both
all
both
all
both
all
as set-up by user
installer will copy internparamfile.adi
both
first time
upgrade
both
first time
UNIX only
1)
first time
both
first time
both
all
both
all
both
all
Action
start screen
list of required input parameters
path configuration
define installation path
path definition
identify configuration path
data base ID
identify SAP MaxDB SID
preinstallation summary
10 finish screen
Table 4 Screen overview for interactive installation
Notes: 1) for Windows platforms the installer will enter these variables as system variables
12
C. Postinstallation tasks
Post installation tasks include
completing the configuration in various profiles, ADINT and TSM
defining ADINT to SAP MaxDB (definition of backup media, set-up of pipes)
setting TSM password and ADINT usage key
C1.1 ADINT/TSM profile
The ADINT/TSM configuration parameters are stored in the init<SID>.utl file in the path defined by
the variable ADINT.
When the option 'first time installation', i.e. Try and Buy or a new instance, has been selected for
the install process, the installer will place a copy of the sample profile from the install package to
the configuration directory. For an upgrade or update installation the existing profiles will stay
untouched.
The parameters of the init<SID>.utl profile in the configuration path of ADINT must now be
adapted to the specific configuration.
13
TRACE 15
#----------------------------------------------------------------------------# This is where the ADINT/TSM logfile will be written to.
# Name can be user defined,e.g. c:\maxdb\adint\adint2.log
#----------------------------------------------------------------------------LOGFILE <drive>:\<path>\<filename>
#----------------------------------------------------------------------------# Range: 0-1048576 (size (Byte) of the data transfer buffer for ADINT/TSM
# and TSM API)
#-----------------------------------------------------------------------------
BUFFERSIZE 32768
#--------------------------------------------------------------------# Range: 1-2 (specifies the number of log copies created by ADINT/TSM)
#--------------------------------------------------------------------REDOLOGCOPIES 1
#----------------------------------------------------------------------------# Statements for each TSM server(s) to be used. One server section must be
# customized properly, additional sections are only required when using the
# 'alternate/multiple server' capability, see app. D of the ADINT User Guide
#----------------------------------------------------------------------------SERVER <server_a>
# TSM servername (max. 64 chars.)
NODENAME <maxdb_<SID>>
# TSM nodename (max. 64 chars.)
PASSWORDREQUIRED yes
# use a TSM password
FULLSESSIONS 4
# TSM sessions (full backup)
UPDATESESSIONS 2
# TSM sessions (incr. backup)
LOGSESSIONS 1
# TSM sessions (log backup)
FULLMANAGEMENTCLASS <mgmtclass_a>
# TSM mgmtclass (full backup)
UPDATEMANAGEMENTCLASS <mgmtclass_b>
# TSM mgmtclass (incr. backup)
LOGMANAGEMENTCLASS <mgmtclass_c>
# TSM mgmtclass (log backup)
#SERVER <server_b>
# TSM servername (max. 64 chars.)
# NODENAME <maxdb_<SID>>
# TSM nodename (max. 64 chars.)
# PASSWORDREQUIRED yes
# use a TSM password
# FULLSESSIONS 4
# TSM sessions (full backup)
# UPDATESESSIONS 2
# TSM sessions (incr. backup)
# LOGSESSIONS 1
# TSM sessions (log backup)
# FULLMANAGEMENTCLASS <mgmtclass_d>
# TSM mgmtclass (full backup)
# UPDATEMANAGEMENTCLASS <mgmtclass_e> # TSM mgmtclass (incr. backup)
# LOGMANAGEMENTCLASS <mgmtclass_f>
# TSM mgmtclass (log backup)
#----------------------------------------------------------------------------# End of profile
Note: The ADINT profile for UNIX is identical to the Windows one above, except for the following
parameters
LOGFILE /<path>/<filename>
BUFFERSIZE 131072
14
The buffersizes above are performance relevant parameters. The values shown reflect what we
normally use in our test environments.
C1.2.2 The directory designated by DSMI_CONFIG must also contain a file dsm.opt, although this
file is not used by ADINT/TSM. The example for this file shown below can be compied from the
ADINT installation path. Absence of this file will cause an error.
************************************************************************
* Tivoli Distributed Storage Manager
*
* Sample TSM User Options file DSM.OPT for Windows,ADINT/TSM), see the *
* TSM documentation for details.
*
************************************************************************
*ErrorLogName c:\maxdb\adint\tsmapierror.log
Recommendation:
There are 2 ways to define the api errorlog, in the dsm.opt or as system variable DSMI_LOG.
It is recommende to use just one alternative. We prefer the use of a system variable as this
definition is system-wide and requires only 1 entry.
Note:
The standard Tivoli Storage Manager client also uses a file dsm.opt, but this TSM standard client
user option file is located in the path set by the variable DSM_CONFIG.
C1.2.3 Set DSMI_* system variables
Add as system variables, see Table 1
DSMI_DIR
C:\Program Files\Common Files\Tivoli\TSM\api64
DSMI_CONFIG
C:\maxdb\adint\dsm.opt
DSMI_LOG
C:\maxdb\adint
Copyright IBM Corporation, 2012
15
Note:
The dsm.sys as a system-wide file should be accessed through a link. For the application specific
dsm.opt we recommend a physical copy in the designated path, see table 1.
16
Examples
- log backup single medium for 1 session
medium_put TSM_LOG \\.\pipe\p01_log PIPE LOG 0 8 NO NO \\ TSM
- full backup single medium for 1 session
medium_put TSM_DATA \\.\pipe\p01_data PIPE DATA 0 8 NO NO \\ TSM
- full backup multiple media for 2 sessions
medium_put TSM_PARA\SESS1 \\.\pipe\p01_data1 PIPE DATA 0 8 NO NO \\ TSM
medium_put TSM_PARA\SESS2 \\.\pipe\p01_data2 PIPE DATA 0 8 NO NO \\ TSM
17
Examples
- log backup single medium for 1 session
medium_put TSM_LOG /tmp/p01_log PIPE LOG 0 8 NO NO \\ TSM
- full backup single medium for 1 session
medium_put TSM_DATA /tmp/p01_data PIPE DATA 0 8 NO NO \\ TSM
- full backup multiple media for 2 sessions
medium_put TSM_PARA/SESS1 /tmp/p01_data1 PIPE DATA 0 8 NO NO \\ TSM
medium_put TSM_PARA/SESS2 /tmp/p01_data2 PIPE DATA 0 8 NO NO \\ TSM
18
19
20