Name

VMDelete

Description

$err = VMDelete($vmHandle,
                $deleteOptions);

This function permanently deletes a virtual machine from your host system.

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
deleteOptions
For VMware Server 2.0 and ESX, this value must be VIX_VMDELETE_DISK_FILES. For all other versions it can be either 0 or VIX_VMDELETE_DISK_FILES. When option is VIX_VMDELETE_DISK_FILES, deletes all associated files. When option is 0, does not delete *.vmdk virtual disk file(s).

Return Value

$err. The 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_WORKSTATION,
                                  undef, # hostName
                                  0, # hostPort
                                  undef, # userName
                                  undef, # password
                                  0, # options
                                  VIX_INVALID_HANDLE); # propertyListHandle

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

($err, $vmHandle) = VMOpen($hostHandle,
                           "c:\\Virtual Machines\\vm1\\win2000.vmx");
die "VMOpen() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;
                       
$err = VMDelete($vmHandle, VIX_VMDELETE_DISK_FILES);
die "VMDelete() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;


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