How to migrate to the new HFS on-site disk-based backup service: Instructions


The HFS backup service is changing, and to carry on using Spectrum Protect you will need to switch to the new HFS service. To do this, use the instructions below to install the HFS Hub app. Once the HFS Hub app is installed, it will take you through the process of switching over to the new HFS service. As part of the process you may also be prompted to upgrade Spectrum Protect, which is also done via the HFS Hub.

For Linux users who have command-line access only, there is a slightly different procedure, which is outlined below.

If you have any problems with backing up after completing the steps below, please see the final section of this page, on trouble-shooting.

Further background information about the migration process and the new HFS disk-based service is available on our web page about Migration to the new HFS on-site disk-based backup service.

Expand All

The process is very similar on Windows, Mac and Linux GUI systems. Firstly, one installs and runs the HFS Hub app.  Secondly, in most cases, one needs to upgrade Spectrum Protect.  Then, thirdly, Spectrum Protect is reconfigured so that one can then back up to the new HFS service.

1. Install the HFS Hub

Download the HFS Hub installer/package from the appropriate link below.

HFS Hub for Windows

HFS Hub for Debian based Linux (Ubuntu, Debian etc.)

HFS Hub for RPM based Linux (Fedora, OpenSUSE, Centos 8 etc.)

HFS Hub for older RPM based Linux (Centos 7, and possibly others with an older version of rpm)

HFS Hub for Mac (Intel)

HFS Hub for Mac (Apple Silicon)

You can then run the HFS Hub app. The first screen will display similar to that below.

hub first screen sp migration

Note that the HFS Hub app recognises that the IBM Spectrum Protect client software is already installed and configured. If the Upgrade button is displayed, then you need first to upgrade the IBM Spectrum Protect software before the migration process can proceed. In this case follow the upgrade process below.

2. Upgrade the Spectrum Protect client

Note: on Linux the Spectrum Protect client will be updated from the HFS repository just like your other software updates, so you typically will have updated the client with your usual updates. You can still use the HFS Hub to upgrade but it is just telling your system to update from the repository. 

Click the Upgrade button or (or select the Upgrade item from the Spectrum Protect menu). Follow the prompts to download and install the new Spectrum Protect client. The process may take a little time, during which you will be prompted to allow the hfshub-agent process to make changes that require elevated privileges on your machine. This process will on Windows also open a temporary window which tracks the progress of the various elements being installed. You should see a window message confirming the upgrade was successful. If not, please use the 'Save Logs' item from the Logs menu to collect diagnostics to include with any support call.

3. Reconfigure for the new HFS service

Now you can reconfigure this machine to use the new HFS service. Choose the Spectrum Protect menu and select the item 'Change node or server'.

HFS Hub move server 01

 At the next screen prompt check the details and confirm with the OK button:

HFS hub move server 02

At this point you will be asked to authenticate using your SSO before the screen below displays.

HFS hub move server 03

From the drop-down list choose the nodename that has been confirmed as the target account name on the new service. If you have more than one node, make sure you select the correct one. Ensure that the option 'Modify existing configuration' is selected and choose OK. A background process will run and prompt you to confirm/authorise changes requiring elevated privileges on your machine. All being well, the process will complete successfully.

If any error has occurred during the above process, select the Logs menu from the Hub and choose the 'Save Logs' item. Please then include the zip file with any support query.

A successful move will mean your Spectrum Protect settings will have been modified to allow you to connect to the new HFS server, at the same time retaining any local setting changes that had previously been made. The old configuration settings will have been saved in a file with a timestamp suffix for you to confirm this. Now is the time to start up Spectrum Protect and confirm connection to new server (choose Connection Information from the File menu in the GUI or note the information when connecting using the command line).

Scheduled backup services will have been set up and passwords cached. The scheduler now works as follows.  On Windows, the 'TSM Client Scheduler' is set up to be controlled by the 'TSM Client Acceptor'; essentially a wrapper script that allows the scheduler to stop and start at the allotted times. If you wish to check in Services, you should normally only see the 'TSM Client Acceptor' running and it is this service that should be stopped and started if that is ever required. On Linux you should see a dsmcad process in the process tree and this performs an identical role as a wrapper script for running the dsmsched process. 

Before you start, you will need to make sure to upgrade your Spectrum Protect software to the latest available version. Normally the Spectrum Protect client would be upgraded alongside all your other software updates from the HFS repository.

You will also need the name of the target nodename on the new service, and the name of the Spectrum Protect server to which it will connect (one of OX_HFS_P11, OX_HFS_P22, OX_HFS_P31 or OX_HFS_P42). You should have received both of these from the HFS Team prior to this process. You will also need the node password, which you can get from the HFS Portal : click the tab for the node concerned to display the node details page, and in the left hand menu, choose the 'Change Node Password' option and note the password generated. Note that you should consider the node password to be a temporary token used to set up your client. It is not needed in daily operation once your system is configured. It fact will later be changed by Spectrum Protect. You simply generate a new one if you need to reinstall the client, for instance.

Run the /opt/tivoli/tsm/client/ba/bin/HFSconfigure script as root and answer the prompts with the information noted above.

As with the Linux GUI systems above, a successful reconfiguration will mean your configuration files dsm.sys and dsm.opt in the Spectrum Protect installation directory will have been modified to allow you to connect to the new server, at the same time retaining any local configuration edits that had previously been made. The old configuration file will have been saved with a timestamp suffix for you to confirm this. Now is the time to start the client (dsmc) and confirm connection to the new server (the Node Name: and the 'Session established: lines in the header information above the Protect> prompt).

Scheduled backup services will have been set up and passwords cached: you should see a dsmcad process in the process tree, which performs the role of a wrapper script for running the dsmc command that actually performs the scheduled backup.

In cases where the installation and reconfiguration does not complete successfully, please gather the configuration files (dsm.sys and dsm.opt) together with the hfs-sp-install.log file to send with any support call.

Old operating systems (legacy systems, i.e. those that cannot be supported on the new HFS service) will be consolidated onto HFS server OX_HFS_PD1.

You will be informed of the nodename to be used on the new HFS server. As it must fit the current naming scheme it may be different from the current name. This is particularly the case with desktops (if you do not like a revised name which you have been given, it can be changed provided it meets the naming scheme rules). You will also need the node password, which you can get from the HFS Portal : click the tab for the node concerned to display the node details page, and in the left hand menu, choose the 'Change Node Password' option and note the password generated.

On Windows legacy systems use the IBM Spectrum Protect GUI to do the reconfiguration:

  1. Start up the IBM Spectrum Protect GUI program, e.g. by clicking on the Windows logo in the bottom-left corner of the screen and typing 'Backup'.
  2. If the "ANS1361E Session Rejected: The specified node name is currently locked" error message pops up, click 'OK'.
  3. If the IBM Spectrum Protect login window asks for a nodename and node password, click 'Cancel' and click 'OK' when the 'ANS5053W The operation was stopped by the user' message' warning message comes up thereafter.
  4. Click 'Yes' when you see the 'Do you wish to continue for purposes of local backupset restore?' message.
  5. Go to Utilities > Setup Wizard.
  6. Select the 'Help me configure the Client Option File' option.
  7. Select 'Update my options file'.
  8. Update your nodename if needed. You will not need to do this if you kept your original nodename.
  9. Select 'TCP/IP' on the 'IBM Spectrum Protect Client/Server Communications' window.
  10. Change the Server Address to: '' and the Port Number to: '1500'.
  11. Accept the recommended include/exclude list and the file exclusion selections.
  12. Accept the recommended domains for backup.
  13. Apply the changes.
  14. Enter the new node password when asked.
  15. In Control Panel > Services, restart your 'TSM Client Scheduler' service.

On Linux/Unix command line only systems, you will need to edit your dsm.sys and dsm.opt files, which are located in /opt/tivoli/tsm/client/ba/bin on Linux or possibly /usr/tivoli/tsm/client/ba/bin on Solaris, Irix, and HP-UX.

Edit dsm.opt to modify the ServerName line:

ServerName OX_HFS_PD1

Edit dsm.sys as follows.  The fields for ServerName and TcpServerAddress will need to be changed; you may also find that you need to change those for TcpPort and, if your nodename has changed, NodeName:

ServerName OX_HFS_PD1
TcpPort 1500
NodeName put your node name here

Now run dsmc as root and enter your node password when prompted. Once you have successfully reconnected, restart your scheduler.

If you have problems after reconfiguring Spectrum Protect, please in the first place see the HFS Knowledgebase, especially item KBGEN0010 if manual backups work but scheduled ones are missed; or item KBGEN0011 if neither manual nor scheduled backups now work.

In the unlikely event that a local networking restriction is preventing you from accessing the new HFS service, please see the section entitled 'Requirements' in our page on background information about migrating to the new HFS on-site disk-based backup service.

Otherwise please contact us on

Get support

If you cannot find the solution you need here then we have other ways to get IT support