IT Services



Installing the TSM Client for Linux


Contents



1. Progress Checker

Figure /hfs/help/images/tick01.gif []

TSM registration complete Not yet registered?

Figure /hfs/help/images/tick01.gif []

Checked Linux platform support and prerequisites Not using Linux?
- Configured the HFS repository or downloaded the TSM client software
- Successfully installed the TSM software


2. General Outline

The installation or upgrade procedure depends on the distribution and version of Linux you are using. For most Linux distributions you can install the TSM client from the IT Services HFS repository. You first download and install a package that configures your system to use the HFS repository. You then install the TSM client from that repository which means all dependencies will be automatically installed and also you will automatically get TSM client updates alongside all your other software updates.

The Linux repositories are signed. If you wish to confirm the signing key refer to Checking the repository signing key.

For Linux distributions that don't have repository support you can download and install from rpm files, or for distributions that don't support rpm (e.g. Gentoo) we provide a tar file that can be used to install the TSM client.

When installing the TSM client for the first time the HFS-packaged TSM Client will ask for your nodename, password, and whether you want to run scheduled backups, and will then automatically configure the TSM software correctly to connect to the HFS service.

Provided it finds an existing valid configuration the installer will upgrade that configuration without any further input on your part. If you were previously running scheduled backups the installer will stop the old scheduler before upgrading the software then restart it afterwards. It will upgrade your dsm.opt and dsm.sys configuration files.

If something does go wrong with the upgrade process your old configuration files will have been saved with the suffix .SAVE, for example as /opt/tivoli/tsm/client/ba/bin/dsm.opt.SAVE.

If it can work out how to do it, the installer will create a desktop menu item for Tivoli Storage Manager. When you select this you will usually be prompted for a password to enable you to run this with administrative privileges.

The TSM Linux client installs into /opt/tivoli/tsm/client/ with some additional files placed in /usr/bin. The GSKit packages installed as a dependency install into /usr/local/ibm.

The relevant executables are:

dsmj The Java GUI client
dsmc The command line client
dsmtca The 'trusted client agent', which allows non-root users to connect to the HFS

A file /etc/TIVGUID is created the first time a client is run. This file holds the Global Unique Identifier that associates a TSM client with a TSM server and should not be edited or removed.

The password for the HFS account will be stored in an encrypted form, readable only by root, in /etc/adsm/TSM.PWD.

If you have installed from the HFS repository you will get TSM client updates along with all your other system updates.

If you have specific installation problems then email hfs@ox.ac.uk attaching /opt/tivoli/tsm/client/ba/bin/tsm-install.log. This describes what the post installation scripts have attempted to do, and highlights any problems. It may also be required to email the following files: dsm.sys, dsm.opt.



3. The HFS repository



3.1. Supported distributions

The following table lists distributions and versions that are known to install correctly from the HFS repository. If a distribution/version is not in the table it doesn't mean you can't install from the repository - it just means we haven't tried it. Most distributions based on Debian or RedHat will install from the HFS repository.

Distribution Version Notes
Centos 4, 5, 6, 7 see note 1
Debian 5, 6, 7
Fedora 12, 13, 14, 15, 16, 17, 18, 19, 20 see note 2
Mageia 2, 3, 4
Mandriva 2010.2, 2011
OpenSUSE 11.2, 11.3, 11.4, 12.1. 12.2, 12.3, 13.1
Red Hat Enterprise Linux 4, 5, 6, 7 see note 1
Scientific Linux 4, 5, 6 see note 1
Ubuntu 10.04 LTS, 12.04 LTS, 12.10, 13.04, 13.10, 14.04 LTS see note 2

Note 1: The TSM client version 6.2 will not run on Red Hat Enterprise Linux 4 or on version 4 of distributions based on RHEL4. However you can still follow these installation instructions which will result in the 6.1 client being installed on these Linux versions.

Note 2: There is a known problem with versions of the TSM client prior to 6.4.1.7 on Linux systems with glibc 2.16 or higher (notably Fedora 18, Ubuntu 13.04, RHEL/Centos 7, and later). If you are upgrading you operating system please make sure you upgrade your TSM client to the latest level first.



3.2. Unsupported distributions

Distributions that do not use Debian or Redhat style software packaging cannot use the HFS repository. These include Arch, Gentoo and Slackware. If you cannot use the repository it doesn't mean you cannot use TSM - you may be able to successfully install the client from rpm or tar files.



4. Setting up the repository



4.1. Downloading the repository package file

Download the ox-hfs-repo package.

For Debian based systems (including Debian, Ubuntu, Kubuntu, Lubuntu, Xubuntu, Linux Mint, Zorin) download the file ftp://ftp.hfs.ox.ac.uk/repo/apt/deb/ox-hfs-repo.deb.

For RedHat based systems (including RedHat Enterprise Linux, Fedora, Centos, Scientific Linux, Mandriva, Mageia, OpenSUSE, SUSE Enterprise Linux) download the file ftp://ftp.hfs.ox.ac.uk/repo/rpm/ox-hfs-repo.rpm.

Note that access to this file is restricted to the University network. If you are outside the University you can still obtain the file and install the TSM client provided you have a VPN connection to the University network while you do the installation.

If you download this package file using a browser you may be prompted to install it. You may be able to do this (the details will vary from one distribution to another) but it is known that there are cases where this doesn't work so we recommend that you save the file to disk and use the commands described below to install the package.



4.2. Installing the repository package

Open a command shell, change to the directory where you saved the file, and as root run the following command (depending on your Linux distribution):

For Debian based systems (including Debian, Ubuntu, Kubuntu, Lubuntu, Xubuntu, Linux Mint, Zorin) run

 dpkg -i ox-hfs-repo.deb

For RedHat based systems that use the yum package manager (including RedHat Enterprise Linux, Fedora, Centos, Scientific Linux) run

 yum install ox-hfs-repo.rpm

For other RedHat based systems (including Mandriva, Mageia, OpenSUSE, SUSE Enterprise Linux), or if yum install doesn't work on your system, run

 rpm -i ox-hfs-repo.rpm



5. Progress Checker

Figure /hfs/help/images/tick01.gif []

TSM registration complete Not yet registered?

Figure /hfs/help/images/tick01.gif []

Checked Linux platform support and prerequisites Not using Linux?

Figure /hfs/help/images/tick01.gif []

Configured the HFS repository or downloaded the TSM client software Unable to download the TSM client?
- Successfully installed the TSM software


6. TSM client installation

Make sure you have installed the repository package as described in the previous section, then follow the instructions in the appropriate section below depending on your distribution

Alternatively, if the repository doesn't support your distribution follow the instructions for manual rpm installation, if your system supports rpm packages, or tar file installation



6.1. Debian based distributions (e.g. Debian, Ubuntu)



6.1.1. Installing the TSM client

You can install the TSM client using apt:

  1. Make sure the universe repository is enabled in /etc/apt/sources.list
  2. Update your list of packages with apt-get update
  3. To install the full TSM client including GUI support do apt-get install tsm-client
  4. Alternatively to install the command line only TSM client do apt-get install tsm-client-base
  5. The selected package as well as some packages it depends on (including gskcrypt32 and gskssl32 for TSM 6.2 or gskcrypt64 and gskssl64 for later versions) will be installed. For new installs you will be prompted for your TSM nodename and password and will be asked whether you want to run scheduled backups.

It is also possible to install the TSM client with GUI tools. However the details vary between distributions so are not covered here.



6.1.2. Upgrading the TSM client

If you are upgrading from TSM 6.1, 5.5 or 5.4 first install the ox-hfs-repo package as described above.

Usually the TSM client will be updated alongside all your other software updates. If you want to upgrade just the TSM client run the following two commands (as root, or prefixed with sudo):

 apt-get update 
 apt-get install tsm-client 

or

 apt-get update 
 apt-get install tsm-client-base 

if you have only the tsm-client-base package installed.

If your upgraded configuration is not working and you would like to start with a fresh configuration then run:

 dpkg-reconfigure tsm-client-base

This will ignore your old configuration files and prompt you for your Nodename and Password, and whether you want to run scheduled backups.

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.



6.2. Red Hat based distributions (e.g. Red Hat Enterprise Linux, Fedora, CentOS, Scientific Linux)



6.2.1. Installing the TSM client

You can install the TSM client using yum:

  1. Make sure you are logged in as root
  2. To install the full TSM client including GUI support do yum install tsm-client
  3. Alternatively to install the command line only TSM client do yum install tsm-client-base
  4. The selected package as well as some packages it depends on (including gskcrypt32 and gskssl32 for TSM 6.2 or gskcrypt64 and gskssl64 for TSM 6.3) will be installed.
  5. Run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename, Password, and whether to start the scheduler.

It is also possible to install the TSM client with GUI tools. However you will still need to run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh as root after installation.



6.2.2. Upgrading the client

If you are upgrading from TSM 6.1, 5.5 or 5.4 first install the ox-hfs-repo package as described above.

Usually the TSM client will be updated alongside all your other software updates. If you want to upgrade just the TSM client run the following commands as root:

 yum update tsm-client 

or

 yum update tsm-client-base 

if you have only the tsm-client-base package installed.

If your upgraded configuration is not working and you would like to start with a fresh configuration then run:

/opt/tivoli/tsm/client/ba/bin/HFSsetup.sh reconfigure

This will ignore your old configuration files and prompt you for your Nodename and Password, and whether you want to run scheduled backups.

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.



6.3. SUSE distributions



6.3.1. Installing the TSM client

You can install the TSM client using zypper:

  1. Make sure you are logged in as root
  2. To install the full TSM client including GUI support do zypper install tsm-client
  3. Alternatively to install the command line only TSM client do zypper install tsm-client-base
  4. The selected package as well as some packages it depends on (including gskcrypt32 and gskssl32 for TSM 6.2 or gskcrypt64 and gskssl64 for TSM 6.3) will be installed.
  5. Run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename, Password, and whether to start the scheduler.

It is also possible to install the TSM client with GUI tools. However the details vary between distributions so are not covered here. You will still need to run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh as root after installation.



6.3.2. Upgrading the client

If you are upgrading from TSM 6.1, 5.5 or 5.4 first install the ox-hfs-repo package as described above.

Usually the TSM client will be updated alongside all your other software updates. However, because of the change from 32-bit to 64-bit software you will not be automatically updated to 6.3 from an earlier version. In this case, or if you want to just install the TSM client and not other packages, run the following commands as root:

 zypper update tsm-client tsm-client-base

or

 zypper update tsm-client-base 

if you have only the tsm-client-base package installed.

If your upgraded configuration is not working and you would like to start with a fresh configuration then run:

/opt/tivoli/tsm/client/ba/bin/HFSsetup.sh reconfigure

This will ignore your old configuration files and prompt you for your Nodename and Password, and whether you want to run scheduled backups.

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.



6.4. Mandriva/Mageia distributions



6.4.1. Installing the TSM client

You can install the TSM client using urpmi:

  1. Make sure you are logged in as root
  2. To install the full TSM client including GUI support do urpmi tsm-client
  3. Alternatively to install the command line only TSM client do urpmi tsm-client-base
  4. The selected package as well as some packages it depends on (including gskcrypt32 and gskssl32 for TSM 6.2 or gskcrypt64 and gskssl64 for TSM 6.3) will be installed.
  5. Run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename, Password, and whether to start the scheduler.

It is also possible to install the TSM client with GUI tools. However the details vary between distributions so are not covered here. You will still need to run /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh as root after installation.



6.4.2. Upgrading the client

If you are upgrading from TSM 6.1, 5.5 or 5.4 first install the ox-hfs-repo package as described above.

Usually the TSM client will be updated alongside all your other software updates. However, because versions up to 6.2 were 32-bit while later versions are 64-bit software you will not be past 6.2. If you are running TSM 6.2 or earlier on a 64-bit system you must first uninstall the old version by doing:

urpme tsm-client tsm-client-base gskcrypt64 gskssl64

if your current version is TSM 6.2, or

urpme tsm-client 

if your current version is 6.1 or earlier. Then install the latest TSM client as described above.

If you want to just install the TSM client and not other packages, run the following commands as root:

 urpmi tsm-client 

or

 urpmi tsm-client-base 

if you have only the tsm-client-base package installed.

If your upgraded configuration is not working and you would like to start with a fresh configuration then run:

 /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh reconfigure

This will ignore your old configuration files and prompt you for your Nodename and Password, and whether you want to run scheduled backups.

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.



6.5. Manual RPM Install



6.5.1. Installing

Install the HFS rpm signing key

 rpm --import ftp://ftp.hfs.ox.ac.uk/repo/rpm/repodata/repomd.xml.key

Download all the RPM files from ftp://ftp.hfs.ox.ac.uk/repo/rpm/ for 64-bit Linux or from from ftp://ftp.hfs.ox.ac.uk/repo/62/rpm/ for 32-bit Linux

For 64-bit Linux install all the downloaded packages with

 rpm -i ox-hfs-repo.rpm tsm-client-6.4.1.7-1.x86_64.rpm tsm-client-base-6.4.1.7-1.x86_64.rpm gskcrypt64-8.0-14.26.x86_64.rpm gskssl64-8.0-14.26.x86_64.rpm

or if you only want the command line client

rpm -i ox-hfs-repo.rpm tsm-client-base-6.4.1.7-1.x86_64.rpm gskcrypt64-8.0-14.26.x86_64.rpm gskssl64-8.0-14.26.x86_64.rpm

For 32-bit Linux install all the downloaded packages with

 rpm -i ox-hfs-repo.rpm tsm-client-6.2.5.0-4.i386.rpm tsm-client-base-6.2.5.0-4.i386.rpm gskcrypt32-8.0-14.6.i386.rpm gskssl32-8.0-14.6.i386.rpm

or if you only want the command line client

 rpm -i ox-hfs-repo.rpm tsm-client-base-6.2.5.0-4.i386.rpm gskcrypt32-8.0-14.6.i386.rpm gskssl32-8.0-14.6.i386.rpm

If this complains about missing dependencies (for example compat-libstdc++-33) you will need to find and install those packages for your distribution. If the dependent libraries are actually installed you can try using the --nodeps switch to install ignoring dependencies. If you can't meet dependencies for the tsm-client package try omitting that - you may still be able to install the command line only package. (Note that the ox-hfs-repo package is installed even though you can't use a repository as as it is a dependency of the tsm-client-base package).

To automatically configure the client run: /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename, Password, and whether to start the scheduler.



6.5.2. Upgrading

Follow the instructions above for installation only use rpm -U option in place of rpm -i, that is for 64-bit clients

 rpm -U ox-hfs-repo.rpm tsm-client-6.4.1.7-1.x86_64.rpm tsm-client-base-6.4.1.7-1.x86_64.rpm gskcrypt64-8.0-14.26.x86_64.rpm gskssl64-8.0-14.26.x86_64.rpm

or if you only want the command line client

rpm -U ox-hfs-repo.rpm tsm-client-base-6.4.1.7-1.x86_64.rpm gskcrypt64-8.0-14.26.x86_64.rpm gskssl64-8.0-14.26.x86_64.rpm

or, for 32-bit clients,

 rpm -U ox-hfs-repo.rpm tsm-client-6.2.5.0-4.i386.rpm tsm-client-base-6.2.5.0-4.i386.rpm gskcrypt32-8.0-14.6.i386.rpm gskssl32-8.0-14.6.i386.rpm

or if you only want the command line client

 rpm -U ox-hfs-repo.rpm tsm-client-base-6.2.5.0-4.i386.rpm gskcrypt32-8.0-14.6.i386.rpm gskssl32-8.0-14.6.i386.rpm

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.

However, if your configuration is not working after the upgrade and you would like to start with a fresh configuration then run:

 /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh reconfigure

Then follow the installation instructions. This will ignore your old configuration files and prompt you for your Nodename and Password, and whether you want to run scheduled backups.



6.6. Installing using the tar file (e.g. Gentoo)



6.6.1. Installing the TSM client (64-bit systems)

Download the gzipped tar file from ftp://ftp.hfs.ox.ac.uk/repo/tar/tsm-client-6.4.1.7-1.tgz

Install the software by untarring the file from the root directory.

After the TSM software has been unpacked, to automatically configure the client run: /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename and Password, and whether you want to run scheduled backups. (If you are using a system with a startup script system significantly different to that used on Debian and Redhat systems, e.g. Gentoo, you may have to manually configure the scheduler to start).

For example:

 cd /tmp 
 wget ftp://ftp.hfs.ox.ac.uk/repo/tar/tsm-client-6.4.1.7-1.tgz 
 cd / 
 su - 
 tar -xhzf /tmp/tsm-client-6.4.1.7-1.tgz 
 /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh 


6.6.2. Installing the TSM client (32-bit systems)

Download the gzipped tar file from ftp://ftp.hfs.ox.ac.uk/repo/62/tar/tsm-client-6.2.5.0-4.tgz

Install the software by untarring the file from the root directory.

After the TSM software has been unpacked, to automatically configure the client run: /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh. This will prompt for a Nodename and Password, and whether you want to run scheduled backups. (If you are using a system with a startup script system significantly different to that used on Debian and Redhat systems, e.g. Gentoo, you may have to manually configure the scheduler to start).

For example:

 cd /tmp 
wget ftp://ftp.hfs.ox.ac.uk/repo/tar/tsm-client-6.2.5.0-4.tgz 
cd / 
su - 
tar -xhzf /tmp/tsm-client-6.2.5.0-4.tgz 
/opt/tivoli/tsm/client/ba/bin/HFSsetup.sh 


6.6.3. Upgrading the TSM client.

Save the files dsm.opt, dsm.sys, incl.excl and dsmsched.rc (if they exist) to a safe area.

Remove the /opt/tivoli directory tree.

Download the tar file and untar as for a fresh installation.

Copy back the files you saved earlier (dsm.opt, dsm.sys, etc) back to /opt/tivoli/tsm/client/ba/bin/

Run the /opt/tivoli/tsm/client/ba/bin/HFSsetup.sh script, which will upgrade the existing configuration.

If the update was successful, you can continue to use the TSM client as previously. Your scheduled backups should also continue to function as previously.



7. Allowing non-root users to run the client

By default non-root users are not able to use the TSM software to back up and restore their own files. Should you wish to enable this functionality, do as follows: This will enable a non-root user to back up and restore only their own files. To back up and restore all files, you must run TSM as the root user.


8. Progress Checker

Figure /hfs/help/images/tick01.gif []

TSM registration complete Not yet registered?

Figure /hfs/help/images/tick01.gif []

Checked Linux platform support and prerequisites Not using Linux?

Figure /hfs/help/images/tick01.gif []

Configured the HFS repository or downloaded the TSM client software Unable to download the TSM client?

Figure /hfs/help/images/tick01.gif []

Successfully installed the TSM software Installation failed? - Help is available!


9. Running an Initial Backup of your System

It is important to ensure that you run an initial manual backup of your machine for the following reasons:

  1. To verify connectivity between your client and the HFS server
  2. To verify that the software is working correctly
  3. To ensure that we receive your data correctly
  4. To ensure that any issues can be addressed as soon as possible.

Now please follow these instructions to run through the initial backup.



10. Frequently Asked Questions

Downloading/installing the TSM Client - FAQ (See all FAQs)