Name
VixVM_Reset
Description
VixHandle
VixVM_Reset(VixHandle vmHandle,
VixVMPowerOpOptions powerOnOptions,
VixEventProc *callbackProc,
void *clientData);
This function resets a virtual machine.
Parameters
- vmHandle
-
Identifies a virtual machine. Call VixVM_Open() to create a virtual machine handle.
- powerOnOptions
-
Must be VIX_VMPOWEROP_NORMAL or VIX_VMPOWEROP_FROM_GUEST.
- callbackProc
-
A callback function that will be invoked when the power
operation is complete.
- clientData
-
A parameter that will be passed to the callbackProc function.
Return Value
VixHandle. A job handle that describes the state of this asynchronous operation.
Remarks
- This function resets a virtual machine.
It is an asynchronous operation,
and the job will be signaled when the operation completes.
- If the virtual machine is not powered on when you call this function,
it returns an error.
- If you pass VIX_VMPOWEROP_NORMAL as an option, this function is
the equivalent of pressing the reset button on a physical machine.
- If you pass VIX_VMPOWEROP_FROM_GUEST as an option, this function tries to
reset the guest OS, ensuring a clean shutdown of the guest. This option
requires that the VMware Tools be installed and running in the guest.
- After VMware Tools begin running in the guest, and
VixVM_WaitForToolsInGuest
returns, there is a short delay before VIX_VMPOWEROP_FROM_GUEST becomes available.
During this time a job may return error 3009, VIX_E_POWEROP_SCRIPTS_NOT_AVAILABLE.
As a workaround, add a short sleep after the WaitForTools call.
- After reset, you must call
VixVM_WaitForToolsInGuest
before executing guest operations or querying guest properties.
- On a Solaris guest with UFS file system on the root partition, the
VIX_VMPOWEROP_NORMAL parameter causes an error screen at next power on,
which requires user intervention to update the Solaris boot archive by
logging into the failsafe boot session from the GRUB menu. Hence, although UFS
file systems are supported, VMware recommends using the ZFS file system for
Solaris guests.
Side Effects
None.
Requirements
vix.h, since VMware Server 1.0