Data Object Description

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

Properties

Name	Type	Description
config	HostConfigSummary	Basic configuration information, if known.
currentEVCModeKey*	xsd:string	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 supportedEVCMode *Since* vSphere API 4.0
customValue*	CustomFieldValue[]	The customized field values.
gateway*	HostListSummaryGatewaySummary	Gateway configuration, if vCenter server manages the host via a gateway *Since* vSphere API 6.0
hardware*	HostHardwareSummary	Basic hardware information, if known.
host*	ManagedObjectReference to a HostSystem	The reference to the host-managed object.
managementServerIp*	xsd:string	IP address of the VirtualCenter server managing this host, if any. *Since* VI API 2.5
maxEVCModeKey*	xsd:string	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 supportedEVCMode *Since* vSphere API 4.0
overallStatus	ManagedEntityStatus	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.
quickStats	HostListSummaryQuickStats	Basic host statistics.
rebootRequired	xsd:boolean	Indicates whether or not the host requires a reboot due to a configuration change.
runtime*	HostRuntimeInfo	Basic runtime information, if known.
Properties inherited from DynamicData
None

Name

Type

Description

config

HostConfigSummary

Basic configuration information, if known.

currentEVCModeKey*

xsd:string

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 supportedEVCMode

Since vSphere API 4.0

customValue*

CustomFieldValue[]

The customized field values.

gateway*

HostListSummaryGatewaySummary

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

Since vSphere API 6.0

hardware*

HostHardwareSummary

Basic hardware information, if known.

host*

ManagedObjectReference
to a HostSystem

The reference to the host-managed object.

managementServerIp*

xsd:string

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

Since VI API 2.5

maxEVCModeKey*

xsd:string

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 supportedEVCMode

Since vSphere API 4.0

overallStatus

ManagedEntityStatus

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.

quickStats

HostListSummaryQuickStats

Basic host statistics.

rebootRequired

xsd:boolean

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

runtime*

HostRuntimeInfo

Basic runtime information, if known.

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="HostListSummary">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="host" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="hardware" type="vim25:HostHardwareSummary" minOccurs="0"/>
                     <element name="runtime" type="vim25:HostRuntimeInfo" minOccurs="0"/>
                     <element name="config" type="vim25:HostConfigSummary"/>
                     <element name="quickStats" type="vim25:HostListSummaryQuickStats"/>
                     <element name="overallStatus" type="vim25:ManagedEntityStatus"/>
                     <element name="rebootRequired" type="xsd:boolean"/>
                     <element name="customValue" type="vim25:CustomFieldValue" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="managementServerIp" type="xsd:string" minOccurs="0"/>
                     <element name="maxEVCModeKey" type="xsd:string" minOccurs="0"/>
                     <element name="currentEVCModeKey" type="xsd:string" minOccurs="0"/>
                     <element name="gateway" type="vim25:HostListSummaryGatewaySummary" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Feedback

1 2 3 4 5
0 Ratings

Data Object - HostListSummary(vim.host.Summary)

Data Object Description

Feedback