Tivoli Storage Manager Installing the Clients


Chapter 4. Installing the OS/2 Client

This chapter provides instructions to install and set up TSM on an OS/2 workstation.

Attention

For current installation and configuration information for the TSM program product, refer to the README file that is shipped on the product installation media.

For current information concerning TSM, supported platforms, and documentation, refer to the TSM Web site at http://www.tivoli.com/storage.


Installing the OS/2 Client Program (Required)

This section describes two installation methods to install TSM using:

Installing the OS/2 Client

To install the OS/2 client from a CD-ROM:

  1. Insert the CD-ROM into the CD-ROM reader.
  2. Open an OS/2 window.
  3. Change to your CD-ROM drive. For example:
       cd k: 
    
  4. Change to directory \tsmcli\os2. For example:
       cd \tsmcli\os2
    
  5. Enter the dir command to display available languages. Decide which language you want to install. Enter a command to change to the language directory. For example:
       cd english
    
  6. Type install and press Enter.
  7. Follow the instructions displayed on the screen. Be sure to specify whether to launch the setup wizard after installation completes.
    Note:If the OS/2 GUI component installation is selected, the setup wizard is launched automatically if no dsm.opt file is present, to help you configure an initial options file. See "Client Options Reference" for options supported on your platform, and detailed information about each option.
  8. Restart your workstation.

Setting Environment Variables (Optional)

The TSM backup-archive client no longer sets the following environment variables in your config.sys file:

   set dsm_config=
   set dsm_dir=
 

If these variables currently exist in your config.sys file as a result of a previous installation, they are commented out using a 'rem' statement to avoid conflicts.

You can start the TSM client by double-clicking on the TSM Client desktop folder and selecting from the TSM component icons. Or, in an OS/2 window you can run the TSM client from the installed directory, the default directory is Tivoli\TSM\Client\BA.

If you want to run the TSM client from a directory other than the one where the code was installed, you can create an OS/2 command file that sets the environment variables and start the client. For example, in the command file, rundsmv3.cmd:

   set path=c:\Tivoli\TSM\Client\BA;%path%
   set beginlibpath=c:\Tivoli\TSM\Client\BA
   set dsm_config=c:\Tivoli\TSM\Client\BA\dsm.opt
   set dsm_dir=c:\Tivoli\TSM\Client\BA
   dsm.exe  

Updating Your config.sys File

To update your config.sys file, do the following:

  1. Add the directory where the executable files reside to the PATH statement. For example:
       set path=c:\Tivoli\TSM\Client\BA...
    
  2. If you installed the backup-archive graphical user interface, the backup-archive command-line interface, or the administrative command-line interface:
    1. Define the dsm_config environment variable to point to where your client user options file resides. For example:
         set dsm_config=c:\Tivoli\TSM\Client\BA\dsm.opt
      
    2. Define the dsm_dir environment variable to point to the directory where all other files reside. For example:
         set dsm_dir=c:\Tivoli\TSM\Client\BA
      
    3. Define the dsm_log environment variable to point to the directory where dsmerror.log should reside. For example:
         set dsm_log=c:\Tivoli\TSM\Client\BA
      

      The error log is intended for IBM service personnel to help you diagnose severe errors. If you do not define this variable, the log is written to the current directory.

  3. Add the directory where the dynamic linked libraries reside to the libpath statement. For example:
       libpath=c:\Tivoli\TSM\Client\BA; ...
    
  4. Shut down the system, and then restart it by pressing:
       ctrl+alt+del
    

Setting API Environment Variables

If the installation program did not automatically update your config.sys file, you may want to update that file yourself, using the following instructions.

You must set the environment variables in your config.sys file to point to the directories where your TSM API files are stored:

  1. Add the directory where the executable file resides to the PATH statement. The executable file dapismp.exe is created when you build the sample API application. For example:
       set path=c:\Tivoli\TSM\Client\API...
    
  2. Define the DSMI_CONFIG environment variable to point to where your client user options file resides. For example:
       set dsmi_config=c:\Tivoli\TSM\Client\API\dsm.opt
    
  3. Define the DSMI_DIR environment variable to point to the directory where all other files reside. For example:
       set dsmi_dir=c:\Tivoli\TSM\Client\API
    
  4. Define the DSMI_LOG environment variable to point to the directory where dsierror.log should reside. For example:
       set dsmi_log=c:\Tivoli\TSM\Client\API
    

    The error log file contains information about any errors that occur during processing.

Note:End users of applications developed with the API should consult the installation directions for that application for special path names or guidelines for options. The location of the API library is especially important.

Setting Up the Client Options File (Required)

TSM includes options that control processing for user sessions. These options are stored in the client options file, usually called dsm.opt.

The options you want to include in the client options file are to:

You can override an option in the client options file by entering a different value for the option with an appropriate TSM command. For more information about TSM options, see Chapter 9, Setting Processing Options.

Creating the Client Options File (Required)

TSM provides a sample client user options file named dsm.smp. If dsm.opt does not already exist, you must copy the sample file to create a default client options file, but you are not required to make any changes to it. If you did not create a client options file during installation, you can do so by performing the following steps:

  1. From the TSM GUI, select the Utilities menu> Setup Wizard item.
  2. Select the Help me configure the TSM Backup Archive Client checkbox.
  3. Select the create a new options file checkbox.
  4. Follow the instructions on the screen.

You can also create the required options file, by performing the following steps:

  1. Open an OS/2 window.
  2. Change the directory to the TSM directory, or wherever you stored the files.
  3. Enter the following command:
       copy dsm.smp dsm.opt
    

You can then edit your dsm.opt file as appropriate for your system. You can also use the TSM preferences editor by selecting the Edit menu> Preferences item from the TSM GUI.

If you want to modify dsm.opt, see "Client Options Reference" for options that you can use. See "Setting Options in a File" for information on how to set options in your dsm.opt file.

By keeping the sample file intact, you can always go back to the default settings for options if necessary. You can also create the dsm.opt file through the Drives window in the Presentation Manager OS/2 System folder.

For more information about the client options file, see Chapter 9, "Setting Processing Options".

Enabling Communications (Required)

One of the most important purposes of the options file is to define the communication protocol used between your workstation and the TSM server.

Use the commmethod option to specify a communication protocol. For example, to use the TCP/IP communication method, specify:

   COMMmethod TCPip

If you copied the dsm.smp file to dsm.opt, the commmethod options are already written in the file. You can customize the client options file for your environment. See "Communication Options" for communication protocols that are supported for the OS/2 client.

Setting Your Node Name (Required)

Use the nodename option to specify the name of your node so that you can register with the TSM server. If your installation is using closed registration, the TSM administrator must register you with the server and may select a name for you to use. Otherwise, in open registration, you can register your node with the server and select your own name. For more information about registration requirements, see Registering Your Workstation with the Server (Required).

Creating an Include-Exclude List (Optional)

An include-exclude list contains statements that identify any files you want to specifically include or exclude from backup services. This list is contained in the dsm.opt file.

For example, you might want to exclude all swap files, easily reproducible files (such as object files), and operating system files. You can enter broad statements that exclude entire groups of files. Then, you can enter include statements to make exceptions to those broad statements.

Another important use for an include-exclude list is to use include statements to assign specific management classes to specific files or groups of files. TSM uses a default management class for any files to which you do not explicitly assign a specific management class. For more information about management classes, see "Using Management Classes with Include".

If you do not create an include-exclude list, TSM considers all files for backup services and uses the default management class.

See "Excluding System Files" for the minimum recommended exclude list (assuming you boot from the c: drive). You can delete the lines that do not apply to your version of OS/2.

If you did not create an include-exclude list during installation, you can do so by performing the following steps:

  1. From the TSM GUI, select the Utilities menu> Setup Wizard item.
  2. Select the Help me configure the TSM Backup Archive Client checkbox.
  3. Select the update my options file checkbox.
  4. Follow the instructions on the screen to create your include-exclude list.

You can also create an include-exclude list, by performing the following steps:

  1. Determine your include and exclude requirements.
  2. Locate the include-exclude section in your dsm.opt file.
  3. Enter your include and exclude statements in the dsm.opt file. Because TSM processes your include-exclude list from the bottom of the list up, put all your include-exclude statements in the same section.
  4. Save the dsm.opt file.

Example of a Client Options File

Figure 3 shows an example of a client options file.

Figure 3. Example of a Client Options File

   ****   This is my options file.
   comm tcpip
   tcps 9.113.76.39
   tcpp 1500
   nodename mynodename
   subdir y
   replace yes
   scrolllines 20
   scrollprompt yes
   exclude ?:\...\swapper.dat
   exclude "*:\ea data.sf"
   exclude c:\ibmbio.com
   exclude c:\osldr
   exclude :\oskrnl
   exclude ?:\ibmdos.com
   exclude ?:\msdos.sys
   exclude ?:\io.sys
   exclude ?:\...\spart.par
   exclude ?:\...\386spart.par
   include *:\tsm\...\*  personal_files
   include *:\tsm\smith\new\...\*
   include *:\tsm\smith\driver5\...\*  source_code
   ****   This ends my options file.

Registering Your Workstation with the Server (Required)

If you plan to use a Web client with an enterprise management server, ensure that you were assigned an administrative user id with system privilege, policy privilege, client access, or clientowner authority.

Before you can begin requesting services from a TSM server, the server must recognize your workstation. TSM uses a node name and a password to identify each workstation. The process of setting up a node name and password is called registration. After your workstation is registered with a server, you can begin using TSM.

TSM provides two types of registration: open and closed. Your TSM administrator selects the type of registration for your site. If the administrator sets the authentication option to off, a TSM password is not required.

Using Closed Registration

With closed registration, a TSM administrator must register your workstation as a client node with the server.

If your enterprise uses closed registration, you need to provide the following information to your administrator:

Your administrator defines the following for you:

Using Open Registration

With open registration, you can register your workstation as a client node with the server.

The first time you start a session, TSM prompts you for information necessary to register your workstation with the server identified in your options file. You need to supply your node name, a password, and contact information.

When you use open registration:

If necessary, your TSM administrator can change these defaults later.


Starting TSM

To start the TSM Backup-Archive client:

If you are using an OS/2 window, you must start TSM from the TSM directory or include the directory in the start command unless you update your config.sys file to include the directory in your path.

When the GUI client initially starts up, and does not find an options file, you are presented with a setup wizard that will guide you through the process of configuring your client. You can also use the setup wizard by selecting the Utilities menu> Setup Wizard item.

Your TSM administrator can require you to use a password to connect to the TSM server. TSM prompts you for the password if one is required. Contact your administrator if you do not know your password.

Starting TSM Automatically

You can start the TSM client scheduler automatically when you start your machine. If the TSM administrator has defined schedules for your client node, starting the client scheduler permits TSM to back up your machine automatically (or perform other scheduled actions). See TSM for OS/2 Using the Backup-Archive Client, order number SH26-4099, for more information about the client scheduler.

To start the client scheduler automatically, you can use one of the following methods:

  1. From the TSM main window, select the Utilities menu> Setup Wizard item, and select the Help me configure the TSM Client Scheduler option.
  2. Add the following to your startup.cmd file:
     SET PATH=c:\tivoli\tsm\client\ba;%PATH%
     SET BEGINLIBPATH=c:\tivoli\tsm\client\ba
     SET DSM_CONFIG=c:\tivoli\tsm\client\ba\dsm.opt
     SET DSM_DIR=c:\tivoli\tsm\client\ba
     START /MIN DSMC.EXE SCHEDULE -PASSWORD=your_password              
    
    Note:In this example, your_password is your TSM password. (If you do not include your password, TSM prompts you for it-your password is more secure if you do not include it in your startup.cmd file.)

    Your communication program must be started and available before you start TSM. Be sure you add the statements required to start communications to startup.cmd before the entry for the TSM client scheduler.

  3. If your communication program has its own startup folder, you could add the schedule command to that folder. This would ensure that the communication software is running before OS/2 tries to start the TSM client scheduler.

Starting TSM: Advanced Considerations

You can include TSM options when you invoke TSM in an OS/2 command prompt, or by modifying the settings for the TSM icon. For example, you can modify the format used to display dates, times, and numbers, or you can include your password so that TSM does not prompt for it. However, if you include the password option, your password can be seen by someone who sees you enter the command or who looks in your icon settings.

These are some of the options you can use when you start TSM:

dateformat
domain
nodename
numberformat
password
timeformat

For more information on these and other options see "Client Options Reference".

For example, you might have two machines that back up data to a TSM server under separate node names. If you want to recover a file from one machine (MARY1) while at the other machine (MARY2), you can start TSM using the nodename option specifying MARY1:

   start dsm -nodename=mary1

Attention: Be careful if you use TSM in this way. Do not attempt to do an incremental backup from the MARY2 machine while connected to TSM as MARY1. If the drive labels are the same on the MARY1 and MARY2 machines, the incremental backup will expire any files that are not on the MARY2 machine, even if they still exist on MARY1. You could lose some valuable backup generations.


Starting the Web Client

You can use the Web client to perform backup, archive, restore, and retrieve operations from any machine, or platform that supports a Java 1.1.6-capable browser, such as Netscape Navigator 4.06 or higher, and Microsoft Internet Explorer 4.01 or higher. Using the Web client, you can back up and restore your own data, or a TSM administrator can centralize the backup or restore operations of many TSM clients. To use the Web client, simply point your Web browser at any TSM client machine that is running the Web client. The Web client is only supported on a server that is Version 3 or higher.

To use the Web client, perform the following steps:

  1. From the TSM GUI, select the Utilities menu> Setup Wizard item.
  2. Select the Help me configure the TSM Web Client checkbox.
  3. Follow the instructions on the screen to configure and use the TSM Web client.

You can also use the Web client by performing the following steps:

  1. If you do not already have password files generated for TSM clients, specify passwordaccess generate in the dsm.opt options file. See Passwordaccess for more information about options files.
  2. To create the TSM password file, start the native backup-archive client by entering:

    dsmc query session
    

    and, when prompted, enter your user ID and password.

  3. Quit from the native TSM backup-archive client.
  4. Start the TSM Client Acceptor background session by entering the dsmcad command. The TSM Web client agent service automatically starts when needed.

    The only options you can use with the dsmcad command are optfile, httpport, and httpsport.

    All the Web client messages are written to the Web client log file, dsmwebcl.log. Error messages are also written to the TSM error log file. The dsmwebcl.log file and the TSM error log file are located in the same directory specified by the errorlogname option.

    See Chapter 9, "Setting Processing Options" for more information.

  5. To use a Web client with an enterprise management server, ensure that you were assigned an administrative user id with system privilege, policy privilege, client access, or clientowner authority. If your server does not support enterprise management, then use your node name and password when prompted by the Web client. To determine whether your server supports enterprise management, contact your server administrator.
    Note:Use the revokeremoteaccess option to restrict an administrator with client access privilege from accessing your workstation through the Web client. Administrators with clientowner privilege, system privilege, or policy privilege can access the Web client. For more information see Revokeremoteaccess.
  6. You can access the TSM Web client using any browser that is Java 1.1.6-capable by entering the following URL:
    http://your_machine_name:1581
    

    where your_machine_name is the hostname of the machine running the TSM Web client.

    Port 1581 is the default port number. The administrator can set a different port number using the httpport option. See Httpport for more information about the httpport option.

    The Web client workstation can also be accessed through the TSM system administrative GUI.

If you want to use the Web client with secure socket layer (SSL) communications, then see Appendix E, "TSM Web Client Secure Socket Layer" for more information.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]