Data Object - HostConfigInfo

Property of
HostSystem
Extends
DynamicData
See also
AboutInfo, Datastore, HostAuthenticationManagerInfo, HostAutoStartManagerConfig, HostDatastoreSystemCapabilities, HostDateTimeInfo, HostDiagnosticPartition, HostFeatureVersionInfo, HostFileSystemVolumeInfo, HostFirewallInfo, HostFlagInfo, HostHyperThreadScheduleInfo, HostIpmiInfo, HostMultipathStateInfo, HostNetCapabilities, HostNetOffloadCapabilities, HostNetworkInfo, HostPciPassthruInfo, HostServiceInfo, HostSslThumbprintInfo, HostStorageDeviceInfo, HostSystem, HostSystemResourceInfo, HostVirtualNicManagerInfo, HostVMotionInfo, OptionDef, OptionValue, PowerSystemCapability, PowerSystemInfo, ServiceConsoleReservationInfo, VirtualMachineMemoryReservationInfo

Data Object Description

This data object type encapsulates a typical set of host configuration information that is useful for displaying and configuring a host.

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

Properties

Name Type Description
activeDiagnosticPartition*HostDiagnosticPartition

The diagnostic partition that will be set as the current diagnostic partition on the host.
adminDisabled*xsd:booleanDeprecated. As of vSphere API 6.0, use lockdownMode.

If the flag is true, the permissions on the host have been modified such that it is only accessible through local console or an authorized centralized management application. This flag is affected by the EnterLockdownMode and ExitLockdownMode operations.

This flag is supported in VirtualCenter only. The value returned from host should be ignored.
See EnterLockdownMode
See ExitLockdownMode

Since VI API 2.5
authenticationManagerInfo*HostAuthenticationManagerInfo

Current authentication configuration.

Since vSphere API 4.1
autoStart*HostAutoStartManagerConfig

AutoStart configuration.
capabilities*HostNetCapabilities

Capability vector indicating the available network features.
consoleReservation*ServiceConsoleReservationInfo

Memory configuration.
datastoreCapabilities*HostDatastoreSystemCapabilities

Capability vector indicating available datastore features.

Since VI API 2.5
datastorePrincipal*xsd:string

Datastore principal user
dateTimeInfo*HostDateTimeInfo

Date/Time related configuration

Since VI API 2.5
featureVersion*HostFeatureVersionInfo[]

List of feature-specific version information. Each element refers to the version information for a specific feature.

Since vSphere API 4.1
fileSystemVolume*HostFileSystemVolumeInfo

Storage system file system volume information.
firewall*HostFirewallInfo

Firewall configuration.
flags*HostFlagInfo

Additional flags for a host.

Since VI API 2.5
hostManagedObjectReference
to a HostSystem

A reference to a managed object on a host.
hyperThread*HostHyperThreadScheduleInfo

If hyperthreading is supported, this is the CPU configuration for optimizing hyperthreading.
ipmi*HostIpmiInfo

IPMI (Intelligent Platform Management Interface) info for the host.

Since vSphere API 4.0
localSwapDatastore*ManagedObjectReference
to a Datastore

Datastore visible to this host that may be used to store virtual machine swapfiles, for virtual machines executing on this host. The value of this property is set or unset by invoking UpdateLocalSwapDatastore. The policy for using this datastore is determined by the compute resource configuration's vmSwapPlacement property in concert with each individual virtual machine configuration's swapPlacement property.

Note: Using a host-specific swap location may degrade VMotion performance.

Since VI API 2.5
multipathState*HostMultipathStateInfo

Storage multipath state information.

Since vSphere API 4.0
network*HostNetworkInfo

Network system information.
offloadCapabilities*HostNetOffloadCapabilitiesDeprecated. As of VI API 4.0, the system defaults will be used.

capabilities to offload operations either to the host or to physical hardware when a virtual machine is transmitting on a network
option*OptionValue[]

Host configuration options as defined by the OptionValue data object type.
optionDef*OptionDef[]

A list of supported options.
pciPassthruInfo*HostPciPassthruInfo[]

PCI passthrough information.

Since vSphere API 4.0
powerSystemCapability*PowerSystemCapability

Host power management capability.

Since vSphere API 4.1
powerSystemInfo*PowerSystemInfo

Host power management information.

Since vSphere API 4.1
productAboutInfo

Information about a product.
service*HostServiceInfo

Host service configuration.
sslThumbprintInfo*HostSslThumbprintInfoDeprecated. As of vSphere API 5.0, use sslThumbprintData instead.

SSL Thumbprint info for hosts registered on this host.

Since vSphere API 4.0
storageDevice*HostStorageDeviceInfo

Storage system information.
systemFile*xsd:string[]

Datastore paths of files used by the host system on mounted volumes, for instance, the COS vmdk file of the host. For information on datastore paths, see Datastore.

Since vSphere API 4.1
systemResources*HostSystemResourceInfo

Reference for the system resource hierarchy, used for configuring the set of resources reserved to the system and unavailable to virtual machines.
virtualMachineReservation*VirtualMachineMemoryReservationInfo

Virtual machine memory configuration.

Since VI API 2.5
virtualNicManagerInfo*HostVirtualNicManagerInfo

VirtualNic manager information.

Since vSphere API 4.0
vmotion*HostVMotionInfoDeprecated. As of VI API 4.0, use virtualNicManagerInfo

VMotion system information.
Properties inherited from DynamicData
None
*Need not be set