Name

Description

$err = VMPause($vmHandle, $options, $propertyListHandle);

This function pauses a virtual machine. See Remarks section for pause behavior when used with different operations.

Parameters

vmHandle

Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.

options

Must be zero.

propertyListHandle

Must be VIX_INVALID_HANDLE.

Return Value

Remarks

• This stops execution of the virtual machine.
• Functions that invoke guest operations should not be called when the virtual machine is paused.
• Call VMUnpause to continue execution of the virtual machine.
• Calling VMReset, VMPowerOff, and VMSuspend will successfully work when paused. The pause state is not preserved in a suspended virtual machine; a subsequent VMPowerOn will not remember the previous pause state.
• Calling VMBeginRecording when paused is legal. The actual recording will start when the virtual machine is unpaused.
• Do not call VMBeginReplay when the virtual machine is paused. To do so, call VMPowerOff first, which will reset the pause state. After the virtual machine is powered off, you can then call VMBeginReplay.
• This function is not supported when using the VIX_SERVICEPROVIDER_VMWARE_PLAYER host type.

Side Effects

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;

Example

my $err;
my $snapshotHandle;
my $vmHandle;

# find the appropriate snapshot handle to replay

# start the replay with the UI open
$err = VMBeginReplay($vmHandle, $snapshotHandle, VIX_VMPOWEROP_LAUNCH_GUI, VIX_INVALID_HANDLE);
die "VMBeginReplay() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

# pause the replay
$err = VMPause($vmHandle, 0, VIX_INVALID_HANDLE);
die "VMPause() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

# do something

# unpause the replay
$err = VMUnpause($vmHandle, 0, VIX_INVALID_HANDLE);
die "VMUnpause() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;