Host System Get Hardware

Host System Get Hardware

Hardware configuration of the host.

This might not be available for a disconnected host.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/hardware
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostHardwareInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_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


Host System Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
POST
Host System Enter Maintenance Mode Task
POST
Host System Exit Lockdown Mode
POST
Host System Exit Maintenance Mode Task
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm
POST
Host System Power Down Host To Stand By Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
POST
Host System Query Memory Overhead Ex
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
POST
Host System Update System Swap Configuration