Name

VMInstallTools

Description

$err = VMInstallTools($vmHandle,
                      $options,
                      $commandLineArgs);

Prepares to install VMware Tools on the guest operating system.

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
options
May be either VIX_INSTALLTOOLS_MOUNT_TOOLS_INSTALLER or VIX_INSTALLTOOLS_AUTO_UPGRADE. Either flag can be combined with the VIX_INSTALLTOOLS_RETURN_IMMEDIATELY flag using the bitwise inclusive OR operator (|). See remarks for more information.
commandLineArgs
Must be undef.

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
Minimum Supported Guest OS: Microsoft Windows NT Series, Linux

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

$err = VMInstallTools($vmHandle,
                      VIX_INSTALLTOOLS_MOUNT_TOOLS_INSTALLER,	# options
                      undef);	# commandLineArgs
die "VMInstallTools() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

$err = VMPowerOff($vmHandle,
                  0); # powerOnOptions
die "VMPowerOff() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;


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