Name

VMUpgradeVirtualHardware

Description

$err = VMUpgradeVirtualHardware($vmHandle,
                                $options);

Upgrades the virtual hardware version of the virtual machine to match the version of the VIX library. This has no effect if the virtual machine is already at the same version or at a newer version than the VIX library.

Parameters

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

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 = VMUpgradeVirtualHardware($vmHandle,
                                0);
die "VMUpgradeVirtualHardware() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

                               
ReleaseHandle($vmHandle);
HostDisconnect($hostHandle);

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