Install the HFS Spectrum Protect software

The versions of macOS currently supported and the latest Spectrum Protect software versions for them are shown in the table. Note that Spectrum Protect is compiled for Intel processors. Use on Apple Silicon is supported using the Rosetta 2 translation layer.

To install Spectrum Protect using the HFS Hub

1. Download the HFS Hub for Mac installer
2. Run the installer and start the HFS Hub 
3. Click on the Install Spectrum Protect button
4. Follow the on-screen instructions    

Detailed instructions can be found on the HFS Hub page.

Installing using the HFS Hub is usually the best method on macOS. If this is not working for you please contact the HFS team for advice.

On macOS 10.15 (Catalina) and higher you must specifically allow Spectrum Protect to access your personal files otherwise it will be unable to back them up.  

1. Go to System Preferences > Security & Privacy > Full Disk Access (unlocking the padlock if needed)
2. Add the following items to the list:

1. Applications > IBM Spectrum Protect > IBM Spectrum Protect for Administrators
2. Applications > IBM Spectrum Protect > IBM Spectrum Protect
3. Applications > Utilities > Terminal
4. dsmagent
5. dsmcad

If 'dsmagent' and/or 'dsmcad' are not on the list, then click on the '+' sign and navigate to '/Library/Application Support/tivoli/tsm/client/ba/bin' where you can find them.

All of the above items must be present and ticked.

IBM officially fully supports the Spectrum Protect Linux client on recent Intel 64-bit Ubuntu, Red Hat Enterprise Linux and SUSE Linux Enterprise Server with additional minimal support for recent versions of 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 client software and we have successfully tested on a number of others. 

Spectrum Protect includes native support for the following filesystem types: Btrfs, ext2, ext3, ext4, xfs, JFS, NSS, ReiserFS, VxFS, and GPFS.

The HFS service provides a package repository containing customised packaged versions of the Spectrum Protect software that can be used for installation and update by most systems using Debian or RPM type packaging. The latest Spectrum Protect software version in the repository is 8.1.20.0.

For most Linux distributions you can install the Spectrum Protect client from the 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.

When installing using the HFS Hub you are doing the same things - the HFS Hub configures your system to use the repository then installs Spectrum Protect from the repository.

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

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 cannot install from the repository: it just means we have not tried it.

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 Spectrum Protect: you may be able to successfully install the client from rpm or tar files as described below.

To install Spectrum Protect using the HFS Hub

1. Download the Debian, RPM,  RPM for RHEL/Centos 7, or RPM for SLES 12 package
2. Install the package and run the HFS Hub
3. Click on the Install Spectrum Protect button
4. Follow the on-screen instructions    

Detailed instructions can be found on the HFS Hub page.

Note: You do not need to do this if you have installed Spectrum Protect using the HFS Hub.

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

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.5.0-1_all.deb

• RedHat based systems using the yum package manager (including RedHat Enterprise Linux, Fedora, Centos, Scientific Linux):

yum install ox-hfs-repo-1.5.0-1.noarch.rpm

• RedHat based systems using the dnf package manager (Fedora 22 and later):

dnf install ox-hfs-repo-1.5.0-1.noarch.rpm

• Other RedHat based systems, or if the package manager does not work:

rpm -i ox-hfs-repo-1.5.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 the HFS team 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 the HFS team 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

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 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, AlmaLinux, Rocky Linux, Scientific Linux.

Installing the client

You can install the client using yum or dnf:

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

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

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

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 but not the repository.

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.5.0-1.noarch.rpm ox-hfs-spectrum-protect-8.1.20.0-1.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.5.0-1.noarch.rpm ox-hfs-spectrum-protect-8.1.20.0-1.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.20.0/ox-hfs-spectrum-protect-8.1.20.0-1.tgz
cd /
su -
tar -xhzf /tmp/ox-hfs-spectrum-protect-8.1.20.0-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.