ehstorbandmgmt.h header
This header is used by storage. For more information, see:
ehstorbandmgmt.h contains the following programming interfaces:
IOCTLs
| IOCTL_EHSTOR_BANDMGMT_ACTIVATE This IOCTL_EHSTOR_BANDMGMT_ACTIVATE request is sent to activate the security features and band management on a storage device. The request includes activation options and the authentication key. |
| IOCTL_EHSTOR_BANDMGMT_CREATE_BAND New bands are created on a band-managed storage device with the IOCTL_EHSTOR_BANDMGMT_CREATE_BAND request. A new band is added to the table of band entries, which includes band location and security properties. |
| IOCTL_EHSTOR_BANDMGMT_DELETE_BAND A configured band on a storage device is deleted with the IOCTL_EHSTOR_BANDMGMT_DELETE_BAND request. An erase option in the input parameters allows the request to perform a cryptographic erase of the band data. |
| IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS This IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS request is sent to retrieve the list of bands for a storage device under band management. Banding information is returned in a table of band entries that includes band location and security properties. |
| IOCTL_EHSTOR_BANDMGMT_ERASE_ALL_BANDS Learn more about the IOCTL_EHSTOR_BANDMGMT_ERASE_ALL_BANDS IOCTL. |
| IOCTL_EHSTOR_BANDMGMT_ERASE_BAND The IOCTL_EHSTOR_BANDMGMT_ERASE_BAND request will cryptographically erase and reset the authentication key of a band. The remaining configuration of the band is left unmodified. |
| IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA Metadata associated with a band is retrieved with an IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA request. The metadata for a band serves as a data area for a key manager application. |
| IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES The IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES request retrieves the banded security capabilities for a storage device. The IOCTL returns the capabilities as a BAND_MANAGEMENT_CAPABILITIES structure in the system buffer. |
| IOCTL_EHSTOR_BANDMGMT_REVERT This IOCTL_EHSTOR_BANDMGMT_REVERT request is sent to deactivate the security features and band management on a storage device. The request includes revert options and the authentication key. |
| IOCTL_EHSTOR_BANDMGMT_SET_BAND_LOCATION The location properties of bands in a band-managed storage device are modified with the IOCTL_EHSTOR_BANDMGMT_SET_BAND_LOCATION request. |
| IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA Metadata associated with a band is set with an IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA request. The metadata for a band serves as a data area for a key manager application. |
| IOCTL_EHSTOR_BANDMGMT_SET_BAND_SECURITY The security properties of bands in a band-managed storage device are modified with the IOCTL_EHSTOR_BANDMGMT_SET_BAND_SECURITY request. |
| IOCTL_EHSTOR_TCGDRV_RELINQUISH_SILO The IOCTL_EHSTOR_TCGDRV_RELINQUISH_SILO request relinquishes control of band management by the Trusted Computing Group (TCG) Storage Silo driver. |
Structures
| BAND_LOCATION_INFO The BAND_LOCATION_INFO structure specifies the location information for a band table entry query. |
| BAND_MANAGEMENT_CAPABILITIES The BAND_MANAGEMENT_CAPABILITIES structure contains the security capabilities available for a storage device. This structure is returned in the system buffer by the IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES request. |
| BAND_SECURITY_INFO The BAND_SECURITY_INFO structure specifies the security information for a band table entry query. |
| BAND_TABLE The BAND_TABLE structure contains the table of bands returned from an IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS request. |
| BAND_TABLE_ENTRY Banding information entries in BAND_TABLE are represented as BAND_TABLE_ENTRY structures. These entries contain location and security properties for a band configuration. |
| CREATE_BAND_PARAMETERS The parameters to create a band on a storage device for an IOCTL_EHSTOR_BANDMGMT_CREATE_BAND request are specified in a CREATE_BAND_PARAMETERS structure. |
| DELETE_BAND_PARAMETERS A configured band is deleted according to the parameters in a DELETE_BAND_PARAMETERS structure. This structure is input for an IOCTL_EHSTOR_BANDMGMT_DELETE_BAND request. |
| ENUMERATE_BANDS_PARAMETERS The ENUMERATE_BANDS_PARAMETERS structure is used to select which band information entries are selected for return from an IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS request. |
| ERASE_BAND_PARAMETERS The ERASE_BAND_PARAMETERS structure contains the selection criteria for a band to erase. Additionally, a new authentication key can be set. This structure is input for an IOCTL_EHSTOR_BANDMGMT_ERASE_BAND request. |
| GET_BAND_METADATA_PARAMETERS The metadata for a configured band is retrieved according to the parameters in a GET_BAND_METADATA_PARAMETERS structure. This structure is input for an IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA request. |
| SET_BAND_LOCATION_PARAMETERS The SET_BAND_LOCATION_PARAMETERS structure specifies the parameters to set location properties for a band on a storage device for an IOCTL_EHSTOR_BANDMGMT_SET_BAND_LOCATION request. |
| SET_BAND_METADATA_PARAMETERS The metadata for a configured band is set to the parameters in a SET_BAND_METADATA_PARAMETERS structure. This structure is input for a IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA request. |
| SET_BAND_SECURITY_PARAMETERS The parameters to set security properties for a band on a storage device for a IOCTL_EHSTOR_BANDMGMT_SET_BAND_SECURITY request are specified in a SET_BAND_SECURITY_PARAMETERS structure. |
Enumerations
| ALGOIDTYPE Specifies the crypto algorithm ID type. |
| LOCKSTATE Indicates the current lock state of the device. |