Using the KeyControl System Console Menu

When you log into a VM hosting a KeyControl node as root, KeyControl displays the System Console Menu. This menu lets you configure the local KeyControl server. In general, the changes you make here do not apply to any other KeyControl node in the cluster.

The menu is a TUI (Text-based User Interface). You navigate through the TUI using the Tab key to move between fields and pressing Enter when the correct choice is highlighted. If the TUI screen has numbers at the start of the line, you can also press the corresponding number key and then press Enter to navigate through the menus.

To return to the main System Console Menu screen, press Esc (Escape). Based on where you are in the menus, you may need to press Esc several times.

The System Console Menu contains the following options:

Option

Description

Manage Network Settings

View or change the current network configuration. For details, see Changing Network Settings in a Single NIC Configuration.

This menu also allows you to run network diagnostic tools. For details, see Troubleshooting Network Issues.

Join or Re-join a KeyControl Cluster

Join this node to an existing KeyControl cluster. For details, see Joining or Re-joining a KeyControl Cluster.

Reset System Password

Change the root password for this KeyControl node.

Manage Support Accounts

Enable or disable HyTrust support access to this KeyControl node. For details, see Support Access and Log Files.

Manage HSM Client Account

If you are connecting KeyControl to multiple HSM servers, this option allows you to configure those servers as an HA group. For details, see Hardware Security Modules with KeyControl.

Manage HyTrust Internal CA

Download the HyTrust-generated CA certificate being used on this KeyControl node so that you can add that certificate to your web browser as a trusted site. For details, see KeyControl Certificates.

Manage TUI Session Timeout

View or change the current timeout for the System Console Menu. After this period of time elapses with no user input, KeyControl closes the System Console Menu and returns to the system login prompt.

To return to the System Console Menu, log into the system as root.

Reboot System

Reboots the current KeyControl node. This command does not affect any other nodes in the KeyControl cluster.

Shutdown System

Shuts down the current KeyControl node. Before you do this, you should make sure that this node is not part of a KeyControl cluster. For details, see Removing a KeyControl Node from a Cluster.

System Menus over SSH

Allows you to enable or disable access to the System Console Menu via SSH.

Prepare for 5.0 Upgrade

Prepares the KeyControl node for upgrade to KeyControl version 5.0 or later.

Note:

This process will put the cluster into maintenance mode and it may take some time to complete. You should not use this option until instructed to do so in the upgrade instructions for the 5.x release.

Reset Cluster State

If you previously selected Prepare for 5.0 Upgrade but you need to make some configuration changes to the cluster before you perform the actual upgrade, this option lets you restore the cluster to its previously-healthy state.

After you have made your configuration changes, you will need to select Prepare for 5.0 Upgrade again to resume the upgrade process.

Log Out

Close the System Console Menu and return to the system login prompt.