Tivoli Storage Manager Installing the Clients


Chapter 3. Installing UNIX Clients

This chapter provides instructions to install and set up TSM UNIX clients. A root user must install TSM on a UNIX workstation.

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Table 6 lists the supported UNIX clients and the location of the installation instructions for each client.

Table 6. UNIX Client Installation Reference

Installation Instructions Page
Installing the AIX Clients Installing the AIX Clients
Installing the AIX 5L Client Installing the AIX 5L Client
Installing the HP-UX Clients Installing the HP-UX Clients
Installing the Linux86 Client Installing the Linux86 Client
Installing the Linux390 Client Installing the Linux390 Client
Installing the NUMA-Q DYNIX/ptx Clients Installing the NUMA-Q DYNIX/ptx Clients
For information on Installing the OS/390 UNIX System Services Client, see the following publications:
  • Program Directory for Tivoli Storage Manager, S/390 Edition Backup-Archive Client (5698-TSM), order number GI10-4541
  • Program Directory for Tivoli Storage Manager, S/390 Backup-Archive Client (5697-TS9), order number GI10-4542
  • Program Directory for Tivoli Storage Manager, S/390 API (5698-TSM), order number GI10-4539
  • Program Directory for Tivoli Storage Manager, S/390 API (5697-TS9), order number GI10-4540

Installing the Silicon Graphics IRIX Clients Installing the Silicon Graphics IRIX Clients
Installing the Solaris Clients Installing the Solaris Clients
Installing the Tru64 UNIX Clients Installing the Tru64 UNIX Clients

Installing the AIX Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following packages are available on the installation media in the /usr/sys/inst.images directory:

tivoli.tsm.client.ba.aix43.32bit
Installs the backup-archive client files (command-line and GUI), administrative client (command-line), and HSM (4.3.3 only) into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.image.aix43.32bit
Installs the image backup component into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.web.aix43.32bit
Installs the Web client into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.nas.aix43.32bit
Installs the NAS backup component into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.books
Installs the PDF and HTML book files into the /usr/tivoli/tsm/client/books directory.

tivoli.tsm.client.ba.msg.lang
Installs NL messages for the Backup-Archive client. Where lang is the language identifier, for example Ja_JP for Japanese. American English messages are already included in the backup-archive client code. The default installation directory is /usr/tivoli/tsm/client/ba/bin/lang, where lang is the language identifier.

tivoli.tsm.client.api.aix43.32bit
Installs the 32 bit API into the /usr/tivoli/tsm/client/api/bin directory.

tivoli.tsm.client.api.aix43.64bit
Installs the 64 bit API into the /usr/tivoli/tsm/client/api/bin64 directory.

tivoli.tsm.client.api.msg.lang
Installs the NL messages for API. Where lang is the language identifier, for example Ja_JP for Japanese. American English messages are already included in the API client code. The default installation directory is /usr/tivoli/tsm/client/api/bin/lang, where lang is the language identifier.

tivoli.tsm.client.afs.aix43.32bit
Installs the AFS backup-archive client files (command-line and GUI), into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.dfs.aix43.32bit
Installs the DFS backup-archive client files (command-line and GUI), into the /usr/tivoli/tsm/client/ba/bin directory.

This installation procedure is designed to install directly from the CD-ROM from a local or remote-mounted CD-ROM drive.

If you are installing from a TSM image run, the following command from the directory to which you copied the TSM image:

   /usr/sbin/inutoc /usr/sys/inst.images

A .toc file is created in that directory.

Note:
Do not put any user created files into /usr/tivoli/tsm/client/ba/bin, the base directory into which the TSM product is installed. Any and all files in this directory might be deleted during installation processing. Include-exclude files, dsm.opt, and dsm.sys files should not reside in this directory.

When upgrading from ADSM version 3.1 to a later client version you should consider the following:

To install TSM from the CD-ROM:

  1. Log in as the root user, insert the CD-ROM into the CD-ROM drive device, and mount the CD-ROM drive.
  2. From the AIX command line, type smitty install and press Enter.
  3. Select Install and Update Software and press Enter.
  4. Select Install and Update From ALL Available Software and press Enter.
  5. At the INPUT device/directory for software prompt, press the F4 key and select the CD-ROM device containing the installation CD-ROM or specify the directory containing the installation images, and press Enter.
  6. At the SOFTWARE to install prompt, press the F4 key. Select the TSM filesets you want to install and press Enter.
  7. Select the options you want and press Enter to begin the installation.

The TSM files are installed in the /usr/tivoli/tsm/client/ba/bin directory. If you move the TSM files to another directory, you must perform the following steps:

  1. Make sure the permissions of the installed files have not changed.
  2. Update the symbolic links for the installed files in the /usr/bin directory and in the directory that contains symbolic links for each language package you install (for example, /usr/lib/nls/msg/en_US).
  3. Ensure that every user of TSM sets the DSM_DIR environment variable to the newly installed directory.

See Appendix B, Special Considerations for AFS/DFS on AIX for special considerations when installing and configuring the TSM client for AFS/DFS on an AIX workstation.

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the AIX 5L Client

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following packages are available on the installation media in the /usr/sys/inst.images directory:

tivoli.tsm.client.ba.aix51.64bit.base
Installs the backup-archive client files (command-line and GUI), administrative client (command-line) into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.ba.aix51.64bit.common
Installs the TSM common files into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.ba.aix51.64bit.image
Installs the image backup component into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.ba.aix51.64bit.web
Installs the Web client into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.ba.aix51.64bit.nas
Installs the NAS backup component into the /usr/tivoli/tsm/client/ba/bin directory.

tivoli.tsm.client.books
Installs the PDF and HTML book files into the /usr/tivoli/tsm/client/books directory.

tivoli.tsm.client.ba.msg.lang
Installs NL messages for the Backup-Archive client. Where lang is the language identifier, for example Ja_JP for Japanese. American English messages are already included in the backup-archive client code. The default installation directory is /usr/tivoli/tsm/client/ba/bin/lang, where lang is the language identifier.

tivoli.tsm.client.ba.aix51.64bit.api
Installs the 64 bit API into the /usr/tivoli/tsm/client/api/bin64 directory.

tivoli.tsm.client.api.msg.lang
Installs the NL messages for API. Where lang is the language identifier, for example Ja_JP for Japanese. American English messages are already included in the API client code. The default installation directory is /usr/tivoli/tsm/client/api/bin/lang, where lang is the language identifier.
Note:
The AIX 5L client does not support the AFS/DFS backup-archive client.

This installation procedure is designed to install directly from the CD-ROM from a local or remote-mounted CD-ROM drive.

If you are installing from a TSM image run, the following command from the directory to which you copied the TSM image:

   /usr/sbin/inutoc /usr/sys/inst.images

A .toc file is created in that directory.

Attention: Do not put any user created files into /usr/tivoli/tsm/client/ba/bin, the base directory into which the TSM product is installed. Any and all files in this directory might be deleted during installation processing. Include-exclude files, dsm.opt, and dsm.sys files should not reside in this directory.

When upgrading from ADSM version 3.1 to a later client version you should consider the following:

To install TSM from the CD-ROM:

  1. Log in as the root user, insert the CD-ROM into the CD-ROM drive device, and mount the CD-ROM drive.
  2. From the AIX command line, type smitty install and press Enter.
  3. Select Install and Update Software and press Enter.
  4. Select Install and Update From ALL Available Software and press Enter.
  5. At the INPUT device/directory for software prompt, press the F4 key and select the CD-ROM device containing the installation CD-ROM or specify the directory containing the installation images, and press Enter.
  6. At the SOFTWARE to install prompt, press the F4 key. Select the TSM filesets you want to install and press Enter.
  7. Select the options you want and press Enter to begin the installation.

The TSM files are installed in the /usr/tivoli/tsm/client/ba/bin directory. If you move the TSM files to another directory, you must perform the following steps:

  1. Make sure the permissions of the installed files have not changed.
  2. Update the symbolic links for the installed files in the /usr/bin directory and in the directory that contains symbolic links for each language package you install (for example, /usr/lib/nls/msg/en_US).
  3. Ensure that every user of TSM sets the DSM_DIR environment variable to the newly installed directory.

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the HP-UX Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following source packages are available on the installation media:

tsmcli/hp11/TIVsmC
In this package the software selection name used by swlist for the top level product name is TIVsm. The components under TIVsm are TIVsm.CLIENT, TIVsm.CLIENT_API, and TIVsm.CLIENT_DOC.

TIVsm.CLIENT
Contains the backup-archive client (command-line and GUI), administrative client (command-line), and the Web client.

TIVsm.CLIENT_API
Contains the 32-bit API.

TIVsm.CLIENT_DOC
Contains the documentation.

tsmcli/hp11/TIVsmCapi64
In this package the software selection name used by swlist for the top level product name is TIVsm64. The component under TIVsm64 is TIVsm.CLIENT_API.

TIVsm.CLIENT_API
Contains the 64-bit API

tsmcli/hp11/TIVsmCapi
In this package the software selection name used by swlist for the top level product name is TIVsm. The component under TIVsm is TIVsm.CLIENT_API.

TIVsm.CLIENT_API
Contains the 32-bit API

To remove previous ADSM client versions, log in as the root user and enter the following command:

   /usr/sbin/swremove -x mount_all_filesystems=false -v IBMADSM

To remove previous TSM client versions, log in as the root user and enter the following command:

   /usr/sbin/swremove -x mount_all_filesystems=false -v TIVsm.CLIENT
Note:
If you also installed the CLIENT_API and CLIENT_DOC filesets, execute the following command to remove them:
   /usr/sbin/swremove -x mount_all_filesystems=false -v 
   TIVsm.CLIENT_API TIVsm.CLIENT_DOC                

To install from the CD-ROM, Log in as the root user, mount the CDROM to /cdrom, change directory to tsmcli/hp11. If you downloaded from ftp, go to the directory where the installable image is located. Enter the following command:

   swinstall -x mount_all_filesystems=false -v -s 'pwd'/
   TIVsmC TIVsm
Note:
replace 'pwd' with the absolute name of the current directory.

To install only the API or the documentation, omit the last TIVsm from the command above, and mark only the fileset for installation in the swinstall user interface you want to install. The Client needs the API for Raw Logical Volume backup. Therefore, if you mark CLIENT for installation the API must also be installed.

During installation:

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the Linux86 Client

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following installation options are available in uncompressed packages on the CD:

tsmcli/linux86/TIVsm-BA
Installs the backup-archive client (command-line and GUI), administrative client (command-line), and the Web client.

tsmcli/linux86/TIVsm-API
Installs the API.

If there is a previous unsupported Linux client installed, you must uninstall the unsupported Linux client.

To delete previously installed TSM client packages, log in as root and enter:

   rpm -e TIVsm-BA
and for the API:
   rpm -e TIVsm-API
Note:
The package version number is not needed for uninstall.

Use the following procedure to install the TSM clients:

  1. Log in as the root user and mount the CD-ROM to /cdrom.
  2. Enter the following directory path where the installation packages reside on the CD:
    /cdrom/tsmcli/linux86
    
  3. Enter the following command to install the backup-archive client (command-line and GUI), the administrative client (command-line), and the Web client:
    rpm -i TIVsm-BA.i386.rpm
    
    Note:
    To circumvent the dependence check use the --nodeps option. You must check the dependencies manually.
  4. Enter the following command to install the API:
    rpm -i TIVsm-API.i386.rpm
    
    Note:
    To circumvent the dependence check use the --nodeps option. You must check the dependencies manually.

During installation :

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the Linux390 Client

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following installation options are available in uncompressed packages on the CD:

tsmcli/linux390/TIVsm-BA
Installs the backup-archive client (command-line and GUI), administrative client (command-line), and the Web client.

tsmcli/linux390/TIVsm-API
Installs the API.

If there is a previous unsupported Linux client installed, you must uninstall the unsupported Linux client.

To delete previously installed client packages, log in as root and enter:

   rpm -e TIVsm-BA
and for the API:
   rpm -e TIVsm-API
Note:
The package version number is not needed for uninstall.

Use this installation procedure to install directly from the CD-ROM from a local or remote-mounted CD-ROM drive:

  1. Log in as the root user and mount the CD-ROM to /cdrom.
  2. Enter the following directory path where the installation packages reside on the CD:
    /cdrom/tsmcli/linux390
    
  3. Enter the following command to install the backup-archive client (command-line), the administrative client (command-line), and the Web client:
    rpm -i TIVsm-BA.s390.rpm
    
    Note:
    If all required libs are not installed with rpm please enter the following command:
    rpm -i --nodeps TIVsm-BA.s390.rpm
    
  4. Enter the following command to install the API:
    rpm -i TIVsm-API.s390.rpm
    
    Note:
    If all required libs are not installed with rpm please enter the following command:
    rpm -i --nodeps TIVsm-API.s390.rpm
    

During installation :

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the NUMA-Q DYNIX/ptx Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following installation options are available when installing the tsmcli/ptx/ptxtsmc.pkg package:

tsm
Installs the backup-archive client (command-line and GUI), administrative client (command-line), and the Web client.

tsmapi
Installs the API.

To remove previous TSM client versions, log in as the root user and enter the following command:

   pkgrm tsm tsmapi

Use the following procedure to install the TSM clients:

  1. Log in as the root user, insert the CD-ROM, and enter the following command:
       pkgadd -d /CD-ROM/tsmcli/ptx/ptxtsmc.pkg
    
    Note:
    Replace the word CD-ROM with the file system of the CD-ROM drive on your system.
  2. Select the package to install or press enter to install both packages.

The TSM backup-archive files are installed in the /opt/tivoli/tsm directory. The API files are installed in the /opt/tivoli/tsm/client/api/bin directory. If you move the TSM files to another directory, you must perform the following steps:

  1. Ensure the permissions of the installed files are not changed.
  2. Update the symbolic links for the installed files in the /opt/bin directory.
  3. Ensure that every TSM user sets the DSM_DIR environment variable to the new installation directory.

Kernel Parameter SHMGAP

To indicate the amount of dynamic memory that a user-process is allowed to use, the NUMA-Q DYNIX/ptx system provides the kernel parameter SHMGAP. The default value of SHMGAP is 2 MB.

If the value of SHMGAP has not already been increased, perform the following:

  1. Increase the value of SHMGAP to 32 MB.
  2. Rebuild the kernel.
  3. Reboot the system.

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the Silicon Graphics IRIX Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following packages are available within the install image on the installation media:

TSM.sw.base
Installs the backup-archive client (command-line and GUI) and administrative client (command-line).

TSM.sw.api
Installs the API.

TSM.sw.web
Installs the Web client.

To remove previous TSM client versions use the Software Manager (swmgr).

Use the following procedure to install the TSM clients:

  1. Log in as the root user and mount the CD-ROM to /cdrom.
  2. Enter the following directory path where the installation packages reside on the CD:
     /cdrom/tsmcli/sgi
    
  3. Log in as the root user, insert the CD-ROM, and enter the following command:
     /usr/sbin/inst -A -f `pwd`
    
    Note:
    `pwd` may be replaced with the absolute name of the current directory.
  4. To selectively install one or more components, enter the following command:
     /usr/sbin/inst -a -f `pwd` -I TSM.sw.base[,TSM.sw.api][,TSM.sw.web] 
    

    Notes:

    1. You can also use the Software Manager (swmgr) to install selectively.

    2. The Web-client uses files of the backup-archive client component. Ensure that both components are the same level.

During installation:

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the Solaris Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following installation packages in Solaris packaging format are available on the CD:

tsmcli/solaris/TIVsmCba.pkg
Contains the backup-archive client (command-line and GUI), the administrative client (command-line), and the Web client.

tsmcli/solaris/TIVsmCapi.pkg
Contains the API, shared libraries, and samples.

tsmcli/solaris/TivsmCdoc.pkg
Contains the documentation.

To remove previous versions of TSM, log in as root and enter:

pkgrm TIVsmCba TIVsmCapi TIVsmCdoc TIVsmChsm
Note:
TIVsmCapi cannot be uninstalled until the TIVsmCba is removed because the backup-archive client needs the API for Raw Logical Volume backup.

For older ADSM versions, enter:

pkgrm IBMadsm-w IBMadsm-c IBMadsm-a IBMadsm-h

Use the following procedure to install the TSM clients:

  1. Log in as the root user and mount the CD-ROM to /cdrom.
  2. Enter the following command and include the package name. For example, to install the backup-archive client, enter:
       pkgadd -d /cdrom/tsmcli/solaris/TIVsmCapi.pkg TIVsmCapi
       pkgadd -d /cdrom/tsmcli/solaris/TIVsmCba.pkg TIVsmCba
    
    Note:
    The Backup-archive client needs the API for Raw Logical Volume backup, so the API must be installed before the client.
  3. If you want to install the documentation, enter:
       pkgadd -d /cdrom/tsmcli/solaris/TIVsmCdoc.pkg TIVsmCdoc
    
  4. Answer Yes (y) to all questions during installation.
Note:
To display the TSM help browser menus in your locale language, ensure the NLSPATH environment variable in the /etc/profile file contains the following path:
   /usr/dt/lib/nls/msg/%L/%N.cat

During installation :

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.

Installing the Tru64 UNIX Clients

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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html

The following packages are available on the installation media:

tsmcli/tru64/TIVsmCba
Installs the backup-archive client (command-line and GUI), the administrative client (command-line), and the Web client.

tsmcli/tru64/TIVsmCapi
Installs the API.

To remove previous client versions, log in as the root user and enter the following command:

   /usr/sbin/setld -d TIVSMCBA TIVSMCAPI

Use the following procedure to install the TSM clients:

  1. Log in as the root user and mount the CD-ROM to /cdrom.
  2. Enter the following directory path where the installation packages reside on the CD:
     tsmcli/tru64
    
  3. Copy the filetru64/TIVsm.tar into the installation directory.
  4. Extract the tar file by entering:
     tar -xf TIVsm.tar
    
  5. Install the backup-archive client and the API package by entering:
     /usr/sbin/setld -l `pwd` TIVSMCBA TIVSMCAPI
    

    Notes:

    1. `pwd` may be replaced with the absolute name of the current directory.

    2. Omit TIVSMCAPI if you do not want to install the TSM API.

The TSM files are installed in the /usr/tivoli/tsm directory. The Web client files are installed in the client directory. If you move the TSM files to another directory, you must perform the following steps:

  1. Make sure the permissions of the installed files have not changed.
  2. Update the symbolic links for the installed files in the usr/bin directory.
  3. Ensure that every user of TSM sets the DSM_DIR environment variable to the new installation directory.

After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using TSM.


Setting Up and Starting TSM

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/support/storage_mgr/tivolimain.html.

After installation, required setup tasks include the following:

Task Page
Creating the Client System Options File (Required Root User or TSM Authorized User Task) "Creating the Client System Options File (Required Root User or TSM Authorized User Task)"
Registering Your Workstation with a Server (Required) "Registering Your Workstation with a Server (Required)"
Optional setup tasks include the following:
Task Page
Creating an Include-Exclude Options File (Optional Root User or TSM Authorized User Task) "Creating an Include-Exclude Options File (Optional Root User or TSM Authorized User Task)"
Creating a default Client User Options File (Optional Root User or TSM Authorized User Task) "Creating a default Client User Options File (Optional Root User or TSM Authorized User Task)"
Setting Environment Variables (Optional Root User or TSM Authorized User Task) "Setting Environment Variables (Optional Root User or TSM Authorized User Task)"
Creating a Customized Client User Options File (Optional User Task) "Creating a Customized Client User Options File (Optional User Task)"
Note:
Although creating an include-exclude list is optional, if you do not perform this task, TSM considers all files for backup services and uses the default management class for backup and archive services.

Required Setup Tasks Before Using TSM

This section provides instructions for the root user or TSM authorized user to perform the required tasks of creating a client system options file (dsm.sys) and registering your workstation with a TSM server.

Creating the Client System Options File (Required Root User or TSM Authorized User Task)

During the installation of TSM, the sample client system options file dsm.sys.smp is placed in the TSM default installation directory. Refer to the README file that is shipped on the product installation media for the location of the dsm.sys.smp file for your UNIX client.

The client system options file (dsm.sys) file is used to specify one or more TSM servers to contact for services, and communications options for each server. It can also include authorization options, backup and archive processing options, scheduling options, and HSM space management options.

If you are a root user or TSM authorized user, copy the dsm.sys.smp file to dsm.sys. It is assumed that the dsm.sys file is controlled by the system administrator.

Attention: If you must reinstall TSM, and you want to keep your existing dsm.sys file intact, do not copy the dsm.sys.smp file to dsm.sys.

Edit dsm.sys to include the TSM server or servers that you want to connect to. The following is an example of a client system options file stanza which contains the required options for a server you want users to contact. You can specify options for more than one server:

   Servername                server_a
   COMMmethod                TCPip
   TCPPort                   1500
   TCPServeraddress          almvmd.almaden.ibm.com
Note:
You may also specify the passwordaccess=generate option. See Passwordaccess for more information.

Required options for each server stanza are:

servername
Specify the name you want to assign to a server to contact for services, for example, server_a. See Servername for more information.
commmethod
Specifies the communication method you use to provide connectivity for client-server communication. See Commmethod for more information.
tcpport
Specifies a TCP/IP port address for a server. You can obtain this address from your administrator. See Tcpport for more information.
tcpserveraddress
Specifies the TCP/IP address for a server. You can obtain this address from your administrator. See Tcpserveraddress for more information.

Your client system options file (dsm.sys) can also include options to control backup and archive processing, authorization of stored files, and scheduling of TSM tasks. See Chapter 8, "Setting Processing Options" for more information.

Notes:

  1. See "Setting Options in a File" for more information about setting options in a file.

  2. See "Client Options Reference" for options that are supported on your platform, their possible values, and the syntactic rules for using them.

  3. See "Communication Options" for communication protocols supported for your UNIX client.

As the default, your client node contacts the first server identified in the client system options file (dsm.sys). You can specify a different server to contact by entering the servername option in your own client user options file (dsm.opt), or by entering that option with a TSM command.

You can also specify a default server and a migration server (if you have the HSM client installed on your workstation) in your client system options file (dsm.sys). For more information, see Defaultserver.

Registering Your Workstation with a Server (Required)

This is the final required step to complete before you can use TSM. You can complete the optional setup steps before or after you complete this one.

If you plan to use a Web client with an enterprise management server, ensure that you are assigned an administrative user ID with System privilege, Policy privilege, Client Access, or Client Owner authority.

Before you request services from a TSM server, you must register your workstation with that server. Your workstation is registered as a single client node for all users.

Your TSM administrator chooses whether registration is closed or open.

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, a root user can register your workstation as a client node with the server. Your workstation must be registered before anyone can use TSM on that node.

Use the dsm command to start a session with TSM using the graphical user interface. Use a dsmc command to start a session with TSM using the command-line interface.

The first time you start a TSM session, TSM prompts you for information necessary to register your workstation with a server identified in your client system options file (dsm.sys).

You need to supply the following information:

To register your workstation with additional servers, enter the dsm command or a dsmc command with the servername option for each server. For example:

   dsm -servername=dsmserv

where dsmserv is the name of a server identified in your client system options file (dsm.sys).

TSM prompts you for the information necessary to register your workstation with the server you specify.

When you use open registration:

If necessary, your TSM administrator can change these defaults.

Optional Setup Tasks Before Using TSM

Creating an Include-Exclude Options File (Optional Root User or TSM Authorized User Task)

An include-exclude list contains statements that identify any specific files you want to include or exclude from backup services. This list is contained in the dsm.sys client system options file. This list can also contain include-exclude statements obtained from include-exclude files which you specify with the inclexcl option.

For example, you can exclude core files, local caches of network file systems, files that contain compiled object code easily reproducible by other methods, and operating system files. See "Excluding System Files" for a minimum include-exclude list that you should include in your dsm.opt file.

You can enter broad statements that exclude entire groups of files. Then, if necessary, you can enter include statements to make exceptions to those broad statements.

If an include-exclude list or include-exclude file specified with the inclexcl option do not exist in the client user options file (dsm.opt), TSM considers all files for backup services and uses the default management class for backup and archive services.

For detailed information about creating an include-exclude list or specifying an include-exclude file in your client user options file (dsm.opt), see Chapter 7, "Creating an Include-Exclude List".

Another important use for an include-exclude options file 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".

Figure 1 is a sample include-exclude options file.

Figure 1. Sample Include-Exclude Options File

exclude /.../core
include /home/.../*  personal_files
include /home/davehil/dsnew/.../*
include /home/davehil/driver5/.../*  source_code
exclude /home/root/cron.log
 

The specification you enter for an include or exclude statement must end with a file name. You can use a wildcard in place of a specific file name. In the sample include-exclude options file, personal_files and source_code identify management classes to assign to specific files.

Creating a default Client User Options File (Optional Root User or TSM Authorized User Task)

During installation, TSM installs a sample client user options file called dsm.opt.smp into the default installation directory. Refer to the README file that is shipped on the product installation media for the location of dsm.opt.smp for your UNIX client.

Figure 2 shows the contents of the sample client user options file.

Figure 2. Contents of the Sample Client User Options File

   * SErvername       A server name defined in the dsm.sys file 

If you are a root user, you can create a default client user options file (dsm.opt) that can be used by all users on your workstation by using one of the following methods:

  1. From the TSM GUI:
    1. Click Utilities and then click Setup Wizard.
    2. Select Create a new options file.
    3. Follow the instructions on the screen.
  2. Copy dsm.opt.smp to dsm.opt or a new file name of your choice. The dsm.opt file must reside in the default installation directory or the directory pointed to by the DSM_CONFIG environment variable.

    Attention: If you must reinstall TSM, and you want to keep your existing dsm.opt file intact, do not copy the dsm.opt.smp file to dsm.opt.

You can then edit your dsm.opt file as appropriate for your system, or use the TSM preferences editor by clicking Edit and then click Preferences from the TSM GUI.

Your client user options file (dsm.opt) can include options to control backup and archive processing, authorization of stored files, and scheduling of TSM tasks. See Chapter 8, "Setting Processing Options" for more information.

Notes:

  1. See "Setting Options in a File" for more information about setting options in a file.

  2. See "Client Options Reference" for options that are supported on your platform, and detailed information about each option.

  3. See "Communication Options" for communication protocols supported for your UNIX client.

Creating a Customized Client User Options File (Optional User Task)

If you are a user and want to use different options than those specified in the default client user options file (dsm.opt), you can create your own client user options file.

In the client user options file, you can set options for communication protocols between the client and server, and backup, archive, restore, and retrieve processing. For example, you can use the domain option to specify the file systems for which you want TSM to perform incremental backup services. The default is all locally mounted file systems except /tmp.

If you specified more than one TSM server in your client system options file (dsm.sys), you can use the servername option to specify the server to use for backup-archive services. If you do not specify a particular server, the client program on your workstation contacts the default server in the client system options file (dsm.sys). You can override the specified server for backup-archive services by entering the servername option with a TSM command.

You can use one of the following methods to create your own client user options file:

  1. From the TSM GUI:
    1. Click Utilities and then click Setup Wizard.
    2. Select Create a new options file.
    3. Follow the instructions on the screen.
  2. Contact the root user on your workstation to determine the location of the sample client user options file dsm.opt.smp, and do the following:
    1. Copy dsm.opt.smp to your home directory as dsm.opt, or a new file name of your choice. You can store your client user options file in any directory to which you have write access.
    2. Set the DSM_CONFIG environment variable to point to your new client user options file. For instructions to set this variable, see section, Setting Environment Variables (Optional Root User or TSM Authorized User Task).

You can then edit your dsm.opt file as appropriate for your system, or use the TSM preferences editor by clicking Edit and then Preferences from the TSM GUI.

Notes:

  1. See "Setting Options in a File" for more information about setting options in a file.

  2. See "Client Options Reference" for options that are supported on your platform, and detailed information about each option.

  3. See "Communication Options" for communication protocols supported for your UNIX client.

Setting Environment Variables (Optional Root User or TSM Authorized User Task)

Set environment variables to identify the locations of certain TSM files. This is usually an optional step because most clients set these variables during installation. If you move the client code, you might need to change these variables.

There are three environment variables that you can set to point to files that TSM uses:

DSM_DIR
Points to the executable file dsmtca, the resource files, and the dsm.sys file. You cannot specify the root directory for DSM_DIR. If DSM_DIR is not set, the executables are expected in the default installation directory.

When you request an image or a NAS backup or restore, TSM uses the DSM_DIR environment variable to locate the corresponding plugin library. If DSM_DIR is not set, it will look for the plugin library in /usr/tivoli/tsm/client/ba/bin/plugins directory (AIX, AIX 5L) or /opt/tivoli/tsm/client/ba/bin/plugins (Solaris).

DSM_CONFIG
Points to the client user options file for users who create their own personalized options file. You cannot specify the root directory for DSM_CONFIG. If DSM_CONFIG is not set, the options file is expected in the directory pointed to by DSM_DIR. If DSM_DIR is not set, the options file is expected in the default installation directory. On Solaris, dsm.sys and dsm.opt are symbolic links to the actual files stored in /usr/bin which prevents the deletion of these files in the event that TSM is uninstalled.

DSM_LOG
Points to the directory where you want the dsmerror.log file to reside. The dsmerror.log cannot be a symbolic link. You cannot specify the root directory for DSM_LOG. The error log file contains information about any errors that occur during processing. The error log is intended for IBM service personnel to help you diagnose severe errors.

If you define DSM_LOG, TSM writes messages to dsmerror.log in the directory you specify.

If DSM_LOG is not defined, the log is written to the current working directory from which the client was invoked.

TSM issues a warning message if it cannot write to the log file, and continues processing.

Setting the Language Environment Variable

The language used for the AIX, AIX 5L, HP-UX, and Solaris clients is specified using the LANG environment variable. For example, to set the LANG environment variable to Japanese, type the following:

  export LANG=ja_JP

For all other UNIX platforms you can use American English only. See "National Language Support (NLS)" for a list of supported language locales.

For UNIX platforms that require CDE: Running the backup-archive GUI outside the CDE desktop could result in errors due to unresolved fonts. Ensure all required fonts are available for your language environment when running the backup-archive GUI outside the CDE desktop. When running the backup-archive GUI under Motif, and outside of the CDE desktop, add the following entry to the .Xdefaults file in your home directory:

 dsm*fontList: -dt-interface system-medium-r-normal-xs*-*-*-*-*-*-*
 -*-*:
Note:
To display the TSM help browser menus in your locale language, ensure the NLSPATH environment variable in the /etc/profile file contains the following path:
   NLSPATH=/usr/dt/lib/nls/msg/%L/%N.cat:$NLSPATH
   export NLSPATH

Setting Bourne and Korn Shell Variables

For the Bourne or Korn shell, enter the environment variables in the .profile file in your $HOME directory. For example:

   DSM_DIR=/home/davehil
   DSM_CONFIG=/home/davehil/dsm.opt
   DSM_LOG=/home/davehil
   export DSM_DIR DSM_CONFIG DSM_LOG

where /home/davehil/dsm.opt is the path and file name for your client user options file, and /home/davehil is the directory where you want to store the dsmerror.log file, the executable file, the resource files, and the dsm.sys file.

Setting C Shell Variables

For the C shell, add the DSM_DIR, DSM_CONFIG, and DSM_LOG variables to .cshrc in your $HOME directory. For example:

   setenv DSM_DIR /home/davehil
   setenv DSM_CONFIG /home/davehil/dsm.opt
   setenv DSM_LOG /home/davehil

where /home/davehil/dsm.opt is the path and file name for your client user options file, and /home/davehil is the directory where you want to store the dsmerror.log file.

Setting API Environmental Variables

If you have installed the TSM client API, set the following environment variables:

DSMI_DIR
Points to your installation directory. The files dsmtca, dsm.sys, and the language files must reside in the directory pointed to by DSMI_DIR. This environment variable must be present.

DSMI_CONFIG
Full path name of your own client user options file (dsm.opt).

DSMI_LOG
Path for dsmerror.log. (cannot be a symbolic link)
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. Ensure that directories in the environment variables are specified in the path statement. The location of the API library is especially important.

Starting TSM

Before you can start a session with the TSM graphical user interface, the X Window System must be running on your workstation. If you do not have the X Window System running on your workstation, you can use the TSM command-line interface.

If the X Window System is running and the TSM icon is on your desktop, TSM is running. You can double-click on the icon to open the TSM window.

If the TSM icon does not appear on your desktop, you must start TSM using one of the following commands:

dsm
Starts a TSM graphical user interface session in the foreground.
dsm &
Starts a TSM graphical user interface session in the background.
dsmc
Starts a TSM command line session.

From your workstation, you can use the rlogin command to log on to OS/390 UNIX System Services instead of using the 3270 terminal emulation so its behavior and appearance is more like UNIX.

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.

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 clicking Utilities and then Setup Wizard from the TSM GUI.

Note:
If you are working on an AIX workstation, and you want to back up or archive AFS or DFS files, check with the root user responsible for setting up TSM on your workstation to find out whether you can use the AFS or DFS versions of TSM. See Appendix B, Special Considerations for AFS/DFS on AIX for more information.

Starting TSM Automatically

You can start the TSM client scheduler automatically when you start your operating system. If the TSM administrator has defined schedules for your client node, starting the client scheduler allows TSM to back up your workstation automatically (or perform other scheduled actions). See TSM for UNIX Using the Backup-Archive Clients for more information about the client scheduler.

To start the client scheduler automatically, perform the following:

  1. Ensure that the passwordaccess option is set to generate in your client system options file (dsm.sys), and that you have connected to the TSM server at least once. This ensures that a password file is generated.
  2. For non-OS/390 UNIX: Add the following command to the /etc/inittab file:
    adsm::once:/usr/bin/dsmc sched > /dev/null 2>&1 # TSM scheduler
    
    Note:
    You must include the redirection to /dev/null in the command.
  3. For the OS/390 UNIX do the following:
    1. Create a shell script called /usr/lpp/Tivoli/tsm/client/ba/bin/rundsmc containing the following entries:
         cd /usr/lpp/Tivoli/tsm/client/ba/bin
         ./dsmc schedule
      
      Note:
      This prevents two jobs with same name from being created, and enables automatic shutdown.
    2. Add the following entries in the /etc/rc file to set environment variables to retrieve the servername and nodename options from dsm.sys and to start the TSM client scheduler, as follows:
        # Set environment variables to retrieve the servername and
        # nodename options from dsm.sys.
        export DSM_DIR=/usr/lpp/Tivoli/tsm/client/ba/bin
        export DSM_CONFIG=/usr/lpp/Tivoli/tsm/client/ba/bin/dsm.opt
        # Start the TSM Client scheduler and redirect outputs to
        # schedule.out instead of the /etc/log file.
        _BPX_JOBNAME='ADSMCLNT' /usr/lpp/Tivoli/tsm/client/ba/bin
        /rundsmc 1>/usr/lpp/Tivoli/tsm/client/ba/bin/
        schedule.out 2>&1 &
       
      
      Note:
      Enter the _BPX_JOBNAME entry on a single line in the /etc/rc file.

Managing the Client Scheduler Using the TSM Client Acceptor Daemon

The TSM Client Acceptor daemon (CAD) can manage the TSM Scheduler, reducing the number of background processes on your workstation. This also resolves memory retention problems that may occur when using traditional methods of running the scheduler. It is strongly recommended that you use the Client Acceptor daemon to manage the TSM Client Scheduler.

Use the managedservices option in your client user options file(dsm.opt) to specify whether the TSM Client Acceptor daemon manages the TSM Scheduler. See Managedservices for more information.

Set up of the CAD to Manage the Scheduler

Assuming the client scheduler is installed and configured, perform the following steps to set up the CAD to manage the client scheduler:

  1. Install the TSM Web client. See "Starting the Web Client" for more information.
  2. From the TSM GUI select Edit => Preferences => Web Client catagory. Check the Schedule option in the Managed Services options section. If you wish to run the Web client also, check the Web Client option. Otherwise, uncheck the Web Client option so the Web client cannot be used.
  3. Start the Client Acceptor. See "Starting the Web Client" for more information.

Starting TSM: Advanced Considerations

You can include TSM options when you issue dsm commands. For example, you can use options to modify the format used to display dates, times, and numbers, or you can use an option to include your password so that TSM does not prompt you for it. (However, if you include the password option, your password can be seen by anyone who sees you enter the command.)

You can use any of the following options when you start TSM:

For example, if more than one TSM server is available, and you want to use a different server for backup-archive services than the one specified in your client user options file (dsm.opt), you can enter the following, where server_b is the name of the server you want to contact:

   dsm -servername=server_b

See Chapter 8, "Setting Processing Options" for detailed information about these options.

Starting the Web Client

You can use the Web client to perform backup, archive, restore, and retrieve operations from any workstation, 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, specify the URL of the client workstation running the Web client in your Web browser; you will also need to specify the localhost port number. The default number should be 1581. The Web client is only supported on a server that is Version 3 or higher.

Note:
Entering a different URL or pressing the browser Back button during a backup, archive, restore, or retrieve operation disconnects the Web client and causes the current operation to end. However, network attached storage (NAS) operations will continue after disconnect.

To use the Web client, perform the following steps

  1. If you do not already have password files generated for TSM clients, specify passwordaccess generate in the dsm.sys 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. Start the TSM Client Acceptor daemon by entering the dsmcad command. The TSM Web client agent service automatically starts when needed.
    Note:
    The TSM Client Acceptor expects the TSM Web client agent (dsmagent) to be in the same directory. Therefore, if you modify your installation to start the TSM Client Acceptor from another directory via a symbolic link, you need to add a corresponding symbolic link for the TSM web client agent.

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

    All Web client messages are written to the Web client log file, dsmwebcl.log. Error messages are written to the error log file dsmerror.log, or the file specified by the errorlogname option. The dsmwebcl.log and dsmerror.log files are located in the directory specified by the DSM_LOG environment variable or in the current working directory. See Chapter 8, "Setting Processing Options" for more information.

  4. If you plan to use a Web client, ensure that you were assigned an administrative user ID with system privilege, policy privilege, client access, or client owner authority.
    Note:
    Use the revokeremoteaccess option to restrict an administrator with client access privilege from accessing your workstation through the Web client. Administrators with client owner privilege, system privilege, or policy privilege can access the Web client. For more information about the revokeremoteaccess option, see Revokeremoteaccess. For more information about TSM access authorities, see Appendix A, "TSM Client Authentication".
  5. You can access the TSM Web client using any browser that is Java 1.1.6-capable by entering the following URL:
    http://your_workstation_name:1581
    

    where your_workstation_name is the hostname of the workstation running the TSM Web client.

    Port 1581 is the default port number. You 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, which is only supported on the AIX and AIX 5L clients, see Appendix E, "TSM Web Client Secure Socket Layer" for additional information.


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