Copy-​VM​File

Copies a file to a virtual machine.

Syntax

Copy-VMFile
    [-Name] <String[]>
    [-SourcePath] <String>
    [-DestinationPath] <String>
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Confirm]
    [-CreateFullPath]
    [-Credential <PSCredential[]>]
    -FileSource <CopyFileSourceType>
    [-Force]
    [-WhatIf]
    [<CommonParameters>]
Copy-VMFile
    [-VM] <VirtualMachine[]>
    [-SourcePath] <String>
    [-DestinationPath] <String>
    [-AsJob]
    [-Confirm]
    [-CreateFullPath]
    -FileSource <CopyFileSourceType>
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

Description

The Copy-VMFile cmdlet copies a file to a virtual machine.

Examples

Example 1

PS C:\> Copy-VMFile "Test VM" -SourcePath "D:\Test.txt" -DestinationPath "C:\Temp\Test.txt" -CreateFullPath -FileSource Host

This example copies the file "test.txt" from the host operating system into the guest operating system of the virtual machine "Test VM". It will create the directory "C:\Temp" inside the guest operating system if it does not exist already.

Required Parameters

-DestinationPath

Specifies a path. The cmdlet copies the file to the destination path.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FileSource

Specifies the type of a file source.

Type:CopyFileSourceType
Parameter Sets:Host
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies an array of virtual machine objects by name. The cmdlet copies files to the virtual machines you specify.

Type:String[]
Aliases:VMName
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourcePath

Specifies a path. The cmdlet copies the file from the source path.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VM

Specifies an array of virtual machine objects. The cmdlet copies files to the virtual machines you specify. To obtain a virtual machine object, use the Get-VM cmdlet.

Type:VirtualMachine[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies an array of Hyper-V hosts. The cmdlet copies the file to the hosts you specify.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-CreateFullPath

Indicates that when the cmdlet copies a file, it creates folders if the folder does not already exist.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False