Get HSM hardware information - Key Management Service - Alibaba Cloud Documentation Center

Retrieves hardware details from a Hardware Security Module (HSM), including the model, firmware version, serial number, FIPS state, memory usage, and temperature.

Important

No login is required to run this command.

Permissions

All user types can run this command:

Administrator (CO)
Operator (CU)
Audit User (AU)

For the full permission breakdown, see HSM user permission table.

Syntax

getHSMInfo

This command takes no parameters.

Example

server0>getHSMInfo

       	Label                :cavium
       	Model                :NITROX-III CNN35XX-****

       	Serial Number        :3.2G2026-ICM00****
       	HSM Flags            :0
       	FIPS state           :2 [FIPS mode with single factor authentication]

       	Manufacturer ID      :
       	Device ID            :10
       	Class Code           :100000
       	System vendor ID     :177D
       	SubSystem ID         :10


       	TotalPublicMemory    :562004
       	FreePublicMemory     :303016
       	TotalPrivateMemory   :0
       	FreePrivateMemory    :0

       	Hardware Major       :3
       	Hardware Minor       :2

       	Firmware Major       :2
       	Firmware Minor       :04

       	Temperature          :62 C

       	Build Number         :52

       	Firmware ID          :CNN35XX-NFBE-FW-2.04-52

Output fields

Device identification

Field	Description
`Label`	The label assigned to the HSM device.
`Model`	The hardware model of the HSM.
`Serial Number`	The unique serial number of the HSM.
`HSM Flags`	Internal flag bits indicating the HSM state.
`Manufacturer ID`	The hardware manufacturer identifier.
`Device ID`	The PCI device ID.
`Class Code`	The PCI class code.
`System vendor ID`	The PCI system vendor ID.
`SubSystem ID`	The PCI subsystem ID.

FIPS status

Field	Description
`FIPS state`	The FIPS operational mode. A value of `2` indicates FIPS mode with single factor authentication.

Memory

Field	Description
`TotalPublicMemory`	Total public memory on the HSM.
`FreePublicMemory`	Free public memory remaining.
`TotalPrivateMemory`	Total private memory on the HSM.
`FreePrivateMemory`	Free private memory remaining.

Firmware and build

Field	Description
`Hardware Major`	The major version number of the HSM hardware.
`Hardware Minor`	The minor version number of the HSM hardware.
`Firmware Major`	The major version number of the HSM firmware.
`Firmware Minor`	The minor version number of the HSM firmware.
`Build Number`	The firmware build number.
`Firmware ID`	The full firmware identifier string.

Environmental status

Field	Description
`Temperature`	The current operating temperature of the HSM, in degrees Celsius.