All Products
Search
Document Center

Key Management Service:Error2String

Last Updated:Mar 31, 2026

Use Error2String to get the description for a hexadecimal error code returned by command execution, helping you diagnose command and script faults.

Important

Start key_mgmt_tool and log on to the Hardware Security Module (HSM) with a CU identity before running this command.

Syntax

Error2String -r <response-code>
Important

Enter parameters in the sequence shown in the syntax.

Parameters

ParameterDescriptionRequiredValid values
-rSpecifies the hexadecimal error code using the 0x hexadecimal identifier.YesNo Special Requirements

Example

The following example gets the description for error code 0xdb, which indicates a login failure caused by an invalid user type.

Command:  Error2String -r 0xdb

        Error Code db maps to HSM Error: Invalid User Type.