All Products
Search
Document Center

Key Management Service:server

Last Updated:Mar 31, 2026

Use the server command in hsm_mgmt_tool to enter server mode and interact with a specific HSM instance in the cluster. Use exit to return to global mode.

How it works

By default, commands in hsm_mgmt_tool apply to all HSMs in the cluster — this is called global mode, indicated by the cloudmgmt> prompt. To target a single HSM instance (for example, to run getCert), switch to server mode using the server command.

After entering server mode, the prompt changes from cloudmgmt> to server>.

User type

The following user roles are authorized to execute this command. For role details, see HSM User Permission Table.

  • Administrator (CO)

  • Cryptographic User (CU)

  • Audit User (AU)

Prerequisites

Before entering server mode, find the server number of the target HSM. Server numbers appear in the trail output from hsm_mgmt_tool during initialization and are assigned in the order that HSMs are listed in the configuration file.

Syntax

Enter server mode:

server <server-number>

Exit server mode:

exit
Important

Enter parameters in the order shown in the syntax.

Parameters

ParameterDescriptionRequiredValid values
<server-number>The server number of the target HSM instanceYesNo special requirements

Example

The following example enters server mode on the HSM with server number 0.

cloudmgmt>server 0
Server is in 'E2E' mode...

server0>

Related topics

After entering server mode, run commands that target a single HSM instance:

  • getCert — Get the root certificate of the HSM instance