The Tivoli Storage Manager (TSM) Application Program Interface (API) enables an application client to use the TSM functions. The API includes function calls that an application can use to perform the following operations:
When you, as an application developer, install the API, you receive:
Note: | When you install the API, all files which includes the library, message file, and, for UNIX, the dsmtca, must be at the same level. |
For information about installing the API, see Tivoli Storage Manager Installing the Clients.
Configuration files and options files set the conditions and boundaries under which your session runs. The administrator, the end user, or you can set the available options. The values of various options permit you to do the following:
On UNIX platforms, the Tivoli Storage Manager options reside in two separate options files: the client system options file (dsm.sys), and the client options file (dsm.opt). On other platforms, the options file, dsm.opt, contains all of the options. The end user sets up these files when the API is first installed on the user's workstation.
The application also can specify options on the dsmInitEx call. Use either 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, as
in the sequence that is displayed in Table 2:
UNIX | Intel |
---|---|
1. dsm.sys (client system options) | 1. N/A |
2. option string (client options) | 2. option string (all options) |
3. API configuration file (client options) | 3. API configuration file (all options) |
4. dsm.opt (client options) | 4. dsm.opt (all options) |
The different configuration sources, in order of decreasing priority, include:
The API options list permits an application client to make changes to the values of the options in the API configuration file and the client options file. For example, your application might ask the end user if compression is required. Depending on the user's answers, you can construct an API options list with this option and pass it into the call to dsmInitEx.
For information about the API options list format, see the options parameter located on page ***. You can also set this parameter to NULL, indicating that there is no API options list for this Storage Manager session.
You can also set this parameter to NULL, indicating that there is no API configuration file for this session.
For more information about the available options, see Tivoli Storage Manager Installing the Clients.
The API uses unique environment variables to locate files. This permits you to use different files for API applications from those that the interactive client uses. Applications can use the dsmSetup function call to override the values that are set by the environment variables.
Table 3 lists the API environment variables by platform.
Table 3. API Environment Variables
Variables | UNIX | Intel | Netware |
---|---|---|---|
DSMI_CONFIG | The fully-qualified name for the client options file. | The fully-qualified name for the client options file. | There are no environment variables. The dsm.opt, dscameng.txt, and dsierror.log files reside in the same directory as the dsmapi.nlm file. This directory becomes the search path for these files. |
DSMI_DIR | Points to the path containing dsm.sys, dsmtca, the en_US subdirectory, and any other national language support (NLS) language. The en_US subdirectory must contain dsmclientV3.cat. | Points to the path containing dscameng.txt and any NLS message file. |
|
DSMI_LOG | Points to the path for the dsierror.log file. | Points to the path for the dsierror.log file. |
|
TSM-Authorized User (UNIX Only)
The Trusted Communication Agent (TCA), a child process, normally controls access to the protected password file. It is possible to have the passwordaccess generate function without starting the TCA. To do this:
-rwsr-xr-x user1 group1 applA
passworddir /home/user1
Note: | When you are running in a multi-threaded mode and passwordaccess is generate, only the root, or TSM-Authorized user, is permitted access. The TCA child process, then, does not start. |