How to install/configure TSM client on Linux (IBM Spectrum Protect)

Below are the steps to install and configure IBM Spectrum Protect BA (Backup Archive) TSM client. This procedure was written using RedHat Linux 8.5 and TSM BA client version 8.1.11. Please note that the step is quite similar for other Linux flavors and various versions of the TSM BA client.

Step 1. Download TSMBA installation package and extract

Download the TSM BA Client: Obtain the TSM BA client installation package compatible with your Linux version from the official IBM website and extract the Installation Package: Extract the downloaded installation package to access its contents by tar command as follows.

my_tsmclient01:[root]/software_pkg/tsmba>ls -rlt
total 599952
-rwxr-xr-x. 1 root root 614348800 Jul 19 20:42 8.1.11.0-TIV-TSMBAC-LinuxX86.tar
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba> tar -xvf 8.1.11.0-TIV-TSMBAC-LinuxX86.tar
gskcrypt64-8.0.55.17.linux.x86_64.rpm
GSKit.pub.pgp
gskssl64-8.0.55.17.linux.x86_64.rpm
README_api.htm
README.htm
RPM-GPG-KEY-ibmpkg
TIVsm-API64.x86_64.rpm
TIVsm-APIcit.x86_64.rpm
TIVsm-BAcit.x86_64.rpm
TIVsm-BAhdw.x86_64.rpm
TIVsm-BA.x86_64.rpm
TIVsm-filepath-source.tar.gz
TIVsm-JBB.x86_64.rpm
TIVsm-WEBGUI.x86_64.rpm
update.txt
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>ls -rlt
total 1199924
-rw-r--r--. 1 root root       491 Nov  9  2020 update.txt
-rw-r--r--. 1 root root     22104 Nov  9  2020 README.htm
-rw-r--r--. 1 root root     21131 Nov  9  2020 README_api.htm
-rw-r--r--. 1 root root     52794 Nov  9  2020 TIVsm-filepath-source.tar.gz
-rw-r--r--. 1 root root  10040049 Nov  9  2020 gskssl64-8.0.55.17.linux.x86_64.rpm
-rw-r--r--. 1 root root       858 Nov  9  2020 GSKit.pub.pgp
-rw-r--r--. 1 root root   2469974 Nov  9  2020 gskcrypt64-8.0.55.17.linux.x86_64.rpm
-rw-r--r--. 1 root root       971 Nov  9  2020 RPM-GPG-KEY-ibmpkg
-rw-r--r--. 1 root root  82877032 Nov  9  2020 TIVsm-API64.x86_64.rpm
-rw-r--r--. 1 root root   3228335 Nov  9  2020 TIVsm-BAhdw.x86_64.rpm
-rw-r--r--. 1 root root   3438854 Nov  9  2020 TIVsm-BAcit.x86_64.rpm
-rw-r--r--. 1 root root   3414678 Nov  9  2020 TIVsm-APIcit.x86_64.rpm
-rw-r--r--. 1 root root    375592 Nov  9  2020 TIVsm-JBB.x86_64.rpm
-rw-r--r--. 1 root root 137993650 Nov  9  2020 TIVsm-BA.x86_64.rpm
-rw-r--r--. 1 root root 370399101 Nov  9  2020 TIVsm-WEBGUI.x86_64.rpm
-rwxr-xr-x. 1 root root 614348800 Jul 19 20:42 8.1.11.0-TIV-TSMBAC-LinuxX86.tar
my_tsmclient01:[root]/software_pkg/tsmba>
Step 2. Install TSMBA

It’s important to note to keep the following sequence when installing the TSMBA rpm due to inter-dependencies. Failure to adhere to the correct order result in installation failure.

rpm -ivh  gskcrypt64-8.0.55.17.linux.x86_64.rpm
rpm -ivh  gskssl64-8.0.55.17.linux.x86_64.rpm
rpm -ivh  TIVsm-API64.x86_64.rpm         
rpm -ivh  TIVsm-APIcit.x86_64.rpm     
rpm -ivh  TIVsm-BA.x86_64.rpm                                            

Note the screen output of TSM BA client installation on Linux. After the installation, run the command rpm -qa | grep TIV and rpm -qa | grep gsk for validation.

my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -ivh  gskcrypt64-8.0.55.17.linux.x86_64.rpm
warning: gskcrypt64-8.0.55.17.linux.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID fbbfca9c: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:gskcrypt64-8.0-55.17             ################################# [100%]
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -ivh  gskssl64-8.0.55.17.linux.x86_64.rpm
warning: gskssl64-8.0.55.17.linux.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID fbbfca9c: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:gskssl64-8.0-55.17               ################################# [100%]
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -ivh  TIVsm-API64.x86_64.rpm
warning: TIVsm-API64.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID be1d0ddb: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:TIVsm-API64-8.1.11-0             ################################# [100%]
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -ivh  TIVsm-APIcit.x86_64.rpm
warning: TIVsm-APIcit.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID be1d0ddb: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:TIVsm-APIcit-8.1.11-0            ################################# [100%]
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -ivh  TIVsm-BA.x86_64.rpm
warning: TIVsm-BA.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID be1d0ddb: NOKEY
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:TIVsm-BA-8.1.11-0                ################################# [100%]
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>
my_tsmclient01:[root]/software_pkg/tsmba>rpm -qa | grep TIV
TIVsm-BA-8.1.11-0.x86_64
TIVsm-APIcit-8.1.11-0.x86_64
TIVsm-API64-8.1.11-0.x86_64
my_tsmclient01:[root]/software_pkg/tsmba>rpm -qa | grep gsk
gskcrypt64-8.0-55.17.x86_64
gskssl64-8.0-55.17.x86_64
my_tsmclient01:[root]/software_pkg/tsmba>

Step 3. Node registration on TSM server

Login TSM server via dsmadmc and run the command register node as below.

Protect: TSMSVR01>register node my_tsmclient01 your_password domain=LinuxDom01
ANR2060I Node TSMCLIENT01 registered in policy domain LINUXDOM01.

Protect: TSMSVR01>
Step 4. Edit dsm.sys on TSM client

4.1 Copy dsm.sys and dsm.opt from its sample configuration files that came with the installation. Run following commands

cd /opt/tivoli/tsm/client/ba/bin
cp dsm.sys.smp dsm.sys 
cp dsm.opt.smp dsm.opt  

4.2 Open “/opt/tivoli/tsm/client/ba/bin/dsm.sys” using vi editor. Copy all the stanzas listed below and paste them under the “SERVERNAME server_a” line. There are thousands of options in TSMBA but these are commonly used in most TSM environments that I worked for. But ensure to change IP address of TSPSERVERADDRESS in blue with your TSM server IP. Please note that you should only edit the “dsm.sys” file as instructed and do not edit dsm.opt

cd /opt/tivoli/tsm/client/ba/bin
vi dsm.sys 


SERVERNAME              server_a 
   COMMMETHOD           TCPIP
   TCPSERVERADDRESS        192.168.0.11     
   schedlogretention    15 d
   errorlogretention    15 d
   schedlogname         /var/adsmlogs/schedule.log
   errorlogname         /var/adsmlogs/dsmerror.log   
   passwordaccess       generate
   largecommbuffers     yes
   COMPRESSION          off
   changingretries      4
   *inclexcl            /opt/tivoli/tsm/client/ba/bin/inclexcl
   maxcmdretries        8
   retryperiod          15
   txnbytelimit        25600
   tcpbuffsize          32
   tcpwindowsize        64
   *domain              all-local all-auto-nfs
   resourceutil         3
Step 5. Validation

TSM BA client is now ready to connect to the TSM server. The client will use the specified options, including the server’s IP address and communication method, to establish a connection and ready to perform backup and archive operations. Run the command dsmc query session. This should run via root ID.

If this is the first time running the TSM BA client, it prompts you to enter the password of the TSM client. This password was set when TSM client was registered on the TSM server at Step 3. However, due to the “passwordaccess generate” option specified in the “dsm.sys” file, subsequent runs of the “dsmc” command on the TSM BA client will not require you to enter the password again. The “passwordaccess generate” option allows the TSM BA client to generate and use a password automatically without user intervention.

my_tsmclient01:[root]/tsm>dsmc query session 
IBM Spectrum Protect
Command Line Backup-Archive Client Interface
  Client Version 8, Release 1, Level 11.0
  Client date/time: 07/19/2023 20:49:45
(c) Copyright by IBM Corporation and other(s) 1990, 2020. All Rights Reserved.

Node Name: MY_TSMCLIENT01
Please enter your user id <MY_TSMCLIENT01>:

Please enter password for user id "TSMCLIENT01":  <-- Enter the password when client node registered on TSM server. 

Session established with server TSMSVR01: Linux/x86_64
  Server Version 8, Release 1, Level 11.000
  Server date/time: 07/19/2023 20:49:46  Last access: 07/19/2023 20:49:21

IBM Spectrum Protect Server Connection Information

Home Server Name........: SERVER_A
Server Type.............: Linux/x86_64
Archive Retain Protect..: "No"
Server Version..........: Ver. 8, Rel. 1, Lev. 11.0
Last Access Date........: 07/19/2023 20:49:21
Delete Backup Files.....: "No"
Delete Archive Files....: "Yes"
Deduplication...........: "Server Only"

Node Name...............: MY_TSMCLIENT01
User Name...............: root

SSL Information.........: TLSv1.3 TLS_AES_256_GCM_SHA384

Secondary Server Information
Not configured for failover

my_tsmclient01:[root]/tsm>
my_tsmclient01:[root]/tsm>dsmc query session 
IBM Spectrum Protect
Command Line Backup-Archive Client Interface
  Client Version 8, Release 1, Level 11.0
  Client date/time: 07/19/2023 20:49:45
(c) Copyright by IBM Corporation and other(s) 1990, 2020. All Rights Reserved.

Node Name: MY_TSMCLIENT01
Session established with server TSMSVR01: Linux/x86_64
  Server Version 8, Release 1, Level 11.000
  Server date/time: 07/19/2023 20:49:46  Last access: 07/19/2023 20:49:21

IBM Spectrum Protect Server Connection Information

Home Server Name........: SERVER_A
Server Type.............: Linux/x86_64
Archive Retain Protect..: "No"
Server Version..........: Ver. 8, Rel. 1, Lev. 11.0
Last Access Date........: 07/19/2023 20:49:21
Delete Backup Files.....: "No"
Delete Archive Files....: "Yes"
Deduplication...........: "Server Only"

Node Name...............: MY_TSMCLIENT01
User Name...............: root

SSL Information.........: TLSv1.3 TLS_AES_256_GCM_SHA384

Secondary Server Information
Not configured for failover

my_tsmclient01:[root]/tsm>

1 thought on “How to install/configure TSM client on Linux (IBM Spectrum Protect)”

Leave a Comment

Your email address will not be published. Required fields are marked *

Scroll to Top