Skip to main content

Install Spectrum Protect Client version 8.1 for Linux (EZ-Backup)

This article applies to: EZ-Backup

The software for the EZ-Backup service underwent major changes between version 7.1 and version 8.1. IBM changed the name to IBM Spectrum Protect (formerly Tivoli Storage Manager) and the look of the interface has changed. Most of the controls and procedures are either exactly the same or very similar.

Use these installation instructions for the following Linux distros:

  • SUSE Linux Enterprise Server (SLES) 11, 12, 15 (version
  • SLED 11
  • Red Hat Enterprise Linux 6 or 7 for Server or Desktop (64-bit)
  • RHEL 8 (for Spectrum Protect 8.1.9 and higher)
  • Ubuntu 14.04, 16.04, 18.04 (version
  • Other Linux Distros listed in IBM Tivoli's "Best Effort" Support Statement
  • Supported File Systems

These instructions assume that anyone administering a Linux system is technically savvy.

These instructions also assume the language used by the client is English and the locale code is either en_US or EN_US.

This procedure requires that the computer is registered with the EZ-Backup service. If this computer is not yet registered, please see our article on EZ-Backup Subscriptions.

If you have an earlier version of EZ-Backup installed, please use our Upgrade instructions instead of these instructions. 

Install the Client

  1. Review the README file for requirements (software and hardware) and limitations (filesystem types supported, known problems).
  2. Log on to the system as the root user.
  3. Download the tarball containing the packages to /tmp
  4. cd to /tmp
  5. Extract the following files from the tarball:
    • gskcrypt64-
    • gskssl64-
    • TIVsm-API64.x86_64.rpm
    • TIVsm-APIcit.x86_64.rpm
    • TIVsm-BA.x86_64.rpm
    • TIVsm-BAcit.x86_64.rpm
  6. cd to /tmp
  7. Install the 64-bit gskit package with this command (the following is all one command, not two separate commands):

    rpm -U gskcrypt64- gskssl64-
  8. Install the TSM 64-bit API packages with this command:

    rpm -i TIVsm-API64.x86_64.rpm TIVsm-APIcit.x86_64.rpm
  9. Install the TSM backup-archive (B/A) client packages with this command:

    rpm -i TIVsm-BA.x86_64.rpm  TIVsm-BAcit.x86_64.rpm

Notes on install

Configuring the Backup-Archive Client

  1. Change to default installation directory:

    cd /opt/tivoli/tsm/client/ba/bin/
  2. Using this template, create a file called dsm.sys, using the information provided in the EZ-Backup subscription confirmation email:
    • TSM Node Name
    • TSM TCP Server Addr(ess)
    • TSM TCP Port Addr(ess)
  3. Create a file called dsm.opt using the TSM TCP Server Addr(ess) provided in your EZ-Backup subscription confirmation email):

    /usr/bin/cat "SErvername <TSM TCP Server Addr(ess)>" > dsm.opt
  4. Input and store the initial password (provided in the EZ-Backup subscription confirmation email):

    /usr/bin/dsmc q sess

    Performing this step also validates the configuration information entered above.
  5. Change the initial password:

    /usr/bin/dsmc set password newpassword

Notes on Configuration

IBM Spectrum Protect documentation on configuring the client

By default, the TSM client for Linux will attempt to backup every file in the system. This is usually not the desired behavior; however, IBM Spectrum Protect does not deliver a set of default "exclude" statements for the Linux clients. You - in conjunction with your users - need to make decisions as to what to include and exclude, and then create a list of INCLUDE and EXCLUDE statements to control what information is backed up. This list can reside in the dsm.sys (beneath the information) or be referenced from the dsm.sys via an INCLEXCL option. For more on this, see the EZ-Backup documentation on creating INCLUDE and EXCLUDE rules (some of which being Windows-oriented has NTFS file naming, but the concepts are the same for Linux):

You can also read the more comprehensive IBM Spectrum Protect documentation starting with Creating an include-exclude list.

And you can direct questions to the EZ-Backup Team.

(optional) Configure the GUI (Java) Client

  1. On Linux systems, the TSM GUI (Java) client must be run from the X Window System.
  2. The GUI (Java) Client requires the Java Runtime Environment (JRE) 5 or 6. To verify you have the right JRE installed you can use "java -version" command from a UNIX terminal window. You can download the appropriate JRE from the following URL:
  3. Please note the "java" executable needs to be found in the system PATH. To add the java binary directory (denoted as JAVA_BIN_DIR) to your PATH as follows:

  4. Start the GUI (Java) Client by typing the following:


Notes on GUI client

IBM Spectrum Protect documentation on starting a GUI session

(optional) Configure Automated (Scheduled) Backups

Backups The TSM client for Linux can now be automated (scheduled) in two ways. The recommended method is to use the TSM Client Acceptor Daemon (CAD) to manage scheduled backups. This gives two advantages with respect to running the TSM client in schedule mode.

  1. The TSM client starts anew each backup, so changes to the configuration files (dsm.sys or dsm.opt) will take effect at the next backup without having to restart the scheduler
  2. The TSM client ends after each backup, so it doesn't persist and consume resources such as memory.

Regardless of method chosen, we strongly encourage encapsulating the commands in a script that properly sets the language code and locale. Because of the variety of scripting tools and Linux distributions, we do not illustrate that here; rather we recommend you read IBM Spectrum Protect's TSM and localization document.

Method 1: Configure Scheduled Backups Using the Client Acceptor Daemon

(assuming still logged in as root)

  1. Start the Client Acceptor Daemon (CAD) and specify to run in its own shell:

    >sh -c '/usr/bin/dsmcad > /dev/null 2>&1 &'

    Be sure to include the quotes as shown.
  2. Add the CAD to list of processes run after reboot; the simplest way is to put the following lines in /etc/rc.d/rc.local (or similar file for non-RedHat Linux):

    # Start the CAD for automated backups (EZ-Backup)
    sh -c '/usr/bin/dsmcad > /dev/null 2>&1 &'


Method 2: Configure the TSM Client in Schedule Mode

  1. Using an editor, remove the MANAGEDSERVICES SCHEDULE option from dsm.sys
  2. (assuming still logged in as root) Start the scheduler:

    sh -c '/usr/bin/dsmc sched > /dev/null 2>&1 &'

    Be sure to include the quotes as shown.
  3. Add scheduler to list of processes run after reboot; the simplest way is to put the following lines in /etc/rc.d/rc.local (or similar file for non-RedHat Linux):

    # Start the scheduler for automated backups (EZ-Backup)
    /usr/bin/dsmc sched > /dev/null 2>&1 &

Notes on Schedulers

That's it. You have successfully installed the EZ-Backup software on your computer. For more information on using EZ-Backup Spectrum Project and advanced configuration options, check out Online Information under /opt/tivoli/tsm/client/books/ or at the TSM Product Manuals page online.

Was this page helpful?

Your feedback helps improve the site.