Install the HFS backup client software

TSM rebranding

With effect from version 8.1 onwards, the IBM TSM (Tivoli Storage Manager) backup / archive product has been rebranded as IBM Spectrum Protect. This is a rebranding exercise by IBM and, unless indicated specifically, there is no difference in the operation of the two brands. Version 7 of the (old) TSM client is still available for installation on older operating systems and you will see references to both IBM Spectrum Protect and TSM throughout these pages.

 

 

Please complete the HFS backup service registration process before downloading and installing the software.

The backup client software is available under the following conditions:

  • It is sourced solely via the HFS web pages.
  • It is installed on the appropriate client platform.
  • It is not installed on any beta or Release Candidate (RC) Operating System.
  • A fresh installation requires a direct or VPN connection to the University network.
  • It is upgraded when the HFS service requires it to be.
  • It is uninstalled from the client system when the client no longer has use of the HFS service.

Please note that you will need to be on the University network, eduroam, or connecting over VPN, to download, install and configure the software.

It is only possible to restore your data to the same type of system as the one that you used to back it up.  For further information see our FAQ item on how to perform a restore.

If you already have the software installed and want to upgrade or reinstall it, there is no need to remove the existing version before upgrading.

WINDOWS

Expand All

HFS backup client software is available for both 32-bit and 64-bit versions of Windows.  Microsoft provide guidance on how to check your version.

 

Windows 8.1, 10, 11, 2012, 2012 R2, 2016, 2019 64-bit Installation Download
Windows 7, 8, 2008, 2008 R2 64-bit Installation Download
Windows 7, 8, 8.1, 10, 2008 32-bit Installation Download
  1. Close any programs that you are running.
  2. Run the downloaded file.
  3. If prompted by a security warning, select Run
  4. If prompted by a User Account Control message, select Yes
  5. The installer may appear to do nothing for a few minutes.
  6. After a short while, provide your Spectrum Protect nodename and Spectrum Protect/TSM password.  If required, you can see your registered nodename and reset your password at the HFS Backup & Archive Services Portal.
  7.  The installer will start the backup scheduler service to allow automatic backups.
  8. Select Finish to complete the installation.

It is important to run an initial manual backup of your machine to:

  • verify connectivity between your client and the HFS server.
  • verify that the software is working correctly.
  • ensure that we receive your data correctly.
  • ensure that any issues can be addressed as soon as possible.
MACOS / OSX

Expand All

MacOS 11 (Big Sur) and 12 (Monterey) are not supported on the HFS legacy Spectrum Protect service, but they are supported on the new disk-based service.

macOS 10.15 (Catalina), 10.14 (Mojave), 10.13 (High Sierra), 10.12 (Sierra), or 10.11 (El Capitan) Download
OS X 10.10 (Yosemite) , 10.9 (Mavericks) and 10.8 (Mountain Lion) Download

 

If you are warned that the download contains an application, select Continue.  After completing the download, please proceed to the next section, 'Client installation', which explains certain settings that you will need to change before you can install and use Spectrum Protect.

  1. Run the downloaded file.
  2. If the file can't be opened because Apple cannot check it for malicious software:
    1. Click OK
    2. Open System Preferences > Security and Privacy > General
    3. To the side of the notification that the file was blocked, click Open Anyway
    4. When the warning message appears again, select Open
  3. Optionally, select the padlock icon to confirm the package is digitally signed by the University of Oxford.
  4. Continue the installation, providing a computer admin account when prompted.
  5. Provide your Spectrum Protect nodename, then your Spectrum Protect/TSM password.  If required, you can see your registered nodename and reset your password at the HFS Backup & Archive Services Portal.
  6. If you intend to perform automatic scheduled backups, select Yes.when prompted Do want to start the Spectrum Protect Automatic Backup Scheduler?
  7. The installer may appear to do nothing for a few minutes.
  8. You will be advised that The node was successfully configured, or provided with details of any problems.
  9. Select Close to complete the installation.
  10. From macOS 10.15 (Catalina) onwards, update the following to allow automatic scheduled backups:
    1. Open System Preferences > Security and Privacy > Privacy > Full disk access.
    2. Click on the padlock icon to allow changes.
    3. If dsmc is a listed app, tick the box next to it.  Otherwise, click on + and navigate to /Library/Application Support/tivoli/tsm/client/ba/bin, select dsmc, then Open.

It is important to run an initial manual backup of your machine to:

  • verify connectivity between your client and the HFS server.
  • verify that the software is working correctly.
  • ensure that we receive your data correctly.
  • ensure that any issues can be addressed as soon as possible.
LINUX

The latest IBM Spectrum Protect client for Linux runs on Intel x86_64 platforms.  IBM no longer support the 32-bit Intel x86 platform.

Current supported versions require Java 7 or higher for running the GUI.  

These versions of the client include native support for the following filesystem types: Btrfs, ext2, ext3, ext4, xfs, JFS, NSS, ReiserFS, VxFS, and GPFS.

IBM officially supports (to varying degrees) the Spectrum Protect Linux client on recent versions of Red Hat Enterprise Linux, SUSE Linux Enterprise Server, SUSE Linux Enterprise Desktop, Ubuntu, CentOS, Debian,  Fedora, OpenSUSE, and Scientific Linux.  However in practice just about any recent Linux distribution should be able to run the Spectrum Protect backup/archive client software and we have successfully tested on a number of others.  In certain cases it may not be possible to run the Java GUI client, but even then the command line client can usually be installed and run.

The preferred method of installation is using the HFS software repositories.  When doing this software prerequisites should be automatically installed.  These include:

 

Item Version Notes
libstdc++ 6  
Java runtime JRE 7 or higher Required for the GUI
X Window System   Required for the GUI

 

The Spectrum Protect software installs in /opt/tivoli.  It must be possible to create this directory (if it does not exist) and write into it.

For most Linux distributions you can install the Spectrum Protect 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 client from that repository which means all dependencies will be automatically installed and also you will automatically get client updates alongside all your other software updates.

The Linux repositories are signed if you wish to confirm the repository signing key.

For Linux distributions that do not have repository support you can download and install from rpm files, or for distributions that do not support rpm (such as Gentoo) we provide a tar file that can be used to install the client.

After installation you will have to run the setup utility to configure the client.

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 Spectrum Protect.  When you select this you will usually be prompted for a password to enable you to run this with administrative privileges.

The client installs into /opt/tivoli/tsm/client/ with some additional files placed in /usr/bin

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 Spectrum Protect servers

 

A file /etc/TIVGUID is created the first time a client is run.  This file holds the Global Unique Identifier that associates a client with a Spectrum Protect 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 specific installation problems then email hfs@ox.ac.uk attaching /opt/tivoli/tsm/client/ba/bin/hfs-sp-install.log.  This describes what the post installation scripts have attempted to do and highlights any problems.  You may also need to email the dsm.sys and dsm.opt files.

Supported distributions

The following distributions and versions are known to install correctly from the HFS repository.  If a distribution is not listed it does not mean you can not install from the repository, it just means we have not tried it.

 

Distribution Version Notes
Centos 6, 7, 8  
Debian 7, 8, 9, 10, 11 Note 1
Fedora 30, 31, 32, 33, 34, 35 Note 1
Mageia 5, 6, 7, 8  
OpenSUSE 15  
Red Hat Enterprise Linux 6, 7, 8  
Scientific Linux 6, 7  
SUSE Enterprise Linux 11, 12  
Ubuntu 14.04 LTS, 16.04 LTS, 18.04 LTS, 18.10, 19.04, 19.10, 20.04 LTS Note 1

 

Note 1: The Spectrum Protect GUI cannot be run directly when logged in as a normal user on Ubuntu 17.10, Fedora 25 and higher, and Debian 9 (using GNOME and Wayland) and other distributions using the Wayland display manager.  See knowledge base article KBNIX0009 for more information and a workaround.

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 does not mean you cannot use TSM, you may be able to successfully install the client from rpm or tar files as described below.

Setting up the repository

Download the appropriate ox-hfs-repo package and install it using the commands below.

 

Debian based (including Ubuntu, Kubuntu, Lubuntu, Xubuntu, Linux Mint, Zorin) Download
RedHat based (including Fedora, Centos, Scientific Linux, Mandriva, Mageia, OpenSUSE, SUSE Enterprise Linux) Download

 

Open a command shell, change to the directory where you saved the file, and as root run the following command:

  • Debian based systems:
dpkg -i ox-hfs-repo_1.4.0-2_all.deb
  • RedHat based systems using the yum package manager (including RedHat Enterprise Linux, Fedora, Centos, Scientific Linux):
yum install ox-hfs-repo-1.4.0-1.noarch.rpm
  • RedHat based systems using the dnf package manager (Fedora 22 and later):
dnf install ox-hfs-repo-1.4.0-1.noarch.rpm
  • Other RedHat based systems, or if the package manager does not work:
rpm -i ox-hfs-repo-1.4.0-1.noarch.rpm

Linux systems are usually configured to install the Spectrum Protect client from the IT Services HFS repository.  This is done by installing the ox-hfs-repo package which sets up the repository and installs a public signing key that is then used to confirm that packages installed from the repository come from a trusted source.

If you wish to confirm the key is correct after you have installed the ox-hfs-repo package then use the appropriate procedure below.

Debian based systems

Issue the following command:

apt-key finger | grep HFS -C 2

You should see:

pub   1024D/EF91DF05 2011-02-24
               Key fingerprint = 60AC EDB6 980E A06D 4879  9299 CDBD F30C EF91 DF05
               uid                  IT Services HFS Team (GPG signing key) <hfs@ox.ac.uk>
               sub   1024g/2EB4A12C 2011-02-24

Please note that depending on when the key was first installed it may say OUCS instead of IT Services.

Taking that into account, if the fingerprint does not match that shown above then contact hfs@ox.ac.uk for advice.

RPM based systems

Issue the following command

rpm -qi gpg-pubkey-ef91*

You should see something like the following output:

Name        : gpg-pubkey                   Relocations: (not relocatable)
Version     : ef91df05                          Vendor: (none)
Release     : 514092d6                      Build Date: Fri 24 May 2013 03:41:55 PM BST
Install Date: Fri 24 May 2013 03:41:55 PM BST      Build Host: localhost
Group       : Public Keys                   Source RPM: (none)
Size        : 0                                License: pubkey
Signature   : (none)
Summary     : gpg(IT Services HFS Team (GPG signing key) <hfs@ox.ac.uk>)
Description :
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: rpm-4.8.0 (NSS-3)

mQGiBE1mPrgRBADibg8ZFQrLqDSX7RVXEM7+6VUqJG/DdIQcKqI0DD6rDmbjLcuv
XiwTDfRaCkAgEXOMeLQ+X1me8CUJEtYWH1/HQGpBlE+7twyZNFtLXfLt8cUOc2e+
i+4WIH6Wo/Ww6rCiCDw6eKlIRCGlote8fLpAtaKJmPlHElnbEvRlVVixRwCgovSr
f5tqGYTAoCYIlldUx0noP9UEANoThe0YpO7ON7WU43ulRhT3qRmO7u06D5ZI497M
3Gfp+kpdPzAIjdbZMpKS/JxZ3ItrWHcqcVYbLNbQ2BX7gYdDgWPwHZIYdpgmi281
gezuuLX0vUHolOszPQvdY/lakC7SEEX+0OH8+CmywuYE9EaEoILexD5V1zUp4iAO
zrcQA/486/zI9f3EtFpYIILS3fPqG50jJZeMptHLh8H3tcUcDay7+V5JHZes2Kqo
Q9Kki6tsK4Wr6alUVgjIrzpjLU6T9tzKjS7H4aXxCO1+pN6qMI0U1nphj3YlcoPj
nFrfOoEm+OL/hznnzL/C17W7+obGBhqh3Y1CYAAAo6yMQ4Ry07Q1SVQgU2Vydmlj
ZXMgSEZTIFRlYW0gKEdQRyBzaWduaW5nIGtleSkgPGhmc0BveC5hYy51az6IYgQT
EQIAIgUCUUCS1gIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQzb3zDO+R
3wUSFACfXOVhg/Ey2pBd8gZtcEwbgbX19K4AoJgalJKf0KQ9puuLgyyeuVGW1oOR
uQENBE1mPrkQBAC1zmVaqpYZpj7cej5qWkM5y5MdXyblfRrqfFZSc1oKJb9zPejv
zUxIPntZloNkOlJCqnT3ZQTegTIMcL0schplaG4IFeQLpkLGFbuOVOWCbghe8Qtz
uMaPQw5D4d/SasFTJjQZfJ6pxP0k3zWaaqKZ+6s9B2VV1RUmXMxLMxooNwAFFwQA
ourf11y81fCifo3xc2LrIo5Aoer26TIl5jwJR4VwXyZaxgJOaASe/Eq1y4xE+hFr
zz6AGvSk6PrUGRyJbOlpDv9JeedjTNgxdD1awG+YyMuVooN/QKO+l48d/RPAA8+9
0/6QPzEIWh+M3CSD0YRu1lw23LU59NN99BEvA+F1ppaISQQYEQIACQUCTWY+uQIb
DAAKCRDNvfMM75HfBc7XAJoDHBEIxPY7+WpBZiC20grO8Mbg+ACeNwoEidRiQDes
/3ZeA2W5FYWlqcg=
=h2eC
-----END PGP PUBLIC KEY BLOCK-----

 

Please note that:

  • depending on your version of rpm the layout may be slightly different.
  • you should expect the dates and possibly the rpm version values to be different.
  • depending on when the key was first installed it may say OUCS instead of IT Services.
  • the important part is the PGP public key block but note that it may be broken into longer or shorter lines than the above.

Taking that into account, if the key details do not match those shown above then contact hfs@ox.ac.uk for advice.

For Debian based systems, including Debian, Ubuntu, Kubuntu, Lubuntu, Xubuntu, Linux Mint, Zorin.

Installing the client

  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 Spectrum Protect client do apt-get install ox-hfs-spectrum-protect.
  4. Run /opt/tivoli/tsm/client/ba/bin/HFSconfigure.  This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.

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

Upgrading the client

If you are upgrading from TSM 6 or earlier we recommend you uninstall your existing TSM client and then reinstall the new Spectrum Protect client.

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

apt-get update
apt-get install ox-hfs-spectrum-protect

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

For RedHat based systems using yum or dnf, including RedHat Enterprise Linux, Fedora, Centos, Scientific Linux.

Installing the client

You can install the client using yum (or dnf for Fedora 22 and later):

  1. Make sure you are logged in as root.
  2. To install the Spectrum Protect client do yum install ox-hfs-spectrum-protect.
  3. Run /opt/tivoli/tsm/client/ba/bin/HFSconfigure.  This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.

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

Upgrading the client

If you are upgrading from TSM 6 or earlier we recommend you uninstall your existing TSM client and then reinstall the new Spectrum Protect client.

Usually the client will be updated alongside all your other software updates.  If you want to upgrade just the Spectrum Protect client run the following commands as root (replace yum with dnf for Fedora 22 and later):

yum update tsm-client ox-hfs-spectrum-protect

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

For SUSE systems, including SUSE Enterprise Linux, OpenSUSE.

Installing the client

You can install the client using zypper:

  1. Make sure you are logged in as root.
  2. To install the Spectrum Protect client do zypper install ox-hfs-spectrum-protect.
  3. Run /opt/tivoli/tsm/client/ba/bin/HFSconfigure.  This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.

It is also possible to install the 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/HFSconfigure as root after installation.

Upgrading the client

If you are upgrading from TSM 7 or you will need to uninstall your existing TSM client and then reinstall the new Spectrum Protect client.

Once you have this installed it will usually be updated alongside all your other software updates.  If you want to just update the Spectrum Protect client and not other packages, run the following commands as root:

zypper update ox-hfs-spectrum-protect

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

For Mandriva or Mageia systems.

Installing the client

You can install the client using urpmi:

  1. Make sure you are logged in as root.
  2. To install the Spectrum Protect client do urpmi ox-hfs-spectrum-protect.
  3. Run /opt/tivoli/tsm/client/ba/bin/HFSconfigure.  This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.

It is also possible to install the 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/HFSconfigure as root after installation.

Upgrading the client

If you are upgrading from TSM 6 or earlier we recommend you uninstall your existing TSM client and then reinstall the new Spectrum Protect client.

Usually the client will be updated alongside all your other software updates. If you want to just upgrade the Spectrum Protect client and not other packages, run the following commands as root:

urpmi ox-hfs-spectrum-protect 

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

For Manual RPM installation, if your system supports rpm packages.

Installing the client

Install the HFS rpm signing key:

rpm --import http://downloads.hfs.ox.ac.uk/repo/GPG-KEY

Download all the RPM files.

Install the required downloaded packages with:

rpm -i ox-hfs-repo-1.4.0-1.noarch.rpm ox-hfs-spectrum-protect-client-8.1.13.3-0.x86_64.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.    Note that the ox-hfs-repo package is installed even though you can not use a repository as it is a dependency of the ox-hfs-spectrum-protect package.

To automatically configure the client run /opt/tivoli/tsm/client/ba/bin/HFSconfigure. This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.

Upgrading the client

Follow the instructions above for installation only use rpm -U option in place of rpm -i

rpm -U ox-hfs-repo-1.4.0-1.noarch.rpm ox-hfs-sp-client-8.1.13.3-0.x86_64.rpm

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

For tar file installation, such as for Gentoo systems.

Installing the client

Download the gzipped tar file

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

After the software has been unpacked, to automatically configure the client run /opt/tivoli/tsm/client/ba/bin/HFSconfigure.  This will prompt for the Spectrum Protect server name, the Nodename, the node Password, and whether to start the scheduler.  If you are using a system with a startup script system significantly different to that used on Debian and Redhat systems, such as Gentoo, you may have to manually configure the scheduler to start.

For example:

cd /tmp
wget http://downloads.hfs.ox.ac.uk/clients/linux/8.1.13.3/ox-hfs-spectrum-protect-8.1.13.3-1.tgz
cd /
su -
tar -xhzf /tmp/ox-hfs-spectrum-protect-8.1.13.3-1.tgz
/opt/tivoli/tsm/client/ba/bin/HFSconfigure

Upgrading the client

Save the files dsm.opt, dsm.sys, incl.excl and dsmsched.rc (if they exist) from /opt/tivoli/tsm/client/ba/bin/ 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 back to /opt/tivoli/tsm/client/ba/bin/.

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

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

It is important to run an initial manual backup of your machine to:

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

Get support


Local IT support provide your first line of on-the-spot help

FIND MY LOCAL IT TEAM

 

Common requests and fault reports can be logged using self-service

   USE IT SELF-SERVICE    

   LOG A SUPPORT CALL    

VIEW MY SUPPORT CALLS  

The central Service Desk is available 24x7 on +44 1865 6 12345

 

If you do not have an SSO account you can use this form to contact the Service Desk