All Products
Search
Document Center

Key Management Service:server

Last Updated:Apr 25, 2025

This topic explains how to initiate and terminate server mode for HSM using the server and quit commands.

Feature description

  • Commands in hsm_mgmt_tool typically apply to all HSMs within a given cluster (global mode). To interact with a specific HSM instance, such as to obtain its root certificate getCert, you can enter server mode by using the server command.

  • Upon successful entry, the cloudmgmt> prompt changes to the server> prompt.

  • To leave server mode, issue the exit command, which will return you to the hsm_mgmt_tool prompt.

Important

Prior to entering server mode, ascertain the server number of the desired HSM. This number is provided in the trail output from hsm_mgmt_tool during initialization and is assigned based on the sequence of HSMs listed in the configuration file.

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)

Syntax

  • To initiate server mode, refer to Parameters for parameter descriptions.

    server <server-number>
  • To terminate server mode

    exit
Important

Parameters must be entered in the sequence outlined in the syntax.

Example

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

server0>

Parameters

Parameter name

Description

Required

Valid values

<server-number>

Server number

Yes

No Special Requirements