# Data Object - GuestInfo(vim.vm.GuestInfo)

Property of
  VirtualMachine
Extends
  DynamicData
See also
  GuestDiskInfo, GuestInfoNamespaceGenerationInfo, GuestNicInfo, GuestScreenInfo, GuestStackInfo, VirtualMachineToolsStatus

## Data Object Description

Information about the guest operating system.

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
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
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 vitrual machine is ready to process soft power operations. Since vSphere API 6.0
hostName* | xsd:string | Hostname of the guest operating system, if known.
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 P Required privilege: VirtualMachine.Namespace.EventNotify
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GuestInfo"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="toolsStatus" type="vsan: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="hostName" type="xsd:string" minOccurs="0"/> <element name="ipAddress" type="xsd:string" minOccurs="0"/> <element name="net" type="vsan:GuestNicInfo" minOccurs="0" maxOccurs="unbounded"/> <element name="ipStack" type="vsan:GuestStackInfo" minOccurs="0" maxOccurs="unbounded"/> <element name="disk" type="vsan:GuestDiskInfo" minOccurs="0" maxOccurs="unbounded"/> <element name="screen" type="vsan: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="vsan:GuestInfoNamespaceGenerationInfo" minOccurs="0" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType>