MD_ResetHsm

Resets 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 HSM Access Provider Install Guide for further details. If this limitation has been set, then this function may only be called when the HSM state is not S_NORMAL_OPERATION.

Input Parameters

hsmIndex

Zero based index of the HSM to query. For remote HSMs (such as the Luna Network HSM), the HSM indices are numbered according to the order that the HSM's IP addresses were entered in the ET_HSM_NETCLIENT_SERVERLIST registry key.

NOTE    When MD_Initialize() is invoked the message dispatch library assigns an index to each available HSM.

Refer to MD_GetHsmState for further details.

Output Requirements

The function returns the following codes:

Function Code	Qualification
MDR_OK	No error
MDR_UNSUCCESSFUL	Error in operation. Operation failed.
MDR_NOT_INITIALIZE	The message dispatch library was not previously initialized successfully
MDR_INVALID_HSM_INDEX	HSM index was not in the range of accessible HSMs