Name

VMRunProgramInGuest

Description

$err = VMRunProgramInGuest($vmHandle,
                           $guestProgramName,
                           $commandLineArgs,
                           $options,
                           $propertyListHandle);

This function runs a program in the guest operating system. The program must be stored on a file system available to the guest before calling this function.

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
guestProgramName
The path name of an executable file on the guest operating system.
commandLineArgs
A string to be passed as command line arguments to the executable identified by guestProgramName.
options
Run options for the program. See the remarks below.
propertyListHandle
Must be VIX_INVALID_HANDLE.

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

$err = VMLoginInGuest($vmHandle,
                      "vixuser", # userName
                      "secret", # password
                      0); # options
die "VMLoginInGuest() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;


# Run the target program.
$err =  VMRunProgramInGuest($vmHandle,
			    "c:\\myProgram.exe",
			    "/flag arg1 arg2",
			    0, # options
			    VIX_INVALID_HANDLE);
die "VMRunProgramInGuest() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

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

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