Tivoli Header

Tivoli Storage Manager Using the Application Program Interface


Understanding Configuration Files and Options Files

Configuration files and options files set the conditions and boundaries under which your session runs. The administrator, the end user, or you can set option values to:

On UNIX and OS/400 operating systems, the options reside in two options files:

On other operating systems, the client options file (dsm.opt) contains all of the options. Set up these files when you install the API on your workstation.

Note:
The API does not support these backup-archive client options:

You also can specify options on the dsmInitEx function call. Use the option string parameter, or the API configuration file parameter.

The same option can derive from more than one configuration source. When this happens, the source with the highest priority takes precedence. See Table 3 for the priority sequence. For more information about available options and communication methods that the API supports, see the Tivoli Storage Manager Installing and Using the Backup-Archive Client for your operating system.

Table 3. Configuration Sources in Order of Decreasing Priority

UNIX and OS/400 Intel Description
1. dsm.sys file (client system options)
1.-- Options that a system administrator sets (UNIX and OS/400 only).
2. Option string (client options) 2. Option string (all options) Takes effect when it is passed as a parameter to a dsmInitEx call. The list can contain client options such as compressalways, servername (UNIX and OS/400 only), or tcpserveraddr (non-UNIX).

With the API option string, an application client can make changes to the option values in the API configuration file and the client options file. For example, your application might query the end user if compression is required. Depending on the user responses, you can construct an API option string with this option and pass it into the call to dsmInitEx.

For information about the API option string format, see the options parameter located on page ***. You also can set this parameter to NULL. This indicates that there is no API option string for this session.

3. API configuration file (client options) 3. API configuration file (all options) The values that you set in the API configuration file override the values that you set in the Tivoli Storage Manager client options file. Set up the options in the API configuration file with values that you think will be appropriate in the TSM session for the end user. The values take effect when the API configuration file name is passed as a parameter in the dsmInitEx call.

You also can set this parameter to NULL. This indicates that there is no API configuration file for this session.

4. dsm.opt file (client options) 4. dsm.opt file (all options) On UNIX and OS/400 operating systems, the dsm.opt file contains the user options only. On other operating systems, the dsm.opt file contains all options. To override the options in these files, follow the methods that are described in this table.


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