Backing up IBM Tivoli Key Lifecycle Manager data

Use the IBM Security Key Lifecycle Manager, Version 2.7 backup utility to create IBM Tivoli Key Lifecycle Manager backup files.

Before you begin

You must install IBM Security Key Lifecycle Manager, Version 2.7 on a system. Ensure that the system with IBM Tivoli Key Lifecycle Manager with its latest fix pack is available. The keystore must be configured before you run the backup operation.

About this task

You can use the backup utility to create cross-platform backup files in a manner that is independent of operating systems and directory structure of the server. You can restore these cross-platform compatible backup files on a system with IBM Security Key Lifecycle Manager, Version 2.7 across operating systems.
Note: For greater security, change the IBM® Security Guardium® Key Lifecycle Manager user password after the data migration process.

Procedure

  1. Run the following steps on the system where IBM Security Key Lifecycle Manager, Version 2.7 is installed.
    1. Log in to the system with your user credentials.
    2. Locate the backup utilities folder.
      Windows
      SKLM_INSTALL_HOME\migration\utilities\vx

      Default location is C:\Program Files (x86)\IBM\SKLMV27\migration\utilities\v2.

      Linux
      SKLM_INSTALL_HOME/migration/utilities/vx

      Default location is /opt/IBM/SKLMV27/migration/utilities/v2.

  2. Run the following steps on the system where IBM Tivoli Key Lifecycle Manager is installed.
    1. Log in to the system with your user credentials.
    2. Depending on the Tivoli Key Lifecycle Manager version, copy the v1 or v2 folder from the system where IBM Security Key Lifecycle Manager, Version 2.7 is installed to a local directory of your choice.
    3. Edit backup.properties in the v1 or v2 folder to configure properties as shown in the following example.
      You must set values for all the properties, except for the BACKUP_DIR property (optional). If you do not specify the value for BACKUP_DIR, the backup file is created in the backup subfolder under the same directory from where you run the backup utility.
      Note: On Windows operating system, the backup.properties file that you use for backup operations must not contain the property keys and values with leading or trailing spaces.
      Windows
      TKLM_TIP_HOME=C:\\IBM\\tivoli\\tiptklmVX
      DB_PASSWORD=tklmdb2
      KEYSTORE_PASSWORD=Passw0rd
      TIP_USER_PWD=tipadmin
      BACKUP_PASSWORD=passw0rd123
      BACKUP_DIR=C:\\tklmv201_backup
      Linux
      TKLM_TIP_HOME=/opt/IBM/tivoli/tiptklmVX/
      DB_PASSWORD=tklmdb2
      KEYSTORE_PASSWORD=Passw0rd
      TIP_USER_PWD=tipadmin
      BACKUP_PASSWORD=passw0rd123
      BACKUP_DIR=/tklmv201_backup
      Note: On Windows operating system, when you specify path in the properties file, use either / or \\ as path separator as shown in following examples:
      C:\\tklmv201_backup
      Or
      C:/tklmv201_backup
    4. Open a command line and run the backup utility.
      Windows
      Depending on the Tivoli Key Lifecycle Manager version, go to the v1 or v2 directory (see Step b) and run the following command:
      • IBM Tivoli Key Lifecycle Manager Version 1.0
        backupV1.bat
      • IBM Tivoli Key Lifecycle Manager Version 2.0 and 2.0.1
        backupV2.bat
      Linux
      Depending on the Tivoli Key Lifecycle Manager version, go to the v1 or v2 directory (see Step b) and run the following command:
      • IBM Tivoli Key Lifecycle Manager Version 1.0
        backupV1.sh
      • IBM Tivoli Key Lifecycle Manager Version 2.0 and 2.0.1
        backupV2.sh

What to do next

  • Review the directory that contains backup files to ensure that the backup file exists. The backup files are created in the location that you specified for BACKUP_DIR in the backup.properties file.
  • Check the backup.log file for errors or exceptions. The backup.log file is created in the same directory where you run the backup utility. For a successful backup operation, ensure that there are no errors or exceptions in the log file.
  • Retain the backup password for future use in case you restore the backup.
  • Do not edit a file in the backup archive. The file that you attempt to edit becomes unreadable.