| ms.date | schema | locale | keywords | online version | external help file | title |
|---|---|---|---|---|---|---|
5/14/2019 |
2.0.0 |
en-us |
powershell,cmdlet |
Microsoft.PowerShell.Commands.Management.dll-Help.xml |
Copy-Item |
Copies an item from one location to another.
Copy-Item [-Path] <String[]> [[-Destination] <String>] [-Container] [-Force] [-Filter <String>]
[-Include <String[]>] [-Exclude <String[]>] [-Recurse] [-PassThru] [-Credential <PSCredential>]
[-WhatIf] [-Confirm] [-FromSession <PSSession>] [-ToSession <PSSession>] [<CommonParameters>]
Copy-Item -LiteralPath <String[]> [[-Destination] <String>] [-Container] [-Force] [-Filter <String>]
[-Include <String[]>] [-Exclude <String[]>] [-Recurse] [-PassThru] [-Credential <PSCredential>]
[-WhatIf] [-Confirm] [-FromSession <PSSession>] [-ToSession <PSSession>] [<CommonParameters>]
The Copy-Item cmdlet copies an item from one location to another location in the same namespace.
For instance, it can copy a file to a folder, but it cannot copy a file to a certificate drive.
This cmdlet does not cut or delete the items being copied. The particular items that the cmdlet can copy depend on the PowerShell provider that exposes the item. For instance, it can copy files and directories in a file system drive and registry keys and entries in the registry drive.
This cmdlet can copy and rename items in the same command.
To rename an item, enter the new name in the value of the Destination parameter.
To rename an item and not copy it, use the Rename-Item cmdlet.
This command copies the mar1604.log.txt file to the C:\Presentation directory.
The command does not delete the original file.
Copy-Item "C:\Wabash\Logfiles\mar1604.log.txt" -Destination "C:\Presentation"This command copies the entire contents of the "Logfiles" directory into the "Drawings" directory.
Copy-Item "C:\Logfiles\*" -Destination "C:\Drawings" -RecurseIf the "LogFiles" directory contains files in subdirectories, those subdirectories are copied with their file trees intact. The Container parameter is set to "true" by default.
This preserves the directory structure.
Example 3: Copy the contents of a directory to another directory and create the destination directory if it does not exist
This command copies the contents of the C:\Logfiles directory to the C:\Drawings\Logs directory.
It creates the "\Logs" subdirectory if it does not already exist.
Copy-Item C:\Logfiles -Destination C:\Drawings\Logs -RecurseThis command uses the Copy-Item cmdlet to copy the Get-Widget.ps1 script from the
\\Server01\Share directory to the \\Server12\ScriptArchive directory.
As part of the copy operation, the command also changes the item name from Get-Widget.ps1 to
Get-Widget.ps1.txt, so it can be attached to email messages.
Copy-Item "\\Server01\Share\Get-Widget.ps1" -Destination "\\Server12\ScriptArchive\Get-Widget.ps1.txt"The first command creates a session to the remote computer named "Server01" with the credential of
"Contoso\PattiFu" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy test.log from the D:\Folder001 folder to
the C:\Folder001_Copy folder on the remote computer using the session information stored in the
$Session variable. This command does not delete the original file.
$Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
Copy-Item "D:\Folder001\test.log" -Destination "C:\Folder001_Copy\" -ToSession $SessionThe first command creates a session to the remote computer named "Server01" with the credential of
Contoso\PattiFul and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy the entire contents from the D:\Folder002
folder to the C:\Folder002_Copy directory on the remote computer using the session information
stored in the $Session variable. The subfolders are copied with their file trees intact.
$Session = New-PSSession -ComputerName "Server02" -Credential "Contoso\PattiFul"
Copy-Item "D:\Folder002\" -Destination "C:\Folder002_Copy\" -ToSession $SessionThe first command creates a session to the remote computer named Server01 with the credential of
"Contoso\PattiFul" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy the entire contents from the D:\Folder003
folder to the C:\Folder003_Copy directory on the remote computer using the session information
stored in the $Session variable. The subfolders are copied with their file trees intact.
Since this command uses the Recurse parameter, the operation creates the "Folder003_Copy" folder
if it does not already exist.
$Session = New-PSSession -ComputerName "Server04" -Credential "Contoso\PattiFul"
Copy-Item "D:\Folder003\" -Destination "C:\Folder003_Copy\" -ToSession $Session -RecurseThe first command creates a session to the remote computer named "Server01" with the credential of
"Contoso\PattiFul" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy scriptingexample.ps1 from the
D:\Folder004 folder to the "C:\Folder004_Copy" folder on the remote computer using the session
information stored in the $Session variable.
As part of the copy operation, the command also changes the item name from scriptingexample.ps1 to
scriptingexample_copy.ps1, so it can be attached to email messages.
This command does not delete the original file.
$Session = New-PSSession -ComputerName "Server04" -Credential "Contoso\PattiFul"
Copy-Item "D:\Folder004\scriptingexample.ps1" -Destination "C:\Folder004_Copy\scriptingexample_copy.ps1" -ToSession $SessionThe first command creates a session to the remote computer named "Server01" with the credential of
"Contoso\PattiFul" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy test.log from the remote C:\MyRemoteData\
to the local D:\MyLocalData folder using the session information stored in the $Session
variable. This command does not delete the original file.
$Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
Copy-Item "C:\MyRemoteData\test.log" -Destination "D:\MyLocalData\" -FromSession $SessionThe first command creates a session to the remote computer named "Server01" with the credential of
"Contoso\PattiFul" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy the entire contents from the remote
C:\MyRemoteData\scripts folder to the local D:\MyLocalData folder using the session information
stored in the $Session variable.
If the scripts folder contains files in subfolders, those subfolders are copied with their file
trees intact.
$Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
Copy-Item "C:\MyRemoteData\scripts" -Destination "D:\MyLocalData\" -FromSession $SessionThe first command creates a session to the remote computer named "Server01" with the credential of
"Contoso\PattiFul" and stores the results in the variable named $Session.
The second command uses the Copy-Item cmdlet to copy the entire contents from the remote
C:\MyRemoteData\scripts folder to the local D:\MyLocalData\scripts folder using the session
information stored in the $Session variable.
Since this command uses the Recurse parameter, the operation creates the scripts folder if it
does not already exist. If the scripts folder contains files in subfolders, those subfolders are
copied with their file trees intact.
$Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
Copy-Item "C:\MyRemoteData\scripts" -Destination "D:\MyLocalData\scripts" -FromSession $Session -RecurseIndicates that this cmdlet preserves container objects during the copy operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNote
This parameter is not supported by any providers installed with PowerShell. To impersonate another user, or elevate your credentials when running this cmdlet, use Invoke-Command.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Current user
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the path to the new location. The default is the current directory.
To rename the item being copied, specify a new name in the value of the Destination parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies, as a string array, an item or items that this cmdlet excludes in the operation. The value
of this parameter qualifies the Path parameter. Enter a path element or pattern, such as
*.txt. Wildcard characters are permitted. The Exclude parameter is effective only when the
command includes the contents of an item, such as C:\Windows\*, where the wildcard character
specifies the contents of the C:\Windows directory.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueSpecifies a filter to qualify the Path parameter. The FileSystem provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards. Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueIndicates that this cmdlet copies items that cannot otherwise be changed, such as copying over a read-only file or alias.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the PSSession object from which a remote file is being copied. When you use this parameter, the Path and LiteralPath parameters refer to the local path on the remote machine.
Type: PSSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies, as a string array, an item or items that this cmdlet includes in the operation. The value
of this parameter qualifies the Path parameter. Enter a path element or pattern, such as
"*.txt". Wildcard characters are permitted. The Include parameter is effective only when the
command includes the contents of an item, such as C:\Windows\*, where the wildcard character
specifies the contents of the C:\Windows directory.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueSpecifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.
For more information, see about_Quoting_Rules.
Type: String[]
Parameter Sets: LiteralPath
Aliases: PSPath
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseReturns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies, as a string array, the path to the items to copy. Wildcard characters are permitted.
Type: String[]
Parameter Sets: Path
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: TrueIndicates that this cmdlet performs a recursive copy.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the PSSession object to which a remote file is being copied. When you use this parameter, the Path and LiteralPath parameters refer to the local path on the remote machine.
Type: PSSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
-Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
You can pipe a string that contains a path to this cmdlet.
When you use the PassThru parameter, this cmdlet returns an object that represents the copied item. Otherwise, this cmdlet does not generate any output.
This cmdlet is designed to work with the data exposed by any provider.
To list the providers available in your session, type Get-PsProvider.
For more information, see about_Providers.