MD_GetHsmInfo
Fetch information about an HSM.
Synopsis
#include <md.h> MD_RV MD_GetHsmInfo(uint32 hsmIndex, MD_Info_t infotype, void *pValue, uint32 valueLen);
Input Requirements
The message dispatch library has been initialized via the MD_Initialize()function.
Input Parameters
hsmIndex | Which HSM to query. |
infotype | Which value to query. |
pValue | Where to store a null-terminated string. |
valueLen | Size of buffer pointed at by pValue. |
Output Requirements
Information Types
Each type of information is returned as a null terminated string.
Result is always NULL-terminated and might be truncated.
Type | Description |
---|---|
MDI_HSM_DESCRIPTION | Luna HSM Description. |
MDI_HSM_MODEL | HSM Model Name. |
MDI_HSM_LABEL | HSM Label. |
MDI_HSM_SERIAL_NUMBER | Serial Number as a decimal string. |
MDI_HSM_FIRMWARE_VERSION | HSM FW Version “mm.nn.ss” |
MDI_HSM_CONNECTED | Returns no value. This may be used to query if HSM is connected. |
Function Codes
Function Code | Qualification |
---|---|
MDR_NOT_INITIALIZED | The message dispatch library was not previously initialized successfully. |
MDR_INVALID_HSM_INDEX | HSM index was not in the range of accessible HSMs. |
MDR_HSM_NOT_AVAILABLE | HSM disconnected. |