Environment variables

The following are the variables that you must update and set in your client environment:

• PATH: This is the default search path that the operating system uses to locate executable files. Set this to include the fully qualified paths of the Tivoli Storage Manager client directories.

• DSM_CONFIG: Tivoli Storage Manager uses this environment variable to locate the client options file^dsm.opt. It points to the client user options file for users who create their own personalized options file.

• DSM_DIR: Tivoli Storage Manager uses this environment variable to locate all other client files. It points to the executable files DSMTCA and DSMSTAT, the resource files, and thedsm.sysfile (on UNIX only).

• DSM_LOG: This points to the directory where you want thedsmerror.logfile to reside. The error log file contains information about any errors that occur during processing. The error log is intended to help you diagnose severe errors.

10.2.1.2 Options file

Tivoli Storage Manager includes options that control processing for user sessions. For example, you can use options to inform Tivoli Storage Manager which communication method to use, or what format to use for dates.

We provide recommended options files for the various client platforms, as the layout of the supplied options file is not easy to understand. Section B.3, “Client options files” on page 297 contains our client option files.

The backup/archive client has at least one configuration file, which is divided into the following parts:

• Communication options

• Operational options

• Site-dependent options

• Include-exclude options

Some of the configuration steps that you perform from the client side may need complementary configuration on the Tivoli Storage Manager server side.

On all non-UNIX platforms, all options reside in the client options file^dsm.opt (Preferences file for Macintosh) which resides by default in the Tivoli Storage Manager client directory.

On UNIX, you can set options in three different files:

• Client system options file (dsm.sys): In the client system options file, a root user sets options that are required to establish communication with a Tivoli Storage Manager server, and options that authorize users on your workstation to use Tivoli Storage Manager services. A root user can also set options that affect backup and archive processing, and options that affect scheduled services.

• Client user options file (dsm.opt): In the default client user options file, a root user can set options that determine which Tivoli Storage Manager server your client node contacts, and that specify the formats to use for date, time, and numbers. A root user can also set options that affect backup, archive, restore, and retrieve processing. In addition, users can also create their own

personalized client user options file if they want to use different options. Users can overwrite an option contained in a client user options file by entering a different value for the option with an appropriate Tivoli Storage Manager command.

• Include-exclude options file: In the include-exclude options file, a root user can set options to exclude specific files from backup services. In addition, a root user can set options to associate specific files with different management classes. This file can be called any legal filename and be located in any directory, provided that you reference its full pathname in the ^dsm.optfile.

We provide recommended client options files for various client platforms,

because the layout of the supplied options file is not easy to understand. Section B.3, “Client options files” on page 297 contains our client option files. We assume that TCP/IP is the network protocol. Most options can be centrally set using client option sets. We also provide examples in B.1.2, “Define client option sets” on page 286 for various client platforms.

For more detailed information about client options, refer to the following Tivoli Storage Manager manuals:

• Tivoli Storage Manager for UNIX Using the Backup-Archive Clients, SH26-4105

• Tivoli Storage Manager for NetWare Using the Backup-Archive Client, SH26-4100

• Tivoli Storage Manager for Windows Using the Backup-Archive Client, SH26-4101

Communication options

Any Tivoli Storage Manager client needs some basic communication settings to send or receive data. You can choose any protocols that are supported in Tivoli Storage Manager to use in your environment, provided that both client and server are properly configured for them. Depending on the type of Tivoli Storage

Manager server, you may need extra help from the system administrator to have all the necessary communication definitions in place. The server may have multiple communication protocols configured. If that is the case, you may choose any of those to start communicating with the Tivoli Storage Manager server.

The following is a list of communication options you need to set:

• COMMMETHOD: The COMMMETHOD option specifies the communication method you are using to provide connectivity for client-server communication.

The Tivoli Storage Manager server configuration file (dsmserv.opt) must have specified the same communication method with a valid port address, so that the server can accept client requests.

• TCPSERVERADDRESS: This option specifies the TCP/IP address for a Tivoli Storage Manager server. This is either the IP address or the hostname of the Tivoli Storage Manager server. If you choose to use the hostname, make sure that there is a name resolution service (for example, DNS, local HOSTS file or WINS) in place for the TCP/IP configuration in the client machine. Otherwise, you may not be able to connect to the Tivoli Storage Manager server. Bear in mind that if you use name resolution to figure out a server address, you will depend on the name resolution protocol to be up and running. This may not be practicable in your environment. If you believe that name resolution may not be always available during your backup windows, consider using the IP addresses instead. Although it gives you less flexibility, it will work despite any name resolution service problem.

• TCPPORT: The TCPPORT option specifies a TCP/IP port address for a Tivoli Storage Manager server. By default, this value is 1500.

• TCPWINDOWSIZE: This option specifies the size, in kilobytes, of the TCP/IP sliding window for your client node. This setting is highly operating-system specific. You must only use the allowed values for your TCP/IP

implementation.

• TCPBUFFSIZE: This option specifies the size, in kilobytes, of the Tivoli Storage Manager internal TCP/IP communication buffer. This setting is highly operating-system specific. You must only use the allowed values for your TCP/IP implementation.

• NODENAME: This option assigns a new name to your client node if you do not want to use the default. The default is the hostname of your client machine, which we recommend using.

Operational options

The following list gives some examples of client options for backup, restore, and scheduling services.

• PASSWORDACCESS: This option specifies whether you want your Tivoli Storage Manager password automatically generated or always manually prompted for. We highly recommend setting PASSWORDACCESS to GENERATE.

• REPLACE: The REPLACE option specifies what you want Tivoli Storage Manager to do when it restores files that already exist on your workstation.

This option applies to the^restoreand ^retrievecommands only.

• SUBDIR: The SUBDIR option specifies whether you want Tivoli Storage Manager to include subdirectories of named directories. This option applies, for example, to^selective,^restore, ^archive, and^retrieve.

• TAPEPROMPT: This option specifies whether to wait for a tape to mount if it is required for a backup, archive, restore, or retrieve process, or to prompt you for a choice.

• SCHEDMODE: The SCHEDMODE option specifies whether you want to use the client-polling mode (your client node periodically asks the Tivoli Storage Manager server for scheduled work), or the server-prompted mode (the server contacts your client node when it is time to start a scheduled operation). All communication methods can use the client polling mode, but only TCP/IP can use the server prompted mode.

Site dependent options

If your locale is not the USA, then we recommend that you adjust the date, number, and time format options and also the language option in your client options file to support your requirements.

Include-exclude options

The include-exclude options must be placed as part of the client options file dsm.opton non-UNIX platforms, or in a separate include-exclude file on UNIX. On UNIX, you need to add the name of the file in your client system options file dsm.syswith the keyword INCLEXCL as shown as follows:

INCLEXCL /tsm/server1/inclexcl.file

The INCLUDE option specifies files within a broad group of excluded files that you want to include for backup services. You also use this option to assign a management class either to specific files or to all files to which you have not already assigned a specific management class, and for which you do not want Tivoli Storage Manager to use the default management class.

The EXCLUDE option excludes files from backup services. When you back up files, any files you exclude are not considered for backup. For example, we recommend you exclude the Tivoli Storage Manager installation directory.

Include-exclude options are checked from the bottom up to the top of the list until a match is found. If a match is found, the processing stops and checks whether the option is INCLUDE or EXCLUDE. If the option is INCLUDE, the file is backed up, using the assigned management class. If the option is EXCLUDE, the file is not backed up.

See B.1.2, “Define client option sets” on page 286 for examples of include-exclude lists.

10.2.2 Web backup/archive client

Three client options are important for the web client. The PASSWORDACCESS option must be set to GENERATE and the password must be generated by first running a backup/archive client session. The remote client agent establishes connection to Tivoli Storage Manager in the same manner as the backup/archive GUI and command line clients. It requires the generated client password to authenticate a client session when the web client is used.

The acceptor daemon listens on a TCP/IP port for incoming connections from an administrator’s web browser. By default it listens on port 1581. This default port can be overridden with the HTTPPORT client option.

The REVOKEREMOTEACCESS option has two possible values: NONE, which is the default, and ACCESS. If the option is set to NONE, any administrator userid with either client access or client owner authority can perform client operations. If the option is set to ACCESS, administrator userids with only client access authority are prevented from performing remote client operations. A pop-up message displayed in the web browser indicates that the administrator userid being used has insufficient authority. This option does not prevent administrators with client owner or higher authorities from performing client functions. Table 33 summarizes the web client options.

Table 33. Web client options

10.3 Interfaces

Tivoli Storage Manager client interfaces let you submit and receive information from the Tivoli Storage Manager server. In this section we describe how you can start, use, and stop the two available client interfaces: the command line and the GUI. Table 34 lists all available backup/archive client interfaces by platform.

Table 34. Backup-Archive client interfaces by platform Option

There are minor differences between the backup/archive client code among the platforms. For example, in Windows NT you have specific options to handle the NT Registry information, which are not found in any other platform. Despite those specific options, all commands are the same except for the filespace specification for each platform (in UNIX this uses the format/usr/tivoli, and in Windows, D:\newdir). Although the examples in this section are based on a UNIX machine, we also give examples of Windows commands.