vSphere PowerCLI Reference

Copy-DatastoreItem

Synopsis

This cmdlet copies items between datastores and between a datastore and a local file system provider.

Syntax

Copy-DatastoreItem [-Item] <Object[]> [[-Destination] <Object>] [-Force] [-PassThru] [-Recurse] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet copies items between datastores and between a datastore and a local file system provider.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ItemObject[]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.truetrue (ByValue)
DestinationObjectSpecifies 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.falsefalse.
ConfirmSwitchParameterIf 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.falsefalse$true
ForceSwitchParameterIndicates whether to overwrite all items with the same name at the provided destination.falsefalse$false
PassThruSwitchParameterIndicates that the cmdlet returns the copied item.falsefalse$false
RecurseSwitchParameterIndicates that you want to copy not only the item, but its children items as well.falsefalse$false
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

Zero or more FileInfo or DatastoreItem objects

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.


Copyright © 1998 - 2013 VMware, Inc. All rights reserved.