vSphere PowerCLI Reference

Copy-HardDisk

Synopsis

Copies a virtual hard disk to another destination.

Syntax

Copy-HardDisk [-HardDisk] <HardDisk[]> [-DestinationPath] <String> [-DestinationStorageFormat <VirtualDiskStorageFormat>] [-Force] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-HardDisk
New-HardDisk
Remove-HardDisk
Set-HardDisk
Move-HardDisk

Detailed Description

Copies a virtual hard disk to another destination specified by the DestinationPath parameter. DestinationPath must be a datastore path to the destination folder.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
DestinationPathStringSpecifies the datastore path to the folder where you want to copy the hard disk. The datastore name is included in the path in square braces.truefalse
HardDiskHardDisk[]Specifies the virtual hard disk you want to copy.truetrue (ByValue)
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
DestinationStorageFormatVirtualDiskStorageFormatSpecifies the type of the hard disk copy. The valid values are Thin, Thick, and EagerZeroedThick. This parameter is only applicable when you are connected to an ESX/ESXi host.falsefalse
ForceSwitchParameterIndicates whether to overwrite all disks with the same name at the provided destination.falsefalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The copied HardDisk object

Notes

Supported only on ESX 4.1 and later.

Examples

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

Get-HardDisk -VM $vm | Copy-HardDisk "[Storage1]/"

Retrieves the hard disks of a virtual machine and copies them into the storage1 root folder.

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

Copy-HardDisk -HardDisk $hdd -DestinationPath "[Storage1] vms/disks" -DestinationStorageFormat Thick

Copies the $hdd hard disk to the "vms/disks"location on storage1 and changes the storage format of the destination disk to Thick.


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