HostListSummary

HostListSummary
HostListSummary

This data object type encapsulates a typical set of host information that is useful for list views and summary pages.

VirtualCenter can retrieve this information very efficiently, even for a large set of hosts.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "hardware": {
        "_typeName": "string",
        "vendor": "string",
        "model": "string",
        "family": "string",
        "uuid": "string",
        "otherIdentifyingInfo": [
            {
                "_typeName": "string",
                "identifierValue": "string",
                "identifierType": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string"
                }
            }
        ],
        "memorySize": 0,
        "cpuModel": "string",
        "cpuMhz": 0,
        "numCpuPkgs": 0,
        "numCpuCores": 0,
        "numCpuThreads": 0,
        "numNics": 0,
        "numHBAs": 0
    },
    "runtime": {
        "_typeName": "string",
        "connectionState": "string",
        "powerState": "string",
        "standbyMode": "string",
        "inMaintenanceMode": false,
        "inQuarantineMode": false,
        "bootTime": "string",
        "healthSystemRuntime": {
            "_typeName": "string",
            "systemHealthInfo": {
                "_typeName": "string",
                "numericSensorInfo": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "healthState": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        },
                        "currentReading": 0,
                        "unitModifier": 0,
                        "baseUnits": "string",
                        "rateUnits": "string",
                        "sensorType": "string",
                        "id": "string",
                        "sensorNumber": 0,
                        "timeStamp": "string",
                        "fru": {
                            "_typeName": "string",
                            "type": "string",
                            "partName": "string",
                            "partNumber": "string",
                            "manufacturer": "string",
                            "serialNumber": "string",
                            "mfgTimeStamp": "string"
                        }
                    }
                ]
            },
            "hardwareStatusInfo": {
                "_typeName": "string",
                "memoryStatusInfo": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "status": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        }
                    }
                ],
                "cpuStatusInfo": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "status": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        }
                    }
                ],
                "storageStatusInfo": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "status": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        },
                        "operationalInfo": [
                            {
                                "_typeName": "string",
                                "property": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "dpuStatusInfo": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "status": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        },
                        "dpuId": "string",
                        "fru": {
                            "_typeName": "string",
                            "type": "string",
                            "partName": "string",
                            "partNumber": "string",
                            "manufacturer": "string",
                            "serialNumber": "string",
                            "mfgTimeStamp": "string"
                        },
                        "sensors": [
                            {
                                "_typeName": "string",
                                "sensorId": "string",
                                "healthState": {
                                    "_typeName": "string",
                                    "label": "string",
                                    "summary": "string",
                                    "key": "string"
                                },
                                "reading": "string",
                                "units": "string",
                                "timeStamp": "string"
                            }
                        ]
                    }
                ]
            }
        },
        "dasHostState": {
            "_typeName": "string",
            "state": "string",
            "stateReporter": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "tpmPcrValues": [
            {
                "_typeName": "string",
                "digestMethod": "string",
                "digestValue": [
                    0
                ],
                "objectName": "string",
                "pcrNumber": 0
            }
        ],
        "vsanRuntimeInfo": {
            "_typeName": "string",
            "membershipList": [
                {
                    "_typeName": "string",
                    "nodeUuid": "string",
                    "hostname": "string"
                }
            ],
            "diskIssues": [
                {
                    "_typeName": "string",
                    "diskId": "string",
                    "issue": "string"
                }
            ],
            "accessGenNo": 0
        },
        "networkRuntimeInfo": {
            "_typeName": "string",
            "netStackInstanceRuntimeInfo": [
                {
                    "_typeName": "string",
                    "netStackInstanceKey": "string",
                    "state": "string",
                    "vmknicKeys": [
                        "string"
                    ],
                    "maxNumberOfConnections": 0,
                    "currentIpV6Enabled": false
                }
            ],
            "networkResourceRuntime": {
                "_typeName": "string",
                "pnicResourceInfo": [
                    {
                        "_typeName": "string",
                        "pnicDevice": "string",
                        "availableBandwidthForVMTraffic": 0,
                        "unusedBandwidthForVMTraffic": 0,
                        "placedVirtualNics": [
                            {
                                "_typeName": "string",
                                "vm": {
                                    "_typeName": "string",
                                    "type": "string",
                                    "value": "string"
                                },
                                "vnicKey": "string",
                                "reservation": 0
                            }
                        ]
                    }
                ]
            }
        },
        "vFlashResourceRuntimeInfo": {
            "_typeName": "string",
            "usage": 0,
            "capacity": 0,
            "accessible": false,
            "capacityForVmCache": 0,
            "freeForVmCache": 0
        },
        "hostMaxVirtualDiskCapacity": 0,
        "cryptoState": "string",
        "cryptoKeyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "statelessNvdsMigrationReady": "string",
        "partialMaintenanceMode": [
            {
                "_typeName": "string",
                "key": "string",
                "hostStatus": "string"
            }
        ],
        "stateEncryption": {
            "_typeName": "string",
            "protectionMode": "string",
            "requireSecureBoot": false,
            "requireExecInstalledOnly": false
        }
    },
    "config": {
        "_typeName": "string",
        "name": "string",
        "port": 0,
        "sslThumbprint": "string",
        "sslCertificate": "string",
        "product": {
            "_typeName": "string",
            "name": "string",
            "fullName": "string",
            "vendor": "string",
            "version": "string",
            "patchLevel": "string",
            "build": "string",
            "localeVersion": "string",
            "localeBuild": "string",
            "osType": "string",
            "productLineId": "string",
            "apiType": "string",
            "apiVersion": "string",
            "instanceUuid": "string",
            "licenseProductName": "string",
            "licenseProductVersion": "string"
        },
        "vmotionEnabled": false,
        "faultToleranceEnabled": false,
        "featureVersion": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ],
        "agentVmDatastore": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "agentVmNetwork": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "quickStats": {
        "_typeName": "string",
        "overallCpuUsage": 0,
        "overallMemoryUsage": 0,
        "distributedCpuFairness": 0,
        "distributedMemoryFairness": 0,
        "availablePMemCapacity": 0,
        "uptime": 0
    },
    "overallStatus": "string",
    "rebootRequired": false,
    "customValue": [
        {
            "_typeName": "string",
            "key": 0
        }
    ],
    "managementServerIp": "string",
    "maxEVCModeKey": "string",
    "currentEVCModeKey": "string",
    "currentEVCGraphicsModeKey": "string",
    "gateway": {
        "_typeName": "string",
        "gatewayType": "string",
        "gatewayId": "string"
    },
    "tpmAttestation": {
        "_typeName": "string",
        "time": "string",
        "status": "string",
        "message": {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    },
    "trustAuthorityAttestationInfos": [
        {
            "_typeName": "string",
            "attestationStatus": "string",
            "serviceId": "string",
            "attestedAt": "string",
            "attestedUntil": "string",
            "messages": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ]
}
host
Optional

The reference to the host-managed object.

hardware
Optional

Basic hardware information, if known.

runtime
Optional

Basic runtime information, if known.

config
Required

Basic configuration information, if known.

quickStats
Required

Basic host statistics.

overallStatus
Required

The overall alarm status of the host.

In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

boolean
rebootRequired
Required

Indicates whether or not the host requires a reboot due to a configuration change.

customValue
Optional

The customized field values.

string
managementServerIp
Optional

IP address of the VirtualCenter server managing this host, if any.

string
maxEVCModeKey
Optional

The most capable Enhanced VMotion Compatibility mode supported by the host hardware and software; unset if this host cannot participate in any EVC mode.

See also Capability.supportedEVCMode.

string
currentEVCModeKey
Optional

The Enhanced VMotion Compatibility mode that is currently in effect for this host.

If the host is in a cluster where EVC is active, this will match the cluster's EVC mode; otherwise this will be unset.

See also Capability.supportedEVCMode.

string
currentEVCGraphicsModeKey
Optional

The Enhanced VMotion Compatibility Graphics mode that is currently in effect for this host.

If the host is in a cluster where EVC is active, this will match the cluster's EVC Graphics mode; otherwise this will be unset.

See also Capability.supportedEVCGraphicsMode.

Since: vSphere API Release 7.0.1.0

gateway
Optional

Gateway configuration, if vCenter server manages the host via a gateway

tpmAttestation
Optional

This data object type represents result of TPM attestation.

trustAuthorityAttestationInfos
Optional

The attestation information for the host as retrieved from any Trust Authority attestation services configured in the host's parent compute resource.

This field will be set only if there is any Trust Authority attestation service configured for the host's parent compute resource, and unset otherwise.

Since: vSphere API Release 7.0.1.0