Copy-DatastoreItem

Synopsis

Syntax

Related Commands

Online version

Detailed Description

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Item	Object[]	Specifies the datastore item you want to copy. You can use a string to provide a relative path to the item in the current provider location.	true	true (ByValue)
Destination	Object	Specifies the destination where you want to copy the datastore item. You can use a string to specify a relative path to the destination object in the current provider location.	false	false
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false
Force	SwitchParameter	Indicates whether to overwrite all items with the same name at the provided destination.	false	false
PassThru	SwitchParameter	Indicates that the cmdlet returns the copied item.	false	false
Recurse	SwitchParameter	Indicates that you want to copy not only the item, but its children items as well.	false	false
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Name

Type

Description

Required?

Pipeline Input

Default Value

Item

Object[]

Specifies the datastore item you want to copy. You can use a string to provide a relative path to the item in the current provider location.

true

true (ByValue)

Destination

Object

Specifies the destination where you want to copy the datastore item. You can use a string to specify a relative path to the destination object in the current provider location.

false

Confirm

SwitchParameter

If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.

false

Force

SwitchParameter

Indicates whether to overwrite all items with the same name at the provided destination.

false

PassThru

SwitchParameter

Indicates that the cmdlet returns the copied item.

false

Recurse

SwitchParameter

Indicates that you want to copy not only the item, but its children items as well.

false

WhatIf

SwitchParameter

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

false

Return Type

DatastoreItem

Notes

Examples

-------------- Example 1 --------------

Copy-DatastoreItem vmstore:\Datacenter\Storage1\MyVM\* c:\VMFolder\MyVM\

Copies the contents of a datastore folder in a local folder.

-------------- Example 2 --------------

Copy-DatastoreItem c:\VMFolder\MyVM\* vmstore:\Datacenter\Storage1\NewVM\ -Force

Copies the contents of a local folder into a datastore folder. If the destination folder does not exist, the Force parameter enforces its creation.

-------------- Example 3 --------------

Copy-DatastoreItem c:\VMFolder\* vmstore:\Datacenter\Storage1\VMs\ -Force -Recurse

Copies recursively the contents of a local folder into a datastore folder.

-------------- Example 4 --------------

Copy-DatastoreItem Windows.ISO vmstore:\Datacenter\Storage1\ISOFiles\WinXPSP3.iso

Copies a file into a datastore folder and changes the file name.

PowerCLI Reference

Synopsis