Values and descriptions of API return codes.
The HSM API return code values are classified as follows:
| Value | meaning |
|---|---|
| Negative | HSM communication network. Client library codes. |
| 1 a 100 | Local encryption. Client library codes. |
| 101 a 200 | External communication. Related to communication between the local workstation or server and the destination host (for example when establishing a TSL tunnel in APIs Pix). Client library codes. |
| 1001 a 3999 | Client library. Client library codes. |
| 5000 a 36000 | General. HSM codes. |
| 36000 and above | Replication. HSM codes. |
The return codes displayed on the HSM's local console and in log events are in hexadecimal representation, prefixed by 8000, in the format 8000xxxx, where xxxx is the corresponding hexadecimal value returned by the HSM API.
Always consult the log file of the client library and the HSM; important information for troubleshooting can be found there.
In the event of an error, please also consult the troubleshooting guides in the documentation.