Skip to content

Update Copy-Item.md #2389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2018
Merged

Update Copy-Item.md #2389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions reference/6/Microsoft.PowerShell.Management/Copy-Item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,41 +44,41 @@ To rename an item and not copy it, use the Rename-Item cmdlet.
## EXAMPLES

### Example 1: Copy a file to the specified directory
```
```powershell
PS C:\> Copy-Item "C:\Wabash\Logfiles\mar1604.log.txt" -Destination "C:\Presentation"
```

This command copies the mar1604.log.txt file to the C:\Presentation directory.
The command does not delete the original file.

### Example 2: Copy the contents of a directory to another directory
```
```powershell
PS C:\> Copy-Item "C:\Logfiles" -Destination "C:\Drawings" -Recurse
```

This command copies the entire contents of the Logfiles directory into the Drawings directory.
If the LogFiles directory contains files in subdirectories, those subdirectories will be copied with their file trees intact.
If 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
```
```powershell
PS C:\> Copy-Item C:\Logfiles -Destination C:\Drawings\Logs -Recurse
```

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.

### Example 4: Copy a file to the specified directory and rename the file
```
```powershell
PS C:\> Copy-Item "\\Server01\Share\Get-Widget.ps1" -Destination "\\Server12\ScriptArchive\Get-Widget.ps1.txt"
```

This 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.

### Example 5: Copy a file to a remote computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "D:\Folder001\test.log" -Destination "C:\Folder001_Copy\" -ToSession $Session
```
Expand All @@ -89,30 +89,30 @@ The second command uses the **Copy-Item** cmdlet to copy test.log from the D:\Fo
This command does not delete the original file.

### Example 6: Copy the entire contents of a folder to a remote computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server02" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "D:\Folder002\" -Destination "C:\Folder002_Copy\" -ToSession $Session
```

The 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 will be copied with their file trees intact.
The subfolders are copied with their file trees intact.

### Example 7: Recursively copy the entire contents of a folder to a remote computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server04" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "D:\Folder003\" -Destination "C:\Folder003_Copy\" -ToSession $Session -Recurse
```

The 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 will be copied with their file trees intact.
Since this command uses the *Recurse* parameter, the operation will create the Folder003_Copy folder if it does not already exist.
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.

### Example 8: Copy a file to a remote computer and then rename the file
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server04" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "D:\Folder004\scriptingexample.ps1" -Destination "C:\Folder004_Copy\scriptingexample_copy.ps1" -ToSession $Session
```
Expand All @@ -124,7 +124,7 @@ As part of the copy operation, the command also changes the item name from scrip
This command does not delete the original file.

### Example 9: Copy a remote file to the local computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "C:\MyRemoteData\test.log" -Destination "D:\MyLocalData\" -FromSession $Session
```
Expand All @@ -135,26 +135,26 @@ The second command uses the **Copy-Item** cmdlet to copy test.log from the remot
This command does not delete the original file.

### Example 10: Copy the entire contents of a remote folder to the local computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "C:\MyRemoteData\scripts" -Destination "D:\MyLocalData\" -FromSession $Session
```

The 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 will be copied with their file trees intact.
If the scripts folder contains files in subfolders, those subfolders are copied with their file trees intact.

### Example 11: Recursively copy the entire contents of a remote folder to the local computer
```
```powershell
PS C:\> $Session = New-PSSession -ComputerName "Server01" -Credential "Contoso\PattiFul"
PS C:\> Copy-Item "C:\MyRemoteData\scripts" -Destination "D:\MyLocalData\scripts" -FromSession $Session
PS C:\> Copy-Item "C:\MyRemoteData\scripts" -Destination "D:\MyLocalData\scripts" -FromSession $Session -Recurse
```

The 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 will create the scripts folder if it does not already exist .If the scripts folder contains files in subfolders, those subfolders will be copied with their file trees intact.
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.

## PARAMETERS

Expand All @@ -178,7 +178,7 @@ Specifies a user account that has permission to perform this action.
The default is the current user.

Type a user name, such as User01 or Domain01\User01, or enter a **PSCredential** object, such as one generated by the Get-Credential cmdlet.
If you type a user name, you will be prompted for a password.
If you type a user name, you are prompted for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

Expand Down Expand Up @@ -245,7 +245,7 @@ Accept wildcard characters: False
```

### -Force
Indicates that this cmdlet will copy items that cannot otherwise be changed, such as copying over a read-only file or alias.
Indicates that this cmdlet copies items that cannot otherwise be changed, such as copying over a read-only file or alias.

```yaml
Type: SwitchParameter
Expand All @@ -260,7 +260,7 @@ Accept wildcard characters: False
```

### -Include
Specifies, as a string array, only those items upon which the cmdlet will act, excluding all others.
Specifies, as a string array, only those items upon which the cmdlet acts, excluding all others.

```yaml
Type: String[]
Expand Down Expand Up @@ -462,4 +462,4 @@ For more information, see about_Providers.

[Set-Item](Set-Item.md)

[Get-PSProvider](Get-PSProvider.md)
[Get-PSProvider](Get-PSProvider.md)