Restoring KeyControl Through the webGUI

Restoring from a KeyControl backup should only be needed if there is a catastrophic failure in the KeyControl cluster. If one KeyControl node becomes unusable, for example due to hardware failures, simply remove the node from the cluster and add a new node.

Warning: Restore is a destructive process. Any changes made to objects created since the backup image was taken will be lost. This includes keys, policies, and KeyControl user accounts. If the KeyControl SSL certificate was changed since the backup was taken, the older SSL certificate will be restored along with the rest of the system and the current SSL certificate will be discarded.

Log into the KeyControl webGUI using an account with Domain Admin privileges.
In the top menu bar, click Cluster.
If there are any other nodes in this cluster, you must remove them before you restore the node. To do so:
1. Click on the Servers tab.
2. Click on each of the other nodes in the cluster and select Actions > Remove.
3. Click Proceed at the prompt to confirm the request.
Go to the Cluster tab.
Select Actions > KeyControl Restore.
Click Browse and select the backup file from which you want to restore KeyControl. The name of the selected file appears next to the Browse button.
Click Verify Image. KeyControl uploads the file and verifies that it is a valid backup file. It also displays a hint stating which Admin Key generation count goes with this backup file in case you need to upload the matching Admin Key parts. For example:

Hint: Keypart generation version for this backup image is 16.

For details, see Admin Keys.
Click Restore Image.
Click Proceed at the prompt to confirm the request. KeyControl restores the system information from the backup file and reboots the server.
Verify the restoration by logging back into the KeyControl webGUI.

Important: Remember that all user account information has been reverted back to whatever it was when the backup was taken. That means your account may not exist or that the password may have changed.

If the hardware has changed since the backup was taken, KeyControl presents you with additional options.

Options

Option	Description
Recovery using Keypart upload	Allows you to recover the Admin key by uploading the parts from local files. You must upload the required number of parts of the Admin key within 10 minutes to use this method. Important: All Admin key parts must have the key generation count that was valid when the back up was taken. For details, see Admin Keys
Recovery from External key server	Allows you to recover the Admin key by connecting to an external KMIP (Key Management Interoperability Protocol) server or HSM (Hardware Security Module).
Decommission	Tells KeyControl to decommission the server. For more information, see Decommissioning a KeyControl Node.

Option

Description

Recovery using Keypart upload

Allows you to recover the Admin key by uploading the parts from local files. You must upload the required number of parts of the Admin key within 10 minutes to use this method.

Important: All Admin key parts must have the key generation count that was valid when the back up was taken. For details, see Admin Keys

Recovery from External key server

Allows you to recover the Admin key by connecting to an external KMIP (Key Management Interoperability Protocol) server or HSM (Hardware Security Module).

Decommission

Tells KeyControl to decommission the server. For more information, see Decommissioning a KeyControl Node.

If you removed any nodes from the cluster, re-join them as described in Joining or Re-joining a KeyControl Cluster.