vSphere PowerCLI Reference

Get-HardDisk

Synopsis

This cmdlet retrieves the virtual hard disks available on a vCenter Server system.

Syntax

Get-HardDisk [-Id <String[]>] [-Path <DatastoreItem[]>] [-DiskType <DiskType[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-HardDisk -RelatedObject <HardDiskRelatedObjectBase[]> [<CommonParameters>]
Get-HardDisk [-Id <String[]>] -Datastore <Datastore[]> [-DatastorePath <String[]>] [-DiskType <DiskType[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-HardDisk [-Id <String[]>] [-DiskType <DiskType[]>] [-Server <VIServer[]>] [[-VM] <VirtualMachine[]>] [[-Template] <Template[]>] [[-Snapshot] <Snapshot[]>] [-Name <String[]>] [<CommonParameters>]

Related Commands

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

Detailed Description

This cmdlet returns the virtual hard disks available on a vCenter Server system. You can retrieve a hard disk by specifying the virtual machines, templates, or snapshots to which it belongs. If the hard disk is not attached to any virtual machines, templates, or snapshots, you can search for it in datastores or retrieve it by providing a datastore path to the file where the virtual hard disk is stored. In this case, you might not be able to derive disk type info, and the value of the DiskType property of the hard disk is Unknown.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines from which you want to retrieve the hard disks.falsetrue (ByValue)
TemplateTemplate[]Specifies the virtual machine templates from which you want to retrieve the hard disks.falsetrue (ByValue)
SnapshotSnapshot[]Specifies the snapshots from which you want to retrieve the hard disks.falsetrue (ByValue)
DatastoreDatastore[]Specifies the datastores or datastore clusters you want to search for hard disks. This parameter is required when retrieving a hard disk that is attached to no virtual machines, templates, or snapshots.truetrue (ByValue)
DatastorePathString[]Specifies datastore paths to the hard disks you want to retrieve. The paths must be in the following format: [datastore_name] <file_path>, where [datastore_name] is the name of the datastore in square brackets and <file_path> is a slash-delimited path from the root of the datastore to the virtual hard disk file.
The cmdlet searches recursively the specified locations.

To learn more about the Datastore Provider, in the vSphere PowerCLI service console, type:

help about_vimdatastore
falsefalse
DiskTypeDiskType[]Specifies the type of the hard disks you want to retrieve. The valid values are rawVirtual, rawPhysical, flat, and unknown. If the hard disk is not attached to any virtual machines, templates, or snapshots, you can retrieve it by providing a datastore path to the file where the virtual hard disk is stored. In this case, you might not be able to derive disk type info, and the value of the DiskType property of the hard disk is Unknown.falsefalse
IdString[]Specifies the IDs of the hard disks you want to retrieve.

Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
falsefalse
NameString[]Specifies the names of the SCSI hard disks you want to retrieve.falsefalse
PathDatastoreItem[]Specifies the file paths to the virtual hard disks you want to retrieve. The cmdlet searches recursively the specified locations.falsefalse
RelatedObjectHardDiskRelatedObjectBase[]Specifies objects to retrieve one or more HardDisk objects that are related to them.truetrue (ByValue)
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse

Return Type

Zero or more HardDisk objects

Notes

Examples

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

Get-HardDisk -VM VM

Retrieves the hard disks of the virtual machine named VM.

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

Get-HardDisk -VM $vm -DiskType flat

Retrieves the flat hard disks from the specified virtual machines.

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

Get-HardDisk -Datastore "Storage1" -DatastorePath "[Storage1] myVM/"

Retrieves the hard disks from the specified datastore and from the specified datastore path.


Copyright © VMware, Inc. All rights reserved.