Data Object - VirtualMachineSummary(vim.vm.Summary)

Property of: HostConnectInfo, VirtualMachine, VirtualMachineUsbInfo
Extends: DynamicData
See also: CustomFieldValue, ManagedEntityStatus, VirtualMachine, VirtualMachineConfigSummary, VirtualMachineGuestSummary, VirtualMachineQuickStats, VirtualMachineRuntimeInfo, VirtualMachineStorageSummary
Since: 2.0

Data Object Description

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.

Properties

Name	Type	Description
config	VirtualMachineConfigSummary	Basic configuration information about the virtual machine. This information is not available when the virtual machine is unavailable, for instance, when it is being created or deleted.
customValue*	CustomFieldValue[]	Custom field values.
guest*	VirtualMachineGuestSummary	Guest operating system and VMware Tools information. See Guest for more information.
overallStatus	ManagedEntityStatus	Overall alarm status on this node. 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.
quickStats	VirtualMachineQuickStats	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.
runtime	VirtualMachineRuntimeInfo	Runtime and state information of a running virtual machine. Most of this information is also available when a virtual machine is powered off. In that case, it contains information from the last run, if available.
storage*	VirtualMachineStorageSummary	Storage information of the virtual machine. It can be explicitly refreshed with the RefreshStorageInfo operation. 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. *Since* vSphere API Release 4.0
vm*	ManagedObjectReference to a VirtualMachine	Reference to the virtual machine managed object.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VirtualMachineSummary">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="vm" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="runtime" type="vim25:VirtualMachineRuntimeInfo"/>
                     <element name="guest" type="vim25:VirtualMachineGuestSummary" minOccurs="0"/>
                     <element name="config" type="vim25:VirtualMachineConfigSummary"/>
                     <element name="storage" type="vim25:VirtualMachineStorageSummary" minOccurs="0"/>
                     <element name="quickStats" type="vim25:VirtualMachineQuickStats"/>
                     <element name="overallStatus" type="vim25:ManagedEntityStatus"/>
                     <element name="customValue" type="vim25:CustomFieldValue" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - VirtualMachineSummary(vim.vm.Summary)

Data Object Description