Name

Description

$err = VMCopyFileFromGuestToHost($vmHandle,
                                 $guestPathName,
                                 $hostPathName,
                                 $options,
                                 $propertyListHandle);

Copies a file or directory from the guest operating system to the local system (where the Vix client is running).

Parameters

vmHandle

Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.

guestPathName

The path name of a file on a file system available to the guest.

hostPathName

The path name of a file on a file system available to the Vix client.

options

Must be 0.

propertyListHandle

Must be VIX_INVALID_HANDLE.

Return Value

Remarks

• The virtual machine must be running while the file is copied from its guest operating system to the Vix client machine.
• Existing files of the same name are overwritten, and folder contents are merged.
• The copy operation requires VMware Tools to be installed and running in the guest operating system.
• You must call VMLoginInGuest() before calling this procedure.
• The format of the file name depends on the guest or host operating system. For example, a path name for a Microsoft Windows guest or host requires backslash as a directory separator, whereas a Linux guest or host requires a forward slash. If the path name includes backslash characters, you need to precede each one with an escape character.
• Only absolute paths should be used for files in the guest; the resolution of relative paths is not specified.
• If any file fails to be copied, Vix aborts the operation, does not attempt to copy the remaining files, and returns an error.
• In order to copy a file from a mapped network drive in a Windows guest operating system, it is necessary to call VMLoginInGuest() with the VIX_LOGIN_IN_GUEST_REQUIRE_INTERACTIVE_ENVIRONMENT flag set. Using the interactive session option incurs an overhead in file transfer speed.

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,
                                  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;

$err = VMCopyFileFromGuestToHost($vmHandle, 
				 "c:\\guestDir\\helloworld.o",  # src name
				 "c:\\hostDir\\helloworld.o", # dest name
				 0, # options
				 VIX_INVALID_HANDLE); # propertyListHandle
die "VMCopyFileFromGuestToHost() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

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