VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IGuest Interface Reference

The IGuest interface represents information about the operating system running inside the virtual machine. More...

Inheritance diagram for IGuest:

Public Member Functions

void internalGetStatistics (out unsigned long cpuUser, out unsigned long cpuKernel, out unsigned long cpuIdle, out unsigned long memTotal, out unsigned long memFree, out unsigned long memBalloon, out unsigned long memShared, out unsigned long memCache, out unsigned long pagedTotal, out unsigned long memAllocTotal, out unsigned long memFreeTotal, out unsigned long memBalloonTotal, out unsigned long memSharedTotal)
 Internal method; do not use as it might change at any time. More...
 
void getFacilityStatus (in AdditionsFacilityType facility, out long long timestamp, [retval] out AdditionsFacilityStatus status)
 Get the current status of a Guest Additions facility. More...
 
void getAdditionsStatus (in AdditionsRunLevelType level, [retval] out boolean active)
 Retrieve the current status of a certain Guest Additions run level. More...
 
void setCredentials (in wstring userName, in wstring password, in wstring domain, in boolean allowInteractiveLogon)
 Store login credentials that can be queried by guest operating systems with Additions installed. More...
 
void createSession (in wstring user, in wstring password, in wstring domain, in wstring sessionName, [retval] out IGuestSession guestSession)
 Creates a new guest session for controlling the guest. More...
 
void findSession (in wstring sessionName, [retval] out IGuestSession[] sessions)
 Finds guest sessions by their friendly name and returns an interface array with all found guest sessions. More...
 
void updateGuestAdditions (in wstring source, in wstring[] arguments, in AdditionsUpdateFlag[] flags, [retval] out IProgress progress)
 Automatically updates already installed Guest Additions in a VM. More...
 

Public Attributes

readonly attribute wstring OSTypeId
 Identifier of the Guest OS type as reported by the Guest Additions. More...
 
readonly attribute AdditionsRunLevelType additionsRunLevel
 Current run level of the installed Guest Additions. More...
 
readonly attribute wstring additionsVersion
 Version of the installed Guest Additions in the same format as IVirtualBox::version. More...
 
readonly attribute unsigned long additionsRevision
 The internal build revision number of the installed Guest Additions. More...
 
readonly attribute IGuestDnDSource dnDSource
 Retrieves the drag'n drop source implementation for the guest side, that is, handling and retrieving drag'n drop data from the guest. More...
 
readonly attribute IGuestDnDTarget dnDTarget
 Retrieves the drag'n drop source implementation for the host side. More...
 
readonly attribute IEventSource eventSource
 Event source for guest events. More...
 
readonly attribute IAdditionsFacility[] facilities
 Returns a collection of current known facilities. More...
 
readonly attribute IGuestSession[] sessions
 Returns a collection of all opened guest sessions. More...
 
attribute unsigned long memoryBalloonSize
 Guest system memory balloon size in megabytes (transient property). More...
 
attribute unsigned long statisticsUpdateInterval
 Interval to update guest statistics in seconds. More...
 

Detailed Description

The IGuest interface represents information about the operating system running inside the virtual machine.

Used in IConsole::guest.

IGuest provides information about the guest operating system, whether Guest Additions are installed and other OS-specific virtual machine properties.

Interface ID:
{13A11514-402E-022E-6180-C3944DE3F9C8}

Member Function Documentation

void IGuest::internalGetStatistics ( out unsigned long  cpuUser,
out unsigned long  cpuKernel,
out unsigned long  cpuIdle,
out unsigned long  memTotal,
out unsigned long  memFree,
out unsigned long  memBalloon,
out unsigned long  memShared,
out unsigned long  memCache,
out unsigned long  pagedTotal,
out unsigned long  memAllocTotal,
out unsigned long  memFreeTotal,
out unsigned long  memBalloonTotal,
out unsigned long  memSharedTotal 
)

Internal method; do not use as it might change at any time.

Parameters
cpuUserPercentage of processor time spent in user mode as seen by the guest.
cpuKernelPercentage of processor time spent in kernel mode as seen by the guest.
cpuIdlePercentage of processor time spent idling as seen by the guest.
memTotalTotal amount of physical guest RAM.
memFreeFree amount of physical guest RAM.
memBalloonAmount of ballooned physical guest RAM.
memSharedAmount of shared physical guest RAM.
memCacheTotal amount of guest (disk) cache memory.
pagedTotalTotal amount of space in the page file.
memAllocTotalTotal amount of memory allocated by the hypervisor.
memFreeTotalTotal amount of free memory available in the hypervisor.
memBalloonTotalTotal amount of memory ballooned by the hypervisor.
memSharedTotalTotal amount of shared memory in the hypervisor.
void IGuest::getFacilityStatus ( in AdditionsFacilityType  facility,
out long long  timestamp,
[retval] out AdditionsFacilityStatus  status 
)

Get the current status of a Guest Additions facility.

Parameters
facilityFacility to check status for.
timestampTimestamp (in ms) of last status update seen by the host.
statusThe current (latest) facility status.
void IGuest::getAdditionsStatus ( in AdditionsRunLevelType  level,
[retval] out boolean  active 
)

Retrieve the current status of a certain Guest Additions run level.

Parameters
levelStatus level to check
activeFlag whether the status level has been reached or not
Expected result codes:
VBOX_E_NOT_SUPPORTED Wrong status level specified.
void IGuest::setCredentials ( in wstring  userName,
in wstring  password,
in wstring  domain,
in boolean  allowInteractiveLogon 
)

Store login credentials that can be queried by guest operating systems with Additions installed.

The credentials are transient to the session and the guest may also choose to erase them. Note that the caller cannot determine whether the guest operating system has queried or made use of the credentials.

Parameters
userNameUser name string, can be empty
passwordPassword string, can be empty
domainDomain name (guest logon scheme specific), can be empty
allowInteractiveLogonFlag whether the guest should alternatively allow the user to interactively specify different credentials. This flag might not be supported by all versions of the Additions.
Expected result codes:
VBOX_E_VM_ERROR VMM device is not available.
void IGuest::createSession ( in wstring  user,
in wstring  password,
in wstring  domain,
in wstring  sessionName,
[retval] out IGuestSession  guestSession 
)

Creates a new guest session for controlling the guest.

The new session will be started asynchronously, meaning on return of this function it is not guaranteed that the guest session is in a started and/or usable state. To wait for successful startup, use the IGuestSession::waitFor call.

A guest session represents one impersonated user account in the guest, so every operation will use the same credentials specified when creating the session object via IGuest::createSession. Anonymous sessions, that is, sessions without specifying a valid user account in the guest are not allowed reasons of security.

There can be a maximum of 32 sessions at once per VM. An error will be returned if this has been reached.

For more information please consult IGuestSession

Parameters
userUser name this session will be using to control the guest; has to exist and have the appropriate rights to execute programs in the VM. Must not be empty.
passwordPassword of the user account to be used. Empty passwords are allowed.
domainDomain name of the user account to be used if the guest is part of a domain. Optional. This feature is not implemented yet.
sessionNameThe session's friendly name. Optional, can be empty.
guestSessionThe newly created session object.
void IGuest::findSession ( in wstring  sessionName,
[retval] out IGuestSession[]  sessions 
)

Finds guest sessions by their friendly name and returns an interface array with all found guest sessions.

Parameters
sessionNameThe session's friendly name to find. Wildcards like ? and * are allowed.
sessionsArray with all guest sessions found matching the name specified.
void IGuest::updateGuestAdditions ( in wstring  source,
in wstring[]  arguments,
in AdditionsUpdateFlag[]  flags,
[retval] out IProgress  progress 
)

Automatically updates already installed Guest Additions in a VM.

At the moment only Windows guests are supported.

Because the VirtualBox Guest Additions drivers are not WHQL-certified yet there might be warning dialogs during the actual Guest Additions update. These need to be confirmed manually in order to continue the installation process. This applies to Windows 2000 and Windows XP guests and therefore these guests can't be updated in a fully automated fashion without user interaction. However, to start a Guest Additions update for the mentioned Windows versions anyway, the flag AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See AdditionsUpdateFlag for more information.

Parameters
sourcePath to the Guest Additions .ISO file to use for the update.
argumentsOptional command line arguments to use for the Guest Additions installer. Useful for retrofitting features which weren't installed before in the guest.
flagsAdditionsUpdateFlag flags.
progressProgress object to track the operation completion.
Expected result codes:
VBOX_E_NOT_SUPPORTED Guest OS is not supported for automated Guest Additions updates or the already installed Guest Additions are not ready yet.
VBOX_E_IPRT_ERROR Error while updating.

Member Data Documentation

readonly attribute wstring IGuest::OSTypeId

Identifier of the Guest OS type as reported by the Guest Additions.

You may use IVirtualBox::getGuestOSType to obtain an IGuestOSType object representing details about the given Guest OS type.

Note
If Guest Additions are not installed, this value will be the same as IMachine::OSTypeId.
readonly attribute AdditionsRunLevelType IGuest::additionsRunLevel

Current run level of the installed Guest Additions.

readonly attribute wstring IGuest::additionsVersion

Version of the installed Guest Additions in the same format as IVirtualBox::version.

readonly attribute unsigned long IGuest::additionsRevision

The internal build revision number of the installed Guest Additions.

See also IVirtualBox::revision.

readonly attribute IGuestDnDSource IGuest::dnDSource

Retrieves the drag'n drop source implementation for the guest side, that is, handling and retrieving drag'n drop data from the guest.

readonly attribute IGuestDnDTarget IGuest::dnDTarget

Retrieves the drag'n drop source implementation for the host side.

This will allow the host to handle and initiate a drag'n drop operation to copy data from the host to the guest.

readonly attribute IEventSource IGuest::eventSource

Event source for guest events.

readonly attribute IAdditionsFacility [] IGuest::facilities

Returns a collection of current known facilities.

Only returns facilities where a status is known, e.g. facilities with an unknown status will not be returned.

readonly attribute IGuestSession [] IGuest::sessions

Returns a collection of all opened guest sessions.

attribute unsigned long IGuest::memoryBalloonSize

Guest system memory balloon size in megabytes (transient property).

attribute unsigned long IGuest::statisticsUpdateInterval

Interval to update guest statistics in seconds.