Chat now with support
Chat with Support

LiteSpeed for SQL Server 8.9.8 - Integration with TSM Guide

Configure LiteSpeed to Back Up Directly to IBM Spectrum Protect (TSM)

To configure LiteSpeed to back up directly to TSM

  1. Set up the machine from where you will run LiteSpeed so that it is a TSM backup-archive client node. This requires that you install the TSM backup-archive client and API files. For more information, see Install and Configure the IBM Spectrum Protect™ (TSM) Backup-Archive Client.

  2. Register the TSM client node with the TSM server. For instructions, refer to IBM Tivoli Storage Manager Implementation guide available at

You should now be able to conduct LiteSpeed backups and restores from the TSM client node.


Install and Configure the IBM Spectrum Protect (TSM) Backup-Archive Client

Install the IBM Spectrum Protect™ (TSM) backup-archive client on the server where LiteSpeed will be executing the backup/restore command. For instructions, refer to the IBM Tivoli Storage Manager Implementation guide available at

Ensure that you do a complete install of the backup-archive client. This will install API-specific files on the SQL Server.

Confirm that the installer has installed the API

Check that the following files have been installed in the API directory:

  • apienu.dll
  • dscenu.txt

Set up the client option file

If the TSM client API is installed with the default options then the options file (dsm.opt) is typically located in the C:\Program Files\Tivoli\TSM\baclient directory. At a minimum, the client option file must contain the following:

  • Tcpport

The client API needs the communication method and the IP address and TCP port of the TSM server to initiate a session. TCPSERVERADDRESS can use either the IP address or the computer name of the TSM server.

For general instructions on the client option file and information on additional options, refer to the IBM Spectrum Protect™ (TSM) Implementation guide and the IBM Spectrum Protect™ (TSM) API Documentation available at

Tip: You can create a new options file for use with LiteSpeed and locate it anywhere you like. ClosedClick here to see the contents of a sample options file.Following are the contents of a sample options file for LiteSpeed:

commmethod tcpip
tcpport 1500
nodename enc2033
passwordaccess generate
deduplication yes
dedupcachepath c:\cases
errorlogname c:\dsierror.log


Back Up and Restore to IBM Spectrum Protect (TSM) with LiteSpeed

To use LiteSpeed to back up and/or restore to TSM

Conduct a backup from the LiteSpeed UI Console, using the LiteSpeed command line utility or using LiteSpeed T-SQL commands in the normal manner, providing the TSM-required information using TSM specific arguments.

LiteSpeed needs some specific information for every backup data stream sent to the TSM server, including:

  • Location of the option file (Usually, C:\Program Files\Tivoli\TSM\baclient\dsm.opt.)

    NOTE: Tivoli Server uses the option file to start as a service with a set of default options. Some server options may affect backup/restore processes.

  • TSM object name specification, a three-part name used to uniquely identify the object within the TSM server namespace, for example, FS\HL\LL_xmlData. The three parts can be generally explained as:

    • File space—The name of the file system or disk drive where related data is located. The file system can hold a group of similar objects. All data sent to the TSM server needs to have a file space associated with it. IBM recommends that an application client should select a unique file space; it is recommended that LiteSpeed users follow this practice with a specific filespace reserved for LiteSpeed backups.
    • High level name—The location of the object within the TSM Server namespace (roughly synonymous to a directory path).
    • Low level name—The actual name given to the object.

    This name identifies the backup in TSM. It is not possible to overwrite or append to an existing object. If backing up to the same tsm objects with init option, they are "versioned" by the TSM server. New backups become active, old ones become inactive and removed as specified by the TSM servers' retention policies.

Depending on your TSM configuration, you may need to provide the following:

  • Client node that is accessing the TSM Server
  • Node owner password

For more information, see IBM Spectrum Project (TSM) Examples. on how to perform LiteSpeed functions with the TSM. 

NOTE: For information about backing up or restoring using the LiteSpeed UI Console, please see the LiteSpeed User Guide.


Troubleshoot Backing Up and Restoring to IBM Spectrum Protect (TSM)

LiteSpeed displays the return codes from the IBM Spectrum Protect™ (Tivoli Storage Manager - TSM) API. If an error occurs, refer to the list of TSM API error codes for a description of the error, the system action occurring in the event of the error, and the appropriate response. The TSM API error codes are listed in the IBM Spectrum Protect™ (Tivoli Storage Manager - TSM) Information Center.


Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating