Virtual Machine Get Summary

Basic information about this virtual machine.

This includes:

runtimeInfo
guest
basic configuration
alarms
performance information

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/summary

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 VirtualMachine/{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.

Session

Responses

200

Returns VirtualMachineSummary of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_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
        }
    ]
}

MoRefVirtualMachine

Optional

Reference to an instance of the VirtualMachine managed object.

VirtualMachineRuntimeInfo

runtime

Required

The RuntimeInfo data object type provides information about the execution state and history of a virtual machine.

VirtualMachineGuestSummary

guest

Optional

A subset of virtual machine guest information.

VirtualMachineConfigSummary

config

Required

A subset of virtual machine configuration.

VirtualMachineStorageSummary

storage

Optional

A subset of the storage information of this virtual machine.

See VirtualMachineStorageInfo for a detailed storage break-up.

VirtualMachineQuickStats

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.

ManagedEntityStatus_enum

overallStatus

Required

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

Possible values: