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
- If you pass VIX_VMPOWEROP_NORMAL as the options, this function is the
equivalent of pressing the reset button on a physical machine.
- The VIX_VMPOWEROP_FROM_GUEST flag will cause the function to try to reset
the guest OS. This will ensure a clean shutdown of the guest. This option
requires that the VMware Tools be installed and running in the guest.
- The reset is an asynchronous operation. The job will be signalled when the
operation completes.
- If the virtual machine is not powered on when you call this function, it returns
an error.
- After reset, you must call
VixVM_WaitForToolsInGuest
before executing guest operations or querying guest properties.
Side Effects
None.
Requirements
vix.h, since VMware Server 1.0