All Products
Search
Document Center

Key Management Service:loginHSM and logoutHSM

Last Updated:Apr 25, 2025

This topic explains the procedures for logging on to and logging out of HSM using the loginHSM and logoutHSM commands.

Feature description

  • The loginHSM command authenticates and grants access to HSM with a username and password.

  • The logoutHSM command terminates the session for the current user.

User types

The commands can be executed by the following user types. For detailed user descriptions, see HSM user permissions table.

  • Administrator (CO)

  • Cryptographic User (CU)

  • Preliminary Administrator (PRECO)

Syntax

Enter the command following the syntax provided below. To conceal your password, replace it with the -hpswd parameter and respond to the subsequent prompts. For additional information on parameters, refer to Parameters.

loginHSM <user-type> <user-name> <password |-hpswd>
logoutHSM
Important

Parameters must be entered in the sequence specified by the syntax.

Examples

  • Logging on to HSM

    cloudmgmt>loginHSM CO admin password
    loginHSM success on server 0(172.16.0.2)
  • Logging out of HSM

    cloudmgmt>logoutHSM
    logoutHSM success on server 0(172.16.0.2)

Parameters

Parameter name

Description

Required

Valid values

<user-type>

User type

Yes

  • CO

  • CU

  • PRECO

Note

For user descriptions, see HSM user permissions table.

<user-name>

User name, this parameter is case-insensitive

Yes

No Special Requirements

<password | -hpswd >

User password, this parameter is a string containing 7 to 32 characters. This value is case-sensitive. The password will be displayed in plaintext when typed. To hide the password, use the -hpswd parameter instead of the password, and then follow the prompts.

Yes

No Special Requirements