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",
        "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",
        "stateEncryption": {
            "_typeName": "string",
            "protectionMode": "string",
            "requireSecureBoot": false,
            "requireExecInstalledOnly": false
        }
    },
    "config": {
        "_typeName": "string",
        "name": "string",
        "port": 0,
        "sslThumbprint": "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

Reference to an instance of the HostSystem managed object.

hardware
Optional

This data object type summarizes hardware used by the host.

runtime
Optional

This data object type describes the runtime state of a host.

config
Required

An overview of the key configuration parameters.

quickStats
Required

Basic host statistics.

Included in the host statistics are fairness scores. Fairness scores are represented in units with relative values, meaning they are evaluated relative to the scores of other hosts. They should not be thought of as having any particular absolute value. Each fairness unit represents an increment of 0.001 in a fairness score. The further the fairness score diverges from 1, the less fair the allocation. Therefore, a fairness score of 990, representing 0.990, is more fair than a fairness score of 1015, which represents 1.015. This is because 1.015 is further from 1 than 0.990.

overallStatus
Required

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,
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

This data object type describes information about a host gateway server that is used for the connection between vCenter Server and the host.

Gateway servers are identified by type and id. In order to use a gateway server it has to be registered with the respective type and id in the vCenter Lookup Service.

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