Name

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

Remarks

• The virtual machine must be powered off to do this operation.
• When the VM is already up-to-date, the job handle for this function will return VIX_E_VM_ALREADY_UP_TO_DATE.

Side Effects

Requirements

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

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,
                                  NULL, # hostName
                                  0, # hostPort
                                  NULL, # userName
                                  NULL, # 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);