All Products
Search
Document Center

Key Management Service:loginHSM and logoutHSM

Last Updated:Mar 31, 2026

Use loginHSM to authenticate and start a session on an HSM, and logoutHSM to end the current session.

User types

The following user types can run these commands. For descriptions of each user type and their permissions, see HSM user permissions table.

  • Administrator (CO)

  • Cryptographic User (CU)

  • Preliminary Administrator (PRECO)

Syntax

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

Enter parameters in the order shown in the syntax.

Parameters

ParameterDescriptionRequiredValid values
<user-type>User type. For descriptions, see HSM user permissions table.YesCO, CU, PRECO
<user-name>Username. Case-insensitive.YesNo restrictions
<password | -hpswd>User password. Must be 7–32 characters and is case-sensitive. The password is displayed in plaintext when typed. To hide the password, use -hpswd instead and enter the password at the interactive prompt.YesNo restrictions

Examples

Log in with a plaintext password

cloudmgmt>loginHSM CO admin password
loginHSM success on server 0(172.16.0.2)

Log out

cloudmgmt>logoutHSM
logoutHSM success on server 0(172.16.0.2)