Installing and configuring the API

If you are using a IBM Storage Protect Data Protection application client, you must install and configure the IBM Storage Protect API.

Before you begin

Before you install and configure the API, verify that the client system meets the prerequisites for the application programming interface (API) software. You can download the latest software levels from the IBM Storage Protect product support website.

Note: If multiple Data Protection application clients are using LAN-free data movement, configure the API on each client system.

Procedure

1. Install the IBM Storage Protect client API.
2. Specify the environment variables. The IBM Storage Protect API uses unique environment variables to locate files.
  - DSMI_CONFIG is the fully qualified name for the client user option file.
  - DSMI_DIR points to the path that contains dsm.sys, dsmtca, and the subdirectory en_US.
  - en_US subdirectory must contain dsmclientV3.cat.
  - DSMI_LOG points to the path for the dsierror.log file.
  Tip: The quickest method to set the environment variables is to add these variables to the user profile file.
  
  The following examples show how to set up these environment variables in the user profile:
```
export dsmi_config=/usr/tivoli/tsm/client/api/bin/dsm.opt
export dsmi_dir=/usr/tivoli/tsm/client/api/bin
export dsmi_log=/home/user_a/logdir
```
```
export dsmi_config=/opt/tivoli/tsm/client/api/bin/dsm.opt
export dsmi_dir=/opt/tivoli/tsm/client/api/bin
export dsmi_log=/home/user_a/logdir
```
3. Edit an existing stanza or create a stanza in the dsm.sys file to specify the communications options between the IBM Storage Protect API and server.
  For example:
```
servername                server_c
commmethod                tcpip
enablelanfree             yes
lanfreecommmethod         tcpip
lanfreetcpserveraddress   test.example.com
lanfreetcpport            1500
tcpport                   1502
tcpserveraddress          server_c.example.com
```
  The example uses a TCPPORT of 1502. However, the default TCPPORT is 1500.
  
  If a dsm.sys file does not exist in the directory that is specified by DSMI_DIR, create a symbolic link to the dsm.sys file in the Tivoli Storage Manager client installation directory. For example:
```
ln -s /usr/tivoli/tsm/client/ba/bin/dsm.sys
       /usr/tivoli/tsm/client/api/bin/dsm.sys
```
```
ln -s /opt/tivoli/tsm/client/ba/bin/dsm.sys
       /opt/tivoli/tsm/client/api/bin/dsm.sys
```
1. Install the API.
2. Download the latest IBM Storage Protect Windows backup-archive client and the associated .bat file from the product support website.
3. Run the .bat file to extract the files, and follow the directions to begin the installation procedure.
4. In the Setup Type window, click Custom.
5. In the Select Components window, click Client Files > Change.
6. Select API Client Runtime Files and clear the check boxes for the other components.
  
  Tip: If you are upgrading the API, ensure that the installation directory that you specified is the same directory that the existing API is located.