Syntax
Copy-HardDisk [-DestinationPath] <String> [-HardDisk] <HardDisk[]> [-DestinationStorageFormat <VirtualDiskStorageFormat>] [-Force] [-RunAsync] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed 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
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
DestinationPath | String | Specifies 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. | true | False | |
HardDisk | HardDisk[] | Specifies the virtual hard disk you want to copy. | true | True (ByValue) | |
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 | |
DestinationStorageFormat | VirtualDiskStorageFormat | Specifies 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. | false | False | |
Force | SwitchParameter | Indicates whether to overwrite all disks with the same name at the provided destination. | false | False | |
RunAsync | SwitchParameter | Indicates 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 VMware PowerCLI console. | 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 |
Return Type
The copied HardDisk objectNotes
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.