< Back

Copy-HardDisk

Sun Jan 19, 2020 6:48 pm

NAME Copy-HardDisk



SYNOPSIS

Copies a virtual hard disk to another destination.





SYNTAX

Copy-HardDisk [-DestinationPath] <String> [-HardDisk] <HardDisk[]> [-DestinationStorageFormat

<VirtualDiskStorageFormat>] [-Force] [-RunAsync] [-Confirm] [-WhatIf] [<CommonParameters>]





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

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



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-HardDisk <HardDisk[]>

Specifies the virtual hard disk you want to copy.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? 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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

The copied HardDisk object







NOTES





Supported only on ESX 4.1 and later.



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... dDisk.html

Get-HardDisk

New-HardDisk

Remove-HardDisk

Set-HardDisk

Move-HardDisk