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
Should be 0.

Return Value

$err. Either VIX_OK, or an error code returned by the operation. For returned values, see Topics > Error Codes.

Remarks

Side Effects

None.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Server 1.0

Example

my $err = VIX_OK;
my $hostHandle = VIX_INVALID_HANDLE;
my $vmHandle = VIX_INVALID_HANDLE;

($err, $hostHandle) = HostConnect(VIX_API_VERSION,
                                  VIX_SERVICEPROVIDER_VMWARE_VI_SERVER,
                                  "https://10.1.9.245/sdk", # hostName
                                  0, # hostPort
                                  "root", # userName
                                  "secret", # password
                                  0, # options
                                  VIX_INVALID_HANDLE); # propertyListHandle

die "HostConnect() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

($err, $vmHandle) = VMOpen($hostHandle,
                           "[storage1] vm/vm.vmx");
die "VMOpen() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;
                       
# Assume this virtual machine is already running
$err = VMSuspend($vmHandle,
                  0); # powerOffOptions
die "VMPowerOff() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

Copyright (C) 2007-2011 VMware, Inc. All rights reserved.