# Copy-VMGuestFile

This cmdlet copies files and folders from and to the guest OS of the specified virtual machines using VMware Tools. Use the GuestUser and GuestPassword, or GuestCredential parameters to authenticate when connecting to the VMware Tools. To authenticate with the host, use the HostUser and HostPassword, or HostCredential parameters. SSPI is not supported. For a list of supported operating systems, see the PowerCLI User's Guide.

## Syntax

[-Destination]  <String>
[-VM]  <VirtualMachine[]>
-GuestToLocal
-Source  <String[]>
[-Force]
[-GuestCredential  <PSCredential>]
[-GuestUser  <String>]
[-HostCredential  <PSCredential>]
[-HostUser  <String>]
[-Server  <VIServer[]>]
[-ToolsWaitSecs  <Int32>]
[CommonParameters]

#### Parameters

Required Parameter Name Type Position Features Description
required
Destination
String 1 Specifies the destination path where you want to copy the file. If the destination points to a virtual machine, specify the absolute file path. Relative destination paths are supported only when copying files to a local storage.
required
VM
VirtualMachine[] 2
• wildcards
• pipeline
• Specifies the virtual machine where the file is located.
required
GuestToLocal
SwitchParameter named Indicates that you want to copy a file from the guest operating system of the virtual machine to a local directory.
required
Source
String[] named
• wildcards
• Specifies the file you want to copy. If the file is on a virtual machine, specifies the absolute file path. Relative file paths are supported only when copying files from a local storage. Wildcards are allowed only at the end of the source path. If you are copying files from the guest operating system of a virtual machine to a local directory, the Source parameter supports wildcards only on vCenter Server 5.0 and later.
optional
Force
SwitchParameter named Indicates that the non-existing directories in the specified destination path are automatically created.
optional
GuestCredential
PSCredential named Specifies a PSCredential object that contains credentials for authenticating with the guest OS where the file to be copied is located.
optional
SecureString named Specifies the password you want to use for authenticating with the guest OS where the file to be copied is located.
optional
GuestUser
String named Specifies the user name you want to use for authenticating with the guest OS where the file to be copied is located.
optional
HostCredential
PSCredential named Specifies a PSCredential object that contains credentials for authenticating with the host where the file is to be copied. Do not use this parameter if the HostUser and HostPassword parameters are used. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.
optional
SecureString named Specifies the password you want to use for authenticating with the host where the file is to be copied. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.
optional
HostUser
String named Specifies the user name you want to use for authenticating with the host where the file is to be copied. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.
optional
Server
VIServer[] named
• wildcards
• Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. optional ToolsWaitSecs Int32 named Specifies the time in seconds to wait for a response from the VMware Tools. If a non-positive value is provided, the system waits infinitely long time. [-Destination] <String> [-VM] <VirtualMachine[]> -LocalToGuest -Source <String[]> [-Force] [-GuestCredential <PSCredential>] [-GuestPassword <SecureString>] [-GuestUser <String>] [-HostCredential <PSCredential>] [-HostPassword <SecureString>] [-HostUser <String>] [-Server <VIServer[]>] [-ToolsWaitSecs <Int32>] [CommonParameters] #### Parameters Required Parameter Name Type Position Features Description required Destination String 1 Specifies the destination path where you want to copy the file. If the destination points to a virtual machine, specify the absolute file path. Relative destination paths are supported only when copying files to a local storage. required VM VirtualMachine[] 2 • wildcards • pipeline • Specifies the virtual machine where the file is located. required LocalToGuest SwitchParameter named Indicates that you want to copy a file from a local directory to the guest operating system of the virtual machine. required Source String[] named • wildcards • Specifies the file you want to copy. If the file is on a virtual machine, specifies the absolute file path. Relative file paths are supported only when copying files from a local storage. Wildcards are allowed only at the end of the source path. If you are copying files from the guest operating system of a virtual machine to a local directory, the Source parameter supports wildcards only on vCenter Server 5.0 and later. optional Force SwitchParameter named Indicates that the non-existing directories in the specified destination path are automatically created. optional GuestCredential PSCredential named Specifies a PSCredential object that contains credentials for authenticating with the guest OS where the file to be copied is located. optional GuestPassword SecureString named Specifies the password you want to use for authenticating with the guest OS where the file to be copied is located. optional GuestUser String named Specifies the user name you want to use for authenticating with the guest OS where the file to be copied is located. optional HostCredential PSCredential named Specifies a PSCredential object that contains credentials for authenticating with the host where the file is to be copied. Do not use this parameter if the HostUser and HostPassword parameters are used. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. optional HostPassword SecureString named Specifies the password you want to use for authenticating with the host where the file is to be copied. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. optional HostUser String named Specifies the user name you want to use for authenticating with the host where the file is to be copied. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. optional Server VIServer[] named • wildcards • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or$null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional
ToolsWaitSecs
Int32 named Specifies the time in seconds to wait for a response from the VMware Tools. If a non-positive value is provided, the system waits infinitely long time.

## Examples

#### Example 1

Copy-VMGuestFile -Source c:\text.txt -Destination c:\temp\ -VM VM -GuestToLocal -GuestUser user -GuestPassword pass2

Copies the text.txt file from the guest OS system to the local Temp directory.

#### Example 2

$vm = Get-VM -Name VM Get-Item "c:\FolderToCopy\*.*" | Copy-VMGuestFile -Destination "c:\MyFolder" -VM$vm -LocalToGuest -GuestUser -GuestPassword pass2

Copies files from a local machine to a guest operating system.

Feedback