1. Introduction: Prerequisites & Obtaining the Software
This document contains installation instructions for the TSM version 6 client for Solaris on SPARC and x86. IBM supports this client to run on Solaris 10 and Solaris 11 (SPARC). It should not be installed on older versions. Note that IT Services no longer have any SPARC based machines available for TSM testing so although we can offer general support on use and configuration we may not be able to help with Solaris specific matters.
The current TSM client software is Version 6, Release 4, Level 1.0 for SPARC and Version 6, Release 2, Level 5.0 for x86.
The Backup/Archive client requires the following software in order to run:
You will also need a standard 100Mb/s (or faster) network connection to the University network or a connection to the Oxford eduroam wireless network (please see page on backing up over wireless for more details). The HFS only supports VPN-based backup for systems registered for VPN-based backup.
2. Upgrading from an earlier client version
To upgrade from an earlier version of the TSM Client for Solaris you should first remove the previous version as follows:
-
Copy
dsm.opt,dsm.sys, and (if it exists)incl.exclin/opt/tivoli/tsm/client/ba/binto somewhere safe, e.g. your home directory. -
Stop the scheduler daemon. If you have version 6 of the TSM client installed:
svcadm disable dsmsched
or for earlier versionssvcadm disable dsmcad
- Remove the scheduler daemon.
If you have version 6 of the TSM client installed:
svccfg delete svc:/network/dsmsched:default
or for earlier versions/opt/tivoli/tsm/client/ba/bin/uninstall_xml.sh
-
Uninstall the TSM software. If you have version 6.4 or higher installed
pkgrm TIVsmCba pkgrm TIVsmCapi pkgrm gsk8ssl64 pkgrm gsk8cry64
If you have version 6.2 installedpkgrm TIVsmCba pkgrm TIVsmCapi pkgrm gsk8ssl64 pkgrm gsk8cry64 pkgrm gsk8ssl32 pkgrm gsk8cry32
If you have version 5.3 to 6.1 installedpkgrm TIVsmCoucs
If you have version 5.2 or earlier installedpkgrm TIVsmCdoc pkgrm TIVsmCba pkgrm TIVsmCapi
- Follow the 3. Obtaining & Installing the TSM Client instructions to complete the upgrade.
3. Obtaining & Installing the TSM Client
3.1. SPARC systems
- Download the latest client for SPARC . There is one tarfile to download.
-
To install the new Solaris client ensure that you have uninstalled any
previous TSM Client software as detailed in the previous section,
then login as the root user and change directory to where the package has been downloaded. Extract the
tar file
tar xvf tsm-solaris-Sparc-6.4.0.1-1.tar
- Install the packages extracted from the tar file
pkgadd -a ./tsmadmin -d ./gsk8cry64.pkg all pkgadd -a ./tsmadmin -d ./gsk8ssl64.pkg all pkgadd -a ./tsmadmin -d ./TIVsmCapi.pkg all pkgadd -a ./tsmadmin -d ./TIVsmCba.pkg all
Answer yes if asked whether to create a directory -
Change to the TSM directory and extract the hfs-config.tar file
cd /opt/tivoli/tsm/client/ba/bin tar xvf (path to tar file)/hfs-config.tar
3.2. x86 systems
- Download the latest client for x86 . There is one tarfile to download.
-
To install the new Solaris client ensure that you have uninstalled any
previous TSM Client software as detailed in the previous section,
then login as the root user and change directory to where the package has been downloaded. Extract the
tar file
tar xvf tsm-solaris-Sparc-6.2.5.0-1.tar
- Install the packages extracted from the tar file
pkgadd -a ./tsmadmin -d ./gsk8cry32.pkg all pkgadd -a ./tsmadmin -d ./gsk8ssl32.pkg all pkgadd -a ./tsmadmin -d ./gsk8cry64.pkg all pkgadd -a ./tsmadmin -d ./gsk8ssl64.pkg all pkgadd -a ./tsmadmin -d ./TIVsmCapi.pkg all pkgadd -a ./tsmadmin -d ./TIVsmCba.pkg all
Answer yes if asked whether to create a directory -
Change to the TSM directory and extract the hfs-config.tar file
cd /opt/tivoli/tsm/client/ba/bin tar xvf (path to tar file)/hfs-config.tar
3.3. Initial Configuration
-
You now need to configure the software. How you do this depends on whether you are
upgrading or performing a new installation.
-
If you are upgrading from a previous version copy the
dsm.opt,dsm.sys, and (if it exists)incl.exclyou saved during the uninstall to/opt/tivoli/tsm/client/ba/bin. -
If you are performing a fresh installation
cd /opt/tivoli/tsm/client/ba/bin cp dsm.opt.example dsm.opt cp dsm.sys.example dsm.sys
You must now editdsm.optanddsm.systo insert yourNodename,Servername,TCPServer, andTCPPort. For details see Manually Configuring TSM for Linux/Unix. When you have done that rundsmc
. Hit return when asked for your user id (which accepts the default of the node name you configured indsm.sysand then enter your TSM password. This will be cached so you won't be asked for it in future. Typequitto exit the client.
-
If you are upgrading from a previous version copy the
- If you want to run the TSM scheduler (you usually do)
svccfg import /opt/tivoli/tsm/client/ba/bin/dsmsched.xml svcadm enable svc:/network/dsmsched:default svcadm refresh svc:/network/dsmsched:default
4. Configuration
/opt/tivoli/tsm/client/ba/bin/ and they
are dsm.opt.example and
dsm.sys.example.
In older versions there was an incl.excl where the
include and exclude statements were placed.
4.1. Editing the dsm.sys file
- VirtualMountPoint
-
The option
VirtualMountPointcan be used to logically partition your filespaces, but more usefully can give basic backup and restore functionality on unsupported filesystems. For more details on the virtualmountpoint option take a look at our page on supported Linux and Unix file systems.
4.2. Editing the dsm.opt file
- Domain
-
Amend the
Domainline to list the local filesystems you wish to have backed up. This list should be space-separated and may be specified on multiple lines to additively list a number of filesystems, as below:Domain / /usr /usr/local Domain /data/01 /data/02
Please avoid backing up filesystems such as /tmp and /var/tmp which contain nothing of a permanent nature. Please also avoid backing up NFS-mounted filesystems; these should be backed up from their home machine. A symbolic link to a filesystem cannot be included in theDomainlist.
4.3. Editing the include excludes
Traditionally include and exclude statements used to be placed in
incl.excl. Now they are put into
dsm.sys.
Include and Exclude statements offer a finer discrimination than the
Domain line in the dsm.opt
file, limiting what is backed up from within filesystems.
You should study the include and excludes within
dsm.sys, consider your filestore usage, and amend
the file to avoid backing up unnecessary files (for example, temporary
files used by programs and utilities, virtual machine images,
spool files, cached web pages and so forth).
Backup performance can be greatly improved by not backing up
unnecessary files.
If you have an old customized incl.excl file,
these statements will have been merged into the
dsm.sys file on an upgrade.
TSM processes the Exclude.fs then Exclude.dir before any of the Exclude file directives. Each group of directives is then processed working from the bottom to the top of the list. You can view the order of this processing by running:
dsmc query inclexcl
To quit the session, issue quit at the prompt. For further help on
includes/excludes see our page on
how to exclude files and folders from backup.
4.4. Log file location
TSM also writes a number of log files, the locations of which are controlled by the
variable DSM_LOG set in the wrapper shell scripts dsmc,
dsmj, dsmcad
in /usr/bin. By default these are set as below:
Note that the file dsmerror.log must be writeable by the
user running the TSM Backup Client program.
4.5. Running the TSM client as a non-root user
By default non-root users are not able to use the TSM software to back up and
restore their own files. Should you wish to enable this functionality, the setuid bit on the
/opt/tivoli/tsm/client/ba/bin/dsmtca executable must be set by
running the following command as the root user. Non-root users will then be able to backup and restore
only their own files. To backup and restore all files, please run TSM as the root user.
chmod 4555 /opt/tivoli/tsm/client/ba/bin/dsmtca
5. Initial Backup using the TSM Client
5.1. Introduction and CLI
Having installed the TSM Backup Client software, you will now want to back up your data. There are two methods for doing this, either using the command line tool or using the Java based GUI.
To use the command line tool, open a terminal and run
dsmc. This will give you a command line
interface (CLI). Or you can just run commands straight from the
shell. For example
dsmc incr /home
For more in depth usage of the CLI, see Using the TSM Client Command Line Interface for Backup & Restore
5.2. Select all local partitions
The Java based GUI requires X windows, ksh and Java to work.
From an X terminal run dsmj. The GUI
first displays a splash screen, and then the TSM Hub window is displayed as
below. From here you can select Backup under BACKUP.
This pops up another window as below.
To just back up all local disks, click on the grey box to the
left of the icon and the word Local. If you have
more data than the daily backup limit you may not want to do
this. Scroll down for other examples.
The Local node in the tree has been ticked.
Notice the parent node HFS-TEST-OUCS - this name
will be replaced with your TSM nodename.
5.3. Back up Local Filesystems
Now to back up the files, all that is required is to click on
Backup.
This will then show a progress bar as below.
It is also possible to see a report of current progress by
clicking on Report. If you want to
interrupt the backup process, click on the
Stop button.
Once the backup process has completed then a message will pop up. It is possible for this to become hidden behind another window.
5.4. Selecting local filesystems
It is possible to select some partitions to manually back up.
To view the individual filesystems click on the small circle to
the left of the tick box and the word Local. This
will expand the tree to display the filesystem partitions.
To select filesystem partitions click on the square grey box
to the left of the partition name. In the example below the
following partitions have been selected: /,
/boot, /usr and
/var.
To back up the files click on Backup. You may
want to follow the screenshots above in 5.3.
Back up Local Filesystems
.
5.5. Exploring the filesystem
It is possible to expand the tree to see what will be backed up. This is done by clicking on the small circle to the left of the tick box.
You may have noticed the red circle over /tmp/. This means
that it has been excluded in
dsm.sys.
If you click on the directory name or the icon to its left (in the example below
bin has been selected) then the files will be displayed in the right-hand pane.
5.6. Selecting a directory
It is possible to select a particular directory to back up.
In the example below it is /bin/. Notice
that I have clicked on the selector box and then clicked on
the folder icon or directory name (bin). This
shows that by selecting the directory, all the file and folder objects in that
directory are also selected in the right-hand window pane.
To back up the files click on Backup. You may
want to follow the screenshots above in 5.3.
Back up Local Filesystems
.
5.7. Selecting a file
It is possible to select a particular file to back up
(or even a number of individual files). In this
example it is /etc/ssh/sshd_config.
To back up the files click on Backup. You may
want to follow the screenshots above in 5.3.
Back up Local Filesystems
.
To cancel any individual selection, click the selector box to toggle it
off. To cancel all your selections first select the parent folder icon in
the left hand pane, then choose the [Deselect Items] option
from the [Edit] menu.
6. Changing your TSM password
The TSM password can be changed at any time. The initial password, given to you at registration for TSM Backup, should be changed as soon as the TSM client has logged into the TSM server. Thereafter, it should be changed at regular intervals and at least once a year as it expires after this interval. To this end, users are contacted, by mail, at the beginning of the last calendar month before their password expires, advising that the password should be changed.
6.1. Allowable passwords
Remember that the TSM password represents the security of your backups. Passwords should be strong and unguessable. TSM passwords are case-independent. In addition to letters and digits they can contain the characters + - _ . & (plus, minus, underscore, point, ampersand) and must be between 6 and 63 characters long.
6.2. Using the Command Line Interface (CLI)
To use the CLI to change the TSM password you must be the root user.
dsmc tsm> set password [oldpassword] [newpassword]
6.3. Using the GUI
In the GUI (which must be running as root), from the
[Utilities] menu choose the [Change Password]
option.
This will then display a change password dialog box.
Enter your password into Current password. Then enter your
new password into New password and again into
Verify password. Once this has been done quit the TSM
session and restart it to check that the new password has been set.
7. Troubleshooting
7.1. ANS1398E Initialization functions...
When running dsmc or dsmj and the following or similar is displayed:
ANS1398E Initialization functions cannot open one of the Tivoli Storage Manager logs or a related file: /var/log/dsmerror.log. errno = 13, Permission denied
This means that dsmc or dsmj cannot write to the log
file. Most likely this is beacuse you are running dsmc as a user who
cannot write to /var/log/dsmerror.log
Rather than allowing all users of the system to be able to write to the
/var/log/dsmerror.log file it is best to have
ErrorlogName /var/log/dsmerror.log
commented out of /opt/tivoli/tsm/client/ba/bin/dsm.sys
with a * at the beginning of the line. Then rather than using
dsmc from
/opt/tivoli/tsm/client/ba/bin/dsmc it is best to
use the HFS supplied wrapper script
/usr/bin/dsmc which sets the environmental
variable DSM_LOG to the users home directory. One expection here is
that when the home directory is / (probably the root user)
then DSM_LOG is set to /var/log/dsmerror.log.
The dsmj wrapper script is similar to the dsmc wrapper script.
The dsmcad wrapper script for scheduled backups always sets DSM_LOG to
/var/log/dsmerror.log.
8. Further Help
Sources of further help include:
-
If you have a query about the operation of the GUI, click on the
Helpbutton or pressF1. -
To access help in the command line client just press
hat thetsm>prompt. -
If you have a query about options in the configuration files
dsm.sysanddsm.opt, then please see the further instructions that appear as comments at the top of each file. -
If you have a problem or query check first the Help & FAQ pages to see if it is answered
there. If your query is still unresolved, then contact hfs@ox.ac.uk with as much detail as
possible, including copies of the files
dsm.sys,dsm.opt,dsmerror.logand, if the query relates to scheduled backup, thedsmsched.loganddsmwebcl.logfiles. -
If you have specific installation problems then email hfs@ox.ac.uk with
/opt/tivoli/tsm/client/ba/bin/tsm-install.log. This describes what the post installation scripts have attempted to do and highlight any problems. It may also be required to email the following files:dsm.sysanddsm.opt.

