HostHardwareInfo

HostHardwareInfo
HostHardwareInfo

The HardwareInfo data object type describes the hardware configuration of the host.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "systemInfo": {
        "_typeName": "string",
        "vendor": "string",
        "model": "string",
        "uuid": "string",
        "otherIdentifyingInfo": [
            {
                "_typeName": "string",
                "identifierValue": "string",
                "identifierType": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string"
                }
            }
        ],
        "serialNumber": "string",
        "qualifiedName": [
            {
                "_typeName": "string",
                "value": "string",
                "type": "string"
            }
        ],
        "vvolHostNQN": {
            "_typeName": "string",
            "value": "string",
            "type": "string"
        },
        "vvolHostId": "string"
    },
    "cpuPowerManagementInfo": {
        "_typeName": "string",
        "currentPolicy": "string",
        "hardwareSupport": "string"
    },
    "cpuInfo": {
        "_typeName": "string",
        "numCpuPackages": 0,
        "numCpuCores": 0,
        "numCpuThreads": 0,
        "hz": 0
    },
    "cpuPkg": [
        {
            "_typeName": "string",
            "index": 0,
            "vendor": "string",
            "hz": 0,
            "busHz": 0,
            "description": "string",
            "threadId": [
                0
            ],
            "cpuFeature": [
                {
                    "_typeName": "string",
                    "level": 0,
                    "vendor": "string",
                    "eax": "string",
                    "ebx": "string",
                    "ecx": "string",
                    "edx": "string"
                }
            ]
        }
    ],
    "memorySize": 0,
    "numaInfo": {
        "_typeName": "string",
        "type": "string",
        "numNodes": 0,
        "numaNode": [
            {
                "_typeName": "string",
                "typeId": 0,
                "cpuID": [
                    0
                ],
                "memorySize": 0,
                "memoryRangeBegin": 0,
                "memoryRangeLength": 0,
                "pciId": [
                    "string"
                ]
            }
        ]
    },
    "smcPresent": false,
    "pciDevice": [
        {
            "_typeName": "string",
            "id": "string",
            "classId": 0,
            "bus": 0,
            "slot": 0,
            "function": 0,
            "vendorId": 0,
            "subVendorId": 0,
            "vendorName": "string",
            "deviceId": 0,
            "subDeviceId": 0,
            "parentBridge": "string",
            "deviceName": "string"
        }
    ],
    "dvxClasses": [
        {
            "_typeName": "string",
            "deviceClass": "string",
            "checkpointSupported": false,
            "swDMATracingSupported": false,
            "sriovNic": false
        }
    ],
    "cpuFeature": [
        {
            "_typeName": "string",
            "level": 0,
            "vendor": "string",
            "eax": "string",
            "ebx": "string",
            "ecx": "string",
            "edx": "string"
        }
    ],
    "biosInfo": {
        "_typeName": "string",
        "biosVersion": "string",
        "releaseDate": "string",
        "vendor": "string",
        "majorRelease": 0,
        "minorRelease": 0,
        "firmwareMajorRelease": 0,
        "firmwareMinorRelease": 0,
        "firmwareType": "string"
    },
    "reliableMemoryInfo": {
        "_typeName": "string",
        "memorySize": 0
    },
    "persistentMemoryInfo": {
        "_typeName": "string",
        "capacityInMB": 0,
        "volumeUUID": "string"
    },
    "sgxInfo": {
        "_typeName": "string",
        "sgxState": "string",
        "totalEpcMemory": 0,
        "flcMode": "string",
        "lePubKeyHash": "string",
        "registrationInfo": {
            "_typeName": "string",
            "status": "string",
            "biosError": 0,
            "registrationUrl": "string",
            "type": "string",
            "ppid": "string",
            "lastRegisteredTime": "string"
        }
    },
    "sevInfo": {
        "_typeName": "string",
        "sevState": "string",
        "maxSevEsGuests": 0
    },
    "memoryTieringType": "string",
    "memoryTierInfo": [
        {
            "_typeName": "string",
            "name": "string",
            "type": "string",
            "flags": [
                "string"
            ],
            "size": 0
        }
    ]
}
systemInfo
Required

Information about the system as a whole.

cpuPowerManagementInfo
Optional

The CpuPowerManagementInfo data object type describes supported power management and current policy.

cpuInfo
Required

Information about the CPUs.

cpuPkg
Required

Information about each of the physical CPU packages on the host.

integer As int64 As int64
memorySize
Required

Total amount of physical memory on the host in bytes.

numaInfo
Optional

Information about NUMA (non-uniform memory access).

boolean
smcPresent
Required

Presence of System Management Controller, indicates the host is Apple hardware, and thus capable of running Mac OS guest as VM.

pciDevice
Optional

The list of Peripheral Component Interconnect (PCI) devices available on this host.

dvxClasses
Optional

The list of Device Virtualization Extensions (DVX) classes available on this host.

Since: vSphere API Release 8.0.0.1

cpuFeature
Optional

CPU feature set that is supported by the hardware.

This is the intersection of the feature sets supported by the individual CPU packages. This feature set is modified by the supportedCpuFeature array in the host capabilities to obtain the feature set supported by the virtualization platform.

biosInfo
Optional

Information about the system BIOS

reliableMemoryInfo
Optional

Information about reliable memory installed on this host.

persistentMemoryInfo
Optional

Host Hardware information about configured and available persistent memory on a host.

sgxInfo
Optional

Data object describing the Software Guard Extension (SGX) configuration on the ESXi host.

sevInfo
Optional

Since: vSphere API Release 7.0.1.0

string
memoryTieringType
Optional

Type of memory tiering configured on this host.

See HostMemoryTieringTypeEnum for supported values. This field will be unset for legacy hosts as well as for hosts that don't support memory tiering.

Since: vSphere API Release 7.0.3.0

memoryTierInfo
Optional

Configuration of each memory tier on this host.

The array is populated in the order of tiers (ie, tier 0 at array index 0, tier 1 at array index 1, and so on).

Since: vSphere API Release 7.0.3.0