Data Object Description

Most of this information is collected by VMware Tools. In general, be sure you have VMware Tools installed and that the virtual machine is running when you access this information.

Properties

Name

Type

Description

appHeartbeatStatus*

xsd:string

Application heartbeat status. Please see VirtualMachineAppHeartbeatStatusType

Since vSphere API 4.1

appState*

xsd:string

Application state. If vSphere HA is enabled and the vm is configured for Application Monitoring and this field's value is "appStateNeedReset" then HA will attempt immediately reset the vm. There are some system conditions which may delay the immediate reset. The immediate reset will be performed as soon as allowed by vSphere HA and ESX. If during these conditions the value is changed to appStateOk the reset will be cancelled.
See GuestInfoAppStateType

Since vSphere API 5.5

customizationInfo*

GuestInfoCustomizationInfo

Guest OS Customization status info.

Since vSphere API 7.0.2.0

disk*

GuestDiskInfo[]

Guest information about disks.

You can obtain Linux guest disk information for the following file system types: Ext2, Ext3, Ext4, ReiserFS, XFS, Btrfs, NTFS, VFAT, UFS, PCFS, HFS, and MS-DOS.

NOTE: Installing a more recent version of VMware Tools in the guest may help obtain disk information for more file system types. Please refer the VMware Tools User Guide for up-to-date supported file system types.

generationInfo* P

GuestInfoNamespaceGenerationInfo[]

A list of namespaces and their corresponding generation numbers. Only namespaces with non-zero maxSizeEventsFromGuest are guaranteed to be present here. Use ListNamespaces to retrieve list of namespaces.

Since vSphere API 5.1

guestDetailedData*

xsd:string

Guest OS Detailed data. The guest detailed data string is a property list (space separated, name='value' pairs where the value is embedded in single quotes) of metadata provided by the guest OS when sufficiently recent tools are installed. The fields supplied will vary between distributions and distribution versions. The order of these fields is not guaranteed.

The guest detailed data string is not available before a virtual machine is first powered on. The guest must first be booted and a supported version of tools must be run to record the data (approximately 30-60 seconds after booting). Once the guest detailed data string has been recorded, it will be available whether the virtual machine is powered off or on.

Available fields:

Name Description Tools version first available

architecture 'Arm' or 'X86' 11.2.0

bitness '32' or '64' 11.2.0

buildNumber OS build number 11.2.0

cpeString NIST Common Platform Enumeration Specification string, a standardized identifier for the OS 12.2.0

distroAddlVersion Longer OS version string that may contain additional info (e.g. version name) 12.2.0

distroName OS distribution name 11.2.0

distroVersion OS version string 11.2.0

familyName OS family name (Windows, Linux, etc.) 11.2.0

kernelVersion Linux kernel version, Windows 10+ patch number, or Windows build number 11.2.0

prettyName Officially specified distro "pretty name" 11.2.0

Since 8.0.2.0

guestFamily*

xsd:string

Guest operating system family, if known.

guestFullName*

xsd:string

Guest operating system full name, if known.

guestId*

xsd:string

Guest operating system identifier (short name), if known.

guestKernelCrashed*

xsd:boolean

Guest operating system's kernel crash state. If true, the guest operating system's kernel has crashed.

Since vSphere API 6.0

guestOperationsReady*

xsd:boolean

Guest Operations availability. If true, the virtual machine is ready to process guest operations.

Since vSphere API 5.0

guestState

xsd:string

Operation mode of guest operating system. One of:

"running" - Guest is running normally.
"shuttingdown" - Guest has a pending shutdown command.
"resetting" - Guest has a pending reset command.
"standby" - Guest has a pending standby command.
"notrunning" - Guest is not running.
"unknown" - Guest information is not available.

guestStateChangeSupported*

xsd:boolean

State change support. If true, the virtual machine is ready to process soft power operations.

Since vSphere API 6.0

hostName*

xsd:string

Hostname of the guest operating system, if known.

hwVersion*

xsd:string

The hardware version string for this virtual machine.

Since vSphere API 6.9.1

interactiveGuestOperationsReady*

xsd:boolean

Interactive Guest Operations availability. If true, the virtual machine is ready to process guest operations as the user interacting with the guest desktop.

Since vSphere API 5.0

ipAddress*

xsd:string

Primary IP address assigned to the guest operating system, if known.

ipStack*

GuestStackInfo[]

Guest information about IP networking stack, if known.

Since vSphere API 4.1

net*

GuestNicInfo[]

Guest information about network adapters, if known.

screen*

GuestScreenInfo

Guest screen resolution info, if known.

toolsInstallType*

xsd:string

Current installation type of VMware Tools in the guest operating system. The set of possible values is described in VirtualMachineToolsInstallType

Since vSphere API 6.5

toolsRunningStatus*

xsd:string

Current running status of VMware Tools in the guest operating system, if known. The set of possible values is described in VirtualMachineToolsRunningStatus

Since vSphere API 4.0

toolsStatus*

VirtualMachineToolsStatus

Deprecated. As of vSphere API 4.0 use toolsVersionStatus and toolsRunningStatus.

Current status of VMware Tools in the guest operating system, if known.

toolsVersion*

xsd:string

Current version of VMware Tools, if known.

toolsVersionStatus*

xsd:string

Deprecated. as of vSphere API 5.1 use toolsVersionStatus2.

Current version status of VMware Tools in the guest operating system, if known. The set of possible values is described in VirtualMachineToolsVersionStatus for vSphere API 5.0.

Since vSphere API 4.0

toolsVersionStatus2*

xsd:string

Current version status of VMware Tools in the guest operating system, if known. The set of possible values is described in VirtualMachineToolsVersionStatus

Since vSphere API 5.0

Properties inherited from DynamicData

None

Need not be set

Required privilege: VirtualMachine.Namespace.EventNotify

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GuestInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="toolsStatus" type="vim25:VirtualMachineToolsStatus" minOccurs="0"/>
                     <element name="toolsVersionStatus" type="xsd:string" minOccurs="0"/>
                     <element name="toolsVersionStatus2" type="xsd:string" minOccurs="0"/>
                     <element name="toolsRunningStatus" type="xsd:string" minOccurs="0"/>
                     <element name="toolsVersion" type="xsd:string" minOccurs="0"/>
                     <element name="toolsInstallType" type="xsd:string" minOccurs="0"/>
                     <element name="guestId" type="xsd:string" minOccurs="0"/>
                     <element name="guestFamily" type="xsd:string" minOccurs="0"/>
                     <element name="guestFullName" type="xsd:string" minOccurs="0"/>
                     <element name="guestDetailedData" type="xsd:string" minOccurs="0"/>
                     <element name="hostName" type="xsd:string" minOccurs="0"/>
                     <element name="ipAddress" type="xsd:string" minOccurs="0"/>
                     <element name="net" type="vim25:GuestNicInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="ipStack" type="vim25:GuestStackInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="disk" type="vim25:GuestDiskInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="screen" type="vim25:GuestScreenInfo" minOccurs="0"/>
                     <element name="guestState" type="xsd:string"/>
                     <element name="appHeartbeatStatus" type="xsd:string" minOccurs="0"/>
                     <element name="guestKernelCrashed" type="xsd:boolean" minOccurs="0"/>
                     <element name="appState" type="xsd:string" minOccurs="0"/>
                     <element name="guestOperationsReady" type="xsd:boolean" minOccurs="0"/>
                     <element name="interactiveGuestOperationsReady" type="xsd:boolean" minOccurs="0"/>
                     <element name="guestStateChangeSupported" type="xsd:boolean" minOccurs="0"/>
                     <element name="generationInfo" type="vim25:GuestInfoNamespaceGenerationInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="hwVersion" type="xsd:string" minOccurs="0"/>
                     <element name="customizationInfo" type="vim25:GuestInfoCustomizationInfo" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - GuestInfo(vim.vm.GuestInfo)

Data Object Description