Name

VMSuspend

Description

$err = VMSuspend($vmHandle,
                 $powerOffOptions);

This function suspends a virtual machine.

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
powerOffOptions
Must be 0.

Return Value

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

Remarks

This function suspends a virtual machine. If the virtual machine is not powered on when you call this function, the function returns an error.

Side Effects

None.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Server 1.0
Copyright (C) 2007-2008 VMware, Inc. All rights reserved.