DB2 enabled Notes Configuration

Edit online

The configuration information that is required for DB2 enabled Notes operations is described.

DB2 enabled Notes operations require certain configuration tasks that must be done before you configure Data Protection for HCL Domino. The configuration tasks are presented.

Domino Server settings

In addition to DB2 enabled Notes configuration requirements specified in your Domino server documentation, the Domino Server must also be enabled for DB2. Run the DB2 Enablement tool to do this. See your Domino Server documentation for details about the DB2 tool.

DB2 settings

In addition to DB2 enabled Notes configuration requirements specified in your DB2 documentation, the following settings must also be implemented for the DB2 instance:

  • For best results, use a DB2 instance that manages DB2 enabled Notes databases only.
  • Configure the DB2 instance to use IBM Storage Protect:
    1. Set the system environment variables.
      • DSMI_DIR: Specify the installation directory for the IBM Storage Protect API. There are specific settings that must be used. See 32-bit and 64-bit settings for details.
      • DSMI_LOG: Specify the directory where the IBM Storage Protect API error log file dsierror.log is located.
      • DSMI_CONFIG: Specify the directory where the IBM Storage Protect API options file dsm.opt is located. This file must be the same dsm.opt file that is used by Data Protection for HCL Domino.
    2. Make sure the DB2 instance and Data Protection for HCL Domino use the same IBM Storage Protect server, node name, and password file. To ensure that the same information is shared, make sure the dsm.opt file that is used by DB2 points to the same IBM Storage Protect server stanza (to be used for DB2 enabled Notes backups) in the dsm.opt file that is used by Data Protection for HCL Domino. See How to configure DB2 and Data Protection for HCL Domino to use the same password file for detailed information about sharing the password file.

      Set the password by issuing this command as the note user: domdsmc query adsm –adsmpwd=password_value> This command must be issued because the dominstall program runs initial Data Protection for HCL Domino configuration tasks as the root user and therefore, cannot set the IBM Storage Protect password. The value of the passworddir option that is specified in the dsm.sys must specify a directory that is accessible to the Notes user.

    3. Restart the DB2 instance so that the environment variable settings are updated. Type in db2stop from a DB2 command window. Make sure that the Domino server is stopped and that no other application can connect to it before you issue db2start to restart the instance.
    4. Make sure that the password file is initialized by Data Protection for HCL Domino and that the DB2 instance user has permission to access the file.
    5. Verify the configuration by backing up the Domino database by logging in as the DB2 instance user and issuing this command from a DB2 command window: 
      db2 backup db DOMINO use tsm
    If the DB2 database is not on the same system as the Domino server, the following requirements must be met:
    • Data Protection for HCL Domino and the DB2 IBM Storage Protect Agent cannot share the dsm.opt file. The nodename specified in both dsm.opt files must be the same.
    • The IBM Storage Protect node password must be updated manually on both systems when it expires.
    • Generate the IBM Storage Protect password file with the DB2 IBM Storage Protect Agent utility, dsmapipw, in DB2 installation directory.
  • Enable the Domino DB2 database for rollforward recovery:
    1. Stop the Domino server.
    2. Issue the following command to enable rollforward recovery: db2 update database configuration using logarchmeth1 tsm
    3. Back up the database by issuing this command: db2 backup database domino use tsm Backing up the database allows applications to connect to the database and also verifies whether the DB2 IBM Storage Protect Agent is configured correctly.
    4. Start the Domino server.
  • Data Protection for HCL Domino must use the DB2 instance user ID and password to back up and restore the Domino DB2 database. The DBUSER preference option stores the DB2 instance user ID and is set with the domdsmc set db2user command. For example: 
    domdsmc set db2user=db2admin
  • If you are using DB2 Server 9.1.2 on an AIX or Linux x86 system, the AIX LIBPATH or Linux LD_LIBRARY_PATH environment variable must be set to include the DB2 instance directory (sqllib/lib32) before you start the web client GUI. These examples display the correct setting with DB2 instance name db2inst1: 
    LIBPATH=/usr/lib:/lib:/home/db2inst1/sqllib/lib32
    or 
    LD_LIBRARY_PATH=/usr/lib:/lib:/home/db2inst1/sqllib/lib32
  • Make sure to refer to your Lotus Domino documentation for information about Domino DB2 Enablement Requirements.

Data Protection for HCL Domino settings

Data Protection for HCL Domino provides the following new preference options for use when you are backing up and restoring DB2 enabled Notes databases:

  • db2altdbname
  • db2containerpath
  • db2logpath
  • db2logtarget
  • db2replace
  • db2restoreintopath
  • db2sessions
  • db2user.

See the description of the Domdsmc set command for details about these options.

After you complete the DB2 enabled Notes configuration tasks, run the standard Data Protection for HCL Domino configuration tasks as described in the configuration section.

32-bit and 64-bit settings

Use the settings that are described as DB2 is a 64-bit application and Data Protection for HCL Domino is a 32-bit application. Use the DSMI_DIR environment variable with the settings that are described. The DSMI_DIR environment variable is used to set the IBM Storage Protect API path. DB2 64-bit requires the IBM Storage Protect 64-bit library, libApiTSM64.a. However, Data Protection for HCL Domino (32-bit) requires the IBM Storage Protect 32-bit library, libApiDS.a. Therefore, make sure that the following settings are specified:

  • DB2(64-bit): The DSMI_DIR environment variable (used by the DB2 instance) must specify the path to the IBM Storage Protect 64-bit library, libApiTSM64.a, located in the AIX /usr/tivoli/tsm/client/api/bin64 or Linux /opt/tivoli/tsm/client/api/bin64 directory. For example: 
    AIX: DSMI_DIR /usr/tivoli/tsm/client/api/bin64
    or 
    Linux: DSMI_DIR /opt/tivoli/tsm/client/api/bin64

    Note, if the DSMI_DIR environment variable (used by the DB2 instance) is not set to the IBM Storage Protect 64-bit API path before the DB2 db2start command is issued, the IBM Storage Protect 32-bit API will be used (by default). The DSMI_DIR environment variable (used by the DB2 instance) must specify the IBM Storage Protect 64-bit API path in order to function properly.

    Note: The IBM Storage Protect 64-bit API directory also contains the IBM Storage Protect dsm.sys file. Multiple dsm.sys files can be stored in IBM Storage Protect 64-bit and IBM Storage Protect 32-bit API directories, you must use only one dsm.sys file. Use the dsm.sys in the IBM Storage Protect 32-bit API directory and create a symbolic link to it from the IBM Storage Protect 64-bit API directory.
  • Data Protection for HCL Domino (32-bit): The DSMI_DIR environment variable (used by Data Protection for HCL Domino) must specify the path to the IBM Storage Protect 32-bit library, libApiDS.a, in the AIX /usr/tivoli/tsm/client/api/bin directory or Linux /opt/tivoli/tsm/client/api/bin directory. For example: 
    AIX: DSMI_DIR /usr/tivoli/tsm/client/api/bin
    or 
    Linux: DSMI_DIR /opt/tivoli/tsm/client/api/bin

How to configure DB2 and Data Protection for HCL Domino to use the same password file

Follow these steps to configure DB2 and Data Protection for HCL Domino to use the same password file:

  1. Log in to the Data Protection for HCL Domino node with the Domino user ID.
    1. Configure the dsm.opt file that is used by Data Protection for HCL Domino, with the settings you want.
    2. Generate the password file (TSM.PWD).
    3. If TSM.PWD is first generated by the DB2 IBM Storage Protect Agent, change the access values of the password file (TSM.PWD) to include read and write access for the DB2 user ID. For example: 
      chmod o+rw TSM.PWD
      If TSM.PWD is first generated by Data Protection for HCL Domino, do not change the access values of the password file (TSM.PWD).
    4. Issue the Domdsmc query adsmserver command to verify that the Domino user (Data Protection for IBM Domino node) can access the IBM Storage Protect server.
  2. Log in as the DB2 instance user.
    1. Add the following variable settings to the .profile file (/home/db2inst1) and the db2profile file (/home/db2inst1/sqllib/): 
      export DSMI_DIR=/usr/tivoli/tsm/client/api/bin64
export DSMI_CONFIG=/home/db2inst1/dsm.opt
export DSMI_LOG=/home/db2inst1
      Note DSMI_DIR is an AIX example. The DSMI_DIR setting on Linux is DSMI_DIR=/opt/tivoli/tsm/client/api/bin64.
    2. Symbolically link the dsm.opt file (in /home/db2inst1) to the dsm.opt file used by the Domino user (Data Protection for HCL Domino node). For example: 
      $db2inst1@/home/db2inst1/>ln -s  
/usr/tivoli/tsm/client/domino/bin64/domdsmc_polardp1/dsm.opt dsm.opt
  3. (Optional) This step is necessary in a remote DB2 configuration. Log in as the root user.
    1. Change to the /home/db2inst1/sqllib/adsm/ directory.
    2. Make sure that the root environment has the DSMI_DIR, DSMI_CONFIG, and DSMI_LOG environment variables set. If the root environment does not have these environment variables set, then run the command: 
      export DSMI_DIR=/usr/tivoli/tsm/client/api/bin64
export DSMI_CONFIG=/home/db2inst1/dsm.opt
export DSMI_LOG=/home/db2inst1
      Note DSMI_DIR is an AIX example. The DSMI_DIR setting on Linux is DSMI_DIR=/opt/tivoli/tsm/client/api/bin64.
    3. Issue the dsmapipw utility to generate the password.
    4. Issue the db2adutl query command to verify that the password was set successfully.