tklmBackupRunRestore

Use the tklmBackupRunRestore command to restore data from an existing backup file.

Note: The IBM Security Key Lifecycle Manager command-line interface commands will be deprecated in the later versions of IBM Security Key Lifecycle Manager. Use the REST interfaces instead.

Purpose

Only one backup or restore task can run at a time. Before you begin, obtain the password that was used to create the backup the file that you intend to use. Before you start a restore task, isolate the system for maintenance. Take a backup of the existing system. You can later use this backup to bring the system back to original state if any issues occur during the restore process. IBM Security Key Lifecycle Manager server automatically restarts after the restore process is complete. Verify the environment before you bring the IBM Security Key Lifecycle Manager server back into production.

The command returns these values:
-1
State is unknown. The task is not run since the last time the IBM Security Key Lifecycle Manager server started.
0
The task succeeded.
1
The task failed.

Permissions

Your role must have a permission to restore files.

Syntax

tklmBackupRunRestore -backupFilePath pathandfilename -password dataencryptionpassword

Parameters

-backupFilePath
Required parameter. The full path and file name that contains backup data for IBM Security Key Lifecycle Manager. To determine this directory, you might examine the value of the tklm.backup.dir property in the SKLMConfig.properties file.
-password
You must specify the password to restore data from the backup file if IBM Security Key Lifecycle Manager uses a password-based encryption method.
Note: You need not specify the password to restore the data if IBM Security Key Lifecycle Manager is configured to use Hardware Security Module (HSM) to store the master encryption key. For more information about hsm-based encryption, see HSM-based encryption for backups.

To restore a backup file, you must provide the password that was used to encrypt the data in that file during the backup operation.

Example

This Jython-formatted command restores password-encrypted backup data for IBM Security Key Lifecycle Manager.

print AdminTask.tklmBackupRunRestore 
	('[-backupFilePath /opt/mysklmbackups/sklm_v3.0.0.0_20170705235417-1200_backup 
		-password myBackupPwd]')