HFS archive and retrieve service

Archive Service now closed to new applications

With effect from 04 February 2021 the HFS is no longer accepting new applications for the HFS Archive Service. This is due to the acceptance of DigiSafe https://www.it.ox.ac.uk/article/digisafe  as the formal archival repository for the University. Existing users are being asked to migrate their repositories to DigiSafe or another target of their choice though they can still access the current service while they do and the information below is retained for reference. It is currently planned that the HFS Archive Service will finally close by the end of 2022.

 

 

The configuration and use of the HFS archive / retrieve client software differs subtly from the HFS backup / restore client software.  For this reason you are strongly encouraged to read the following sections in order. 

Expand All

The HFS Archive client uses the same software as the HFS Backup client, namely IBM Spectrum Protect (previously known as TSM).

Ensure that you have registered for an Archive account and have your HFS Archive account name (also known as the nodename), this will be of the form PROJECTNAME_ARCHIVE.DEPT.

If you are not already using the HFS backup service on this machine then:

  1. Install the HFS archive software, providing the HFS archive account name when prompted for the nodename.
  2. Read Initial considerations before using the archive software 

 

If you are already using the HFS backup service on this machine, you will need to take the following steps:

  1. Download the template archive configuration file dsm-archive.opt.
  2. Edit the downloaded dsm-archive.opt file with Notepad, changing the Nodename value from CHANGE.THIS to the archive account name.
  3. Move the dsm-archive.opt file to the folder C:\Program Files\tivoli\tsm\baclient\.
  4. Create a new shortcut by right clicking on the Windows desktop and selecting New Shortcut.
  5. Provide the following location:
    "C:\Program Files\tivoli\TSM\baclient\dsm.exe" -optfile=dsm.opt.archive:
  6. Name the shortcut something like "HFS Archive Client".
    • You will now be able to access the HFS archive server with this shortcut and the HFS backup server with the usual shortcut.
  7. Read Initial considerations before using the archive software.

If you are not already using the HFS backup service on this machine then:

  1. Install the HFS archive software, providing the HFS archive account name when prompted for the nodename.
  2. Read Initial considerations before using the archive software 

 

If you are already using the HFS backup service on this machine:

  1. Download and install the HFS archive package.
  2. Provide the HFS archive account name when prompted.
    • The application TSMARchive will be installed on your Mac.
  3. Read Initial considerations before using the archive software

 

If you encounter errors in either install process, please send your TSM configuration and log files to hfs@ox.ac.uk for further help.

If you are not already using the HFS backup service on this machine then:

  1. Install the HFS archive software, providing the HFS archive account name as the nodename.
  2. Download the template options file dsm.sys (also reproduced below).
  3. Edit dsm.sys according to the comments at the top of the file.
  4. Save the file to the HFS software's installation folder, typically /usr/tivoli/tsm/client/ba/bin or /opt/tivoli/tsm/client/ba/bin.
    • You will now be able to access the Archive service with either dsm for the GUI or dsmc for the Command Line client.
  5. Read Initial considerations before using the archive software 

 

If you are already using the HFS backup service on this machine:

  1. Download the template options file dsm.sys (also reproduced below).
  2. Edit dsm.sys according to the comments at the top of the file.
  3. The edited options should be appended into the existing dsm.sys file.
    • The TSM Client program connects to the first server listed in the dsm.sys file, so will connect to the HFS backup server by default.  To connect to the HFS archive server the client will require a server name as an argument.
    • You will now be able to access the Archive service with either dsm -se=OX_HFS for the GUI or dsmc -se=OX_HFS for the Command Line client.
  4. Read Initial considerations before using the archive software

 

Template dsm.sys options file

*                  TSM Archiving on a Unix System

* This is the example dsm.sys file for use with Archive to the
* HFS at Oxford from a Unix client. As supplied, it must be
* edited as described below.

* In the line
*    Nodename                CHANGE.THIS
* you must alter the CHANGE.THIS to the registered name of
* your archive client node. This will (probably) be of the
* form something.archive or something_archive.dept

* As things are set up below, you will have to type in your
* password the first time you invoke the TSM software.
* It will then be stored on your client in encrypted form
* so that the scheduler can subsequently pass it to the
* server without needing input from you. TSM will change
* your password at roughly yearly intervals, and needs to
* tell you what the new password is when it does so. The line
*    Mailprog                MAIL-PROG root
* tells TSM to use the (mail) program specified by MAIL-PROG
* to mail this new password to root. You should replace
* MAIL-PROG by a suitable mail agent executable, and perhaps
* replace root by some more suitable username. For example
*    Mailprog                /usr/bin/mailx admin

* By default all users and members of all groups are permitted
* to use TSM (permissions on the executables being ok). To
* restrict this, uncomment the *Users and *Groups lines and
* substitute as argument a space-separated list of usernames
* and groupnames. If both lines are amended in this manner
* the users specified and all members of the groups specified
* will have access to TSM.

* The other lines set up default values for various options.
* You should not change any of these unless you know what you
* are doing (i.e. have read the TSM client manual), or under
* advice from IT Services.

* If your system is already using TSM backup, you will already
* have a dsm.sys file on your system. In this case copy the
* uncommented section below (after editing it as above) 
* and append it to the end of your existing dsm.sys
* file; the file will then have two "stanzas", one for backup and
* one for archive. You will note that the names both of the TSM
* server and your node name for use with archiving are different
* from the names used for backup. You must take care to retain
* these differences

* If your system is only using TSM Archive, then save this file
* after editing it.

* This file must be placed in different places in the filestore
* depending on your platform (and in some cases operating system
* version). The following table lists where it should go, provided
* you have installed TSM software at its default location.

*    IBM AIX                  /usr/bin/dsm.sys
*    SGI IRIX                 a symbolic link from
*                             /usr/tivoli/tsm/client/ba/bin/dsm.sys
*
*    Linux                    /usr/bin/dsm.sys
*    Sun Solaris 2.6/7/8/9    a symbolic link from
*    Sun Solaris 10           /opt/tivoli/tsm/client/ba/bin/dsm.sys

Servername              OX_HFS
CommMethod              TCPIP
TCPServeraddress        dsma.ox.ac.uk
TCPPort                 1500
Nodename                CHANGE.THIS
PasswordAccess          generate
Mailprog                MAIL-PROG root
Compression             no
*Users                  space-separated-list
*Groups                 space-separated-list
*VirtualMountPoint      directory-name
TCPBuffSize             32
TCPWindowSize           63
TCPNodelay              yes
TxnByteLimit            25600

* end-of-file

 

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