VirtualMachineSummary
VirtualMachineSummary
The summary data object type encapsulates a typical set of virtual machine information that is useful for list views and summary pages.
VirtualCenter can retrieve this information very efficiently, even for large sets of virtual machines.
AllOf
This class requires all of the following:
JSON Example
{
"_typeName": "string",
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"runtime": {
"_typeName": "string",
"device": [
{
"_typeName": "string",
"runtimeState": {
"_typeName": "string"
},
"key": 0
}
],
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"connectionState": "string",
"powerState": "string",
"vmFailoverInProgress": false,
"faultToleranceState": "string",
"dasVmProtection": {
"_typeName": "string",
"dasProtected": false
},
"toolsInstallerMounted": false,
"suspendTime": "string",
"bootTime": "string",
"suspendInterval": 0,
"question": {
"_typeName": "string",
"id": "string",
"text": "string",
"choice": {
"_typeName": "string",
"valueIsReadonly": false,
"choiceInfo": [
{
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string"
}
],
"defaultIndex": 0
},
"message": [
{
"_typeName": "string",
"id": "string",
"argument": [
{
"_typeName": "string"
}
],
"text": "string"
}
]
},
"memoryOverhead": 0,
"maxCpuUsage": 0,
"maxMemoryUsage": 0,
"numMksConnections": 0,
"recordReplayState": "string",
"cleanPowerOff": false,
"needSecondaryReason": "string",
"onlineStandby": false,
"minRequiredEVCModeKey": "string",
"consolidationNeeded": false,
"offlineFeatureRequirement": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"featureRequirement": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"featureMask": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"vFlashCacheAllocation": 0,
"paused": false,
"snapshotInBackground": false,
"quiescedForkParent": false,
"instantCloneFrozen": false,
"cryptoState": "string",
"suspendedToMemory": false,
"opNotificationTimeout": 0,
"iommuActive": false
},
"guest": {
"_typeName": "string",
"guestId": "string",
"guestFullName": "string",
"toolsStatus": "string",
"toolsVersionStatus": "string",
"toolsVersionStatus2": "string",
"toolsRunningStatus": "string",
"hostName": "string",
"ipAddress": "string",
"hwVersion": "string"
},
"config": {
"_typeName": "string",
"name": "string",
"template": false,
"vmPathName": "string",
"memorySizeMB": 0,
"cpuReservation": 0,
"memoryReservation": 0,
"numCpu": 0,
"numEthernetCards": 0,
"numVirtualDisks": 0,
"uuid": "string",
"instanceUuid": "string",
"guestId": "string",
"guestFullName": "string",
"annotation": "string",
"product": {
"_typeName": "string",
"key": 0,
"classId": "string",
"instanceId": "string",
"name": "string",
"vendor": "string",
"version": "string",
"fullVersion": "string",
"vendorUrl": "string",
"productUrl": "string",
"appUrl": "string"
},
"installBootRequired": false,
"ftInfo": {
"_typeName": "string",
"role": 0,
"instanceUuids": [
"string"
],
"configPaths": [
"string"
],
"orphaned": false
},
"managedBy": {
"_typeName": "string",
"extensionKey": "string",
"type": "string"
},
"tpmPresent": false,
"numVmiopBackings": 0,
"hwVersion": "string"
},
"storage": {
"_typeName": "string",
"committed": 0,
"uncommitted": 0,
"unshared": 0,
"timestamp": "string"
},
"quickStats": {
"_typeName": "string",
"overallCpuUsage": 0,
"overallCpuDemand": 0,
"overallCpuReadiness": 0,
"guestMemoryUsage": 0,
"hostMemoryUsage": 0,
"guestHeartbeatStatus": "string",
"distributedCpuEntitlement": 0,
"distributedMemoryEntitlement": 0,
"staticCpuEntitlement": 0,
"staticMemoryEntitlement": 0,
"grantedMemory": 0,
"privateMemory": 0,
"sharedMemory": 0,
"swappedMemory": 0,
"balloonedMemory": 0,
"consumedOverheadMemory": 0,
"ftLogBandwidth": 0,
"ftSecondaryLatency": 0,
"ftLatencyStatus": "string",
"compressedMemory": 0,
"uptimeSeconds": 0,
"ssdSwappedMemory": 0,
"activeMemory": 0,
"memoryTierStats": [
{
"_typeName": "string",
"memoryTierType": "string",
"readBandwidth": 0
}
]
},
"overallStatus": "string",
"customValue": [
{
"_typeName": "string",
"key": 0
}
]
}
runtime
Required
The RuntimeInfo data object type provides information about the execution state and history of a virtual machine.
storage
Optional
A subset of the storage information of this virtual machine.
See VirtualMachineStorageInfo for a detailed storage break-up.
quickStats
Required
A set of statistics that are typically updated with near real-time regularity.
This data object type does not support notification, for scalability reasons. Therefore, changes in QuickStats do not generate property collector updates. To monitor statistics values, use the statistics and alarms modules instead.
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,
Returned By