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
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:
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.
When upgrading from ADSM version 3.1 to a later client version you should consider the following:
To install TSM from the CD-ROM:
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:
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.
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:
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:
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:
After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using 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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html |
The following source packages are available on the installation media:
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
/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
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.
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:
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
Use the following procedure to install the TSM clients:
/cdrom/tsmcli/linux86
rpm -i TIVsm-BA.i386.rpm
rpm -i TIVsm-API.i386.rpm
During installation :
After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using 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 Web site at: http://www.tivoli.com/support/storage_mgr/tivolimain.html |
The following installation options are available in uncompressed packages on the CD:
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
Use this installation procedure to install directly from the CD-ROM from a local or remote-mounted CD-ROM drive:
/cdrom/tsmcli/linux390
rpm -i TIVsm-BA.s390.rpm
rpm -i --nodeps TIVsm-BA.s390.rpm
rpm -i TIVsm-API.s390.rpm
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.
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:
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:
pkgadd -d /CD-ROM/tsmcli/ptx/ptxtsmc.pkg
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:
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:
After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using 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 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:
To remove previous TSM client versions use the Software Manager (swmgr).
Use the following procedure to install the TSM clients:
/cdrom/tsmcli/sgi
/usr/sbin/inst -A -f `pwd`
/usr/sbin/inst -a -f `pwd` -I TSM.sw.base[,TSM.sw.api][,TSM.sw.web]
Notes:
During installation:
After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using 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 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:
To remove previous versions of TSM, log in as root and enter:
pkgrm TIVsmCba TIVsmCapi TIVsmCdoc TIVsmChsm
For older ADSM versions, enter:
pkgrm IBMadsm-w IBMadsm-c IBMadsm-a IBMadsm-h
Use the following procedure to install the TSM clients:
pkgadd -d /cdrom/tsmcli/solaris/TIVsmCapi.pkg TIVsmCapi pkgadd -d /cdrom/tsmcli/solaris/TIVsmCba.pkg TIVsmCba
pkgadd -d /cdrom/tsmcli/solaris/TIVsmCdoc.pkg TIVsmCdoc
/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.
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:
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:
tsmcli/tru64
tar -xf TIVsm.tar
/usr/sbin/setld -l `pwd` TIVSMCBA TIVSMCAPI
Notes:
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:
After installation completes, see "Setting Up and Starting TSM" for required and optional tasks to perform before using 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:
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.
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
Required options for each server stanza are:
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:
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.
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.
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:
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.
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.
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:
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:
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:
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:
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:
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).
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.
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*-*-*-*-*-*-* -*-*:
NLSPATH=/usr/dt/lib/nls/msg/%L/%N.cat:$NLSPATH export NLSPATH
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.
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.
If you have installed the TSM client API, set the following environment variables:
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:
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.
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:
adsm::once:/usr/bin/dsmc sched > /dev/null 2>&1 # TSM scheduler
cd /usr/lpp/Tivoli/tsm/client/ba/bin ./dsmc schedule
# 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 &
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.
Assuming the client scheduler is installed and configured, perform the following steps to set up the CAD to manage the client scheduler:
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.
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.
To use the Web client, perform the following steps
dsmc query session
and, when prompted, enter your user ID and password.
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.
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.