MD_ResetHsm

This function is used to reset the specified HSM.

Synopsis

#include <md.h>
MD_RV MD_ResetHsm(uint32 hsmIndex);
 

Input Requirements

The message dispatch library has been initialized via the MD_Initialize() function.

The remote server may disable or limit the use of this function via the ET_HSM_NETSERVER_ALLOW_RESET environment variable. Refer to the SafeNet HSM Access Provider Installation Guide for further details. If this limitation has been set, then this function may only be called when the HSM stat is not S_NORMAL_OPERATION. See MD_GetHsmState for further details.

Input Parameters

Parameter	Description
hsmIndex	Zero-based index of the HSM to query. For remote HSMs, the HSM indices are numbered according to the order that the HSMs’ IP addresses were entered in the ET_HSM_NETCLIENT_SERVERLIST registry key. Refer to the HSM Access Provider Install Guide for further details. When MD_Initialize () is invoked the message dispatch library assigns an index to each available HSM.

Output Requirements

The HSM is reset.

The function returns the following codes:

Function Code	Qualification
MDR_OK	N/A
MDR_UNSUCCESSFUL	N/A
MDR_NOT_INITIALIZE	If the message dispatch library was not previously initialized successfully.
MDR_INVALID_HSM_INDEX	If HSM index was not in the range of accessible HSMs.