Data Object - GuestInfo

Property of
VirtualMachine
Extends
DynamicData
See also
GuestDiskInfo, 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
disk*GuestDiskInfo[]

Guest information about disks, if known.
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.
guestStatexsd: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.

hostName*xsd:string

Hostname of the guest operating system, if known.
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.
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*VirtualMachineToolsStatusDeprecated. 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

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 4.0
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition