IBM Tivoli Storage Manager Client Version 5, Release 3, Level 2

Welcome to the IBM Tivoli Storage Manager Version 5.3.2 Windows 32-bit Backup-Archive client!

This file contains information you need for using both the base API and the Backup-Archive Client, as well as information that was not available for the printed publications.

Licensed Materials - Property of IBM

© Copyright International Business Machines Corporation 1990, 2005. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Readme file


What's new in the IBM Tivoli Storage Manager Version 5.3.2 Clients

What's new in the IBM Tivoli Storage Manager Version 5.3.0 Clients

Update history

APARs fixed in Version 5, Release 3, Level 2.0

The client APARs fixed in V5.3.2 can be found in IBM Tivoli Storage Manager technote 1218412:

All client APARs fixed in V5.3 can be found in the '5.3 Fixed Client APARs' section of Version Release Information in the Other Resources section on the Tivoli Storage Manager technical support web site at:

Backward compatibility

System requirements

Backup-Archive Client (Includes Base, Common, Image, NAS*, and Admin Client files)

Supported Hardware and Software

Software Requirements

Hardware Requirements

The online installation instructions display how much space is required for the selected installation options, and how much space is available on the hard disk.

Getting Started


Installing the Client

Install the 32-bit client on Windows x32 operating systems. Install the 64-bit client on Windows x64 and IA64 operating systems.

Supported features on Windows platforms
    |                          | 2000 |  XP   |  XP   |  2003  |  2003  |  2003  |
    |                          |      |32-bit |64-bit | 32-bit | 64-bit | 64-bit |
    |                          |      |       |  x64  |        |   x64  |  IA64  |
    |                          |      |       |       |        |        |        |
    | Journal Based Backup     | yes  | yes   | yes   |  yes   |  yes   |   no   |
    | On-line image backup     | yes  | yes   | no    |  yes   |  no    |   no   |
    |    using snapshot        |      |       |       |        |        |        |
    | Off-line image backup    | yes  | yes   | yes   |  yes   |  yes   |  yes   |
    | System object support    | yes  | yes   | yes   |  n/a   |  n/a   |  n/a   |
    | via legacy APIs          |      |       |       |        |        |        |
    | System State and System  | n/a  | n/a   | n/a   |  yes * |  yes * |  yes*  |
    | Service support via      |      |       |       |        |        |        |
    | Volume Shadowcopy        |      |       |       |        |        |        |
    | Services (VSS)           |      |       |       |        |        |        |
    | LAN-free operations      | yes  | yes   | yes   |  yes   |  yes   |  yes   |
    | Server-free operations   | yes  | no    | no    |  no    |  no    |   no   |
    | Automated System         | n/a  | yes   | yes   |  yes   |  yes   |  yes   |
    | Recovery (ASR)           |      |       |       |        |        |        |
    | Open File Support        | yes  | yes   | no    |  yes   |  no    |   no   |

    * - the TSM client must be connected to a Tivoli Storage Manager 
        version 5.2.0 or higher server.

If you are installing from a file downloaded from the anonymous FTP server, then the installation involves two phases:

  1. Extract the install image to your hard drive.
  2. Install the client from the install image.

During the first phase (extract the install image), you will be able to choose the directory to which the install image is extracted. The default is "c:\tsm_images". It is recommended that the install image be extracted to an empty directory. The extraction requires 50 MB of disk space for the base client, and 13 MB of disk space for each language pack.

After the second phase (install the client) is complete, the install image will remain on your hard drive. If the temporary installation directory (i.e., \tsm_images) is removed or there is no installation media present, the Setup Wizard will fail operations which require files from the installation media or temporary installation directory with the following error message:

1682       ANS3010E  The Logical Volume Snapshot Agent wizard operation failed.

To bypass this error, point the Setup Wizard to the temporary installation directory or the installation media.

Note: Installing additional features at a later date requires the TSM Client installation media.

Installation of TSM requires MSI version 2.0 or higher. Windows 2000 SP 3 and higher, Windows XP, and Windows 2003 already include MSI 2.0. Windows 2000 SP 2 or lower might require an upgrade to MSI 2.0. If you are running Windows 2000 SP 2, you can determine the version of MSI on your system as follows:

  1. Use Windows Explorer to navigate to the \WINNT\system32 directory.
  2. Locate file msiexec.exe.
  3. Right click on the file, then click "Properties" in the pop-up menu.
  4. Click on the "Version" tab.

When performing an interactive install, MSI will be upgraded, if necessary, when the TSM installation is started Following the MSI upgrade, a reboot will probably be required. TSM client installation will continue after the machine has rebooted.

For silent installs, the MSI upgrade will not occur automatically. Instead, the MSI must be manually upgraded before installing the TSM client. The MSI upgrade package, "instmsiw.exe", is included with the TSM client install package. Run "instmsiw /?" from an OS prompt for a list of install switches.

The msiexec REBOOT option can specify one of the following values:

Update to "Client Features" table:

Installing a custom dsm.opt file

If you want to install a custom dsm.opt file, place a copy of the file in the ..\config directory located within the install image:

        c:\tsm_images\TSM_BA_Client\baclient\Program Files\Tivoli\TSM\config

The file must be named dsm.opt.

The custom dsm.opt file will not be installed if a dsm.opt file already exists in the ..\baclient directory.

Installation of Microsoft MFC and C Runtime dlls

The following Microsoft dlls are installed to the system directory via Microsoft redistributable package:

The following TSM DLLs are installed in the system32 directory:

Install troubleshooting

If you are upgrading from a previous version of TSM and there are TSM services running (Client Acceptor, Scheduler, etc) the following error might be encountered during install:

        Error 1303. The installer has insufficient privileges to access this
        directory: (Install Drive):\Program Files\Tivoli\TSM\baclient\plugins.
        The installation cannot continue. Log on as an administrator or
        contact your system administrator.

Once this error occurs, you must quit the install. After quitting the install, the previous version is no longer installed. Stop the running TSM service(s) and retry the installation.

Removing online image backup or open file support during the upgrade

If you currently have Online Images Support and Open File support installed and wish to remove either or both when upgrading to the latest TSM Client, deselecting the features during the upgrade installation will not work. To remove either or both features, you will need to go to the "Utilities -> Setup Wizard" and remove them using the "Help me configure...." options.

If you receive a message during setup indicating that you do not have enough free space to install on a drive that is known to have sufficient free space, you might be able to proceed by updating an entry in the setup.ini file that is included with the install package. If your package is on CD, you will need to copy the entire package to a hard drive so that you can edit setup.ini. Once setup.ini is available on your hard drive, open it up in your favorite text editor and change the line:

        DiskSpace=8000  ;DiskSpace requirement in KB


        DiskSpace=0000  ;DiskSpace requirement in KB

How to completely remove TSM from your System

The Tivoli Storage Manager Backup-Archive client generates a variety of user preference information. Some of this resides on the file system and some of it resides in the Windows registry. TSM utilizes Installshield / MSI to handle installing and removing the program bits on the machine. In general, whatever is installed by the setup program is removed by the setup program during uninstall. This is not the case for preference data itself or for containers (registry keys/branches or directories) which contain preference data. In some cases the preference data may be shared with other TSM components or may be intentionally left behind to facilitate a reinstall which will allow the customer to leverage their previous customization settings.

This removal procedure is documented in IBM TSM technote 1141048:

Using Secure Socket Layer

Creating and using SSL certificates is documented in IBM TSM technote 1218512:

If you are installing from the CD-ROM and you have autorun enabled, the installation dialog should start when the Windows client CD is loaded. If autorun is not enabled, change to the "tsmcli\x32\client\Disk1" sub-directory of the CD-ROM, type "setup", and follow the directions in the dialog.

Uninstalling the client

  • Stop all instances of the TSM client (services, interactive clients, etc.) before performing the uninstall. Otherwise uninstalling the client will result in the following:
  • To remove TSM services, use the TSM GUI and select the "Utilities/Setup Wizard" menu item. You can also use the dsmcutil.exe command line utility to remove TSM services before uninstalling the client.
  • Open the Control Panel and double click on the "Add/Remove Programs" icon. In the "Add/Remove Programs" "Properties" window, in the "Install/ Uninstall" tabbed pane, highlight the "Tivoli Storage Manager Client" entry in the list box. Click on the "Add/Remove" button, then follow the dialog instructions.
  • Refer to Chapter 1, section "Upgrading, modifying, or reinstalling the client" in the Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User's Guide for uninstallation information.



    Setting up the Backup-Archive Client

    The Backup-Archive GUI will detect whether a TSM options file exists. If the options file can not be found (for example, if you are a first-time user), the client will launch a configuration wizard to assist you in configuring an options file.

    Refer to Chapter 2, "Configuring Tivoli Storage Manager" in the Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User's Guide for complete setup and configuration information.

    Updates, limitations, and known problems

    Documentation updates

    Known problems and limitations

    Contacting IBM Software Support

    IBM Software Support provides assistance with product defects.

    Before you submit your problem to IBM Software Support, ensure that your company has an active IBM software maintenance contract, and that you are authorized to submit problems to IBM. The type of software maintenance contract that you need depends on the type of product you have:

    If you are not sure what type of software maintenance contract you need, call 1-800-IBMSERV (1-800-426-7378) in the United States. From other countries, go to the "Contacts" page of the IBM Software Support Handbook at and click the name of your geographic region for phone numbers of people who provide support for your location.

    To contact IBM Software support, follow these steps:

    1. Determine the business impact of your problem.
    2. Describe your problem and gather background information.
    3. Submit your problem to IBM Software Support.

    Determine the business impact of your problem

    When you report a problem to IBM, you are asked to supply a severity level. Therefore, you need to understand and assess the business impact of the problem that you are reporting. Use the following criteria:

    Severity 1 The problem has a critical business impact: You are unable to use the program, resulting in a critical impact on operations. This condition requires an immediate solution.
    Severity 2 This problem has a significant business impact: The program is usable, but it is severely limited.
    Severity 3 The problem has some business impact: The program is usable, but less significant features (not critical to operations) are unavailable.
    Severity 4 The problem has minimal business impact: The problem causes little impact on operations, or a reasonable circumvention to the problem was implemented.

    Describe your problem and gather background information

    When describing a problem to IBM, be as specific as possible. Include all relevant background information so that IBM Software Support specialists can help you solve the problem efficiently. To save time, know the answers to these questions:

    Submit your problem

    You can submit your problem to IBM Software Support in one of two ways:

    If the problem you submit is for a software defect or for missing or inaccurate documentation, IBM Software Support creates an Authorized Program Analysis Report (APAR). The APAR describes the problem in detail. Whenever possible, IBM Software Support provides a workaround that you can implement until the APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the Software Support Web site daily, so that other users who experience the same problem can benefit from the same resolution.

    To receive technical support for Tivoli Storage Manager:

    On-line discussions

    To participate in user discussions of Tivoli Storage Manager you can subscribe to the ADSM-L list server. This is a user forum maintained by Marist College. While not officially supported by IBM, Tivoli Storage Manager developers and other IBM support staff also participate on an informal, best-effort basis. Because this is not an official IBM support channel, you should contact IBM Technical Support if you require a response specifically from IBM.

    You can subscribe by sending a note to the following e-mail address:


    The body of the message must contain the following:

          SUBSCRIBE ADSM-L yourfirstname yourlastname

    The list server will send you a response asking you to confirm the subscription request. Once you confirm your subscription request, the list server will send you further instructions. You will then be able to post messages to the list server by sending e-mail to:


    If at a later time you wish to unsubscribe from ADSM-L, you can send a note to the following e-mail address:


    The body of the message must contain the following:

          SIGNOFF ADSM-L

    You can also read and search the ADSM-L archives at the following URL:


    Anonymous FTP server

    IBM supports an anonymous FTP server where you can find PTF (fix pack) maintenance and other Tivoli Storage Manager-related materials. Three other anonymous servers are unofficially maintained by non-IBM volunteers. These servers are:

    Latest info


    The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both:

    Tivoli is a trademark of Tivoli Systems Inc. in the United States, or other countries, or both.

    Currently in books:

    Lotus Approach
    RISC System/6000
    Scalable POWERparallel Systems
    Tivoli Enterprise Console

    UNIX is a registered trademark of The Open Group in the United States and other countries.

    Microsoft, Windows, Windows 2000, Windows XP, and Windows Server 2003, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

    Intel and Pentium are trademarks of Intel Corporation in the United States, other countries, or both.

    Jaz and Zip are trademarks or registered trademarks of Iomega Corporation in the United States, other countries, or both.

    Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

    Unicode is a trademark of Unicode, Inc.

    Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

    Other company, product, and service names may be trademarks or service marks of others.

    Third party license terms and conditions, notices and information

    The license agreement for this product refers you to this file, or to a file referenced by this file, for details concerning terms and conditions applicable to third party software code included in this product, and for certain notices and other information IBM must provide to you under its license to certain software code. The relevant terms and conditions, notices and other information are provided in the "LICENSE.TXT" file on the root directory of the first installation CD-ROM for this product. The "LICENSE.TXT" file is also installed into the root installation directory as part of the installation process. Please note that any non-English version of the information in this file is unofficial and is provided to you for your convenience only. The English version of the file is the official version.