Export (0) Print
Expand All
Expand Minimize

Get-VHD

Windows Server 2012 R2 and Windows 8.1

Updated: June 10, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-VHD

Gets the virtual hard disk object associated with a virtual hard disk.

Syntax

Parameter Set: Path
Get-VHD [-Path] <String[]> [-ComputerName <String[]> ] [ <CommonParameters>]

Parameter Set: Disk
Get-VHD [-DiskNumber] <UInt32> [-ComputerName <String[]> ] [ <CommonParameters>]

Parameter Set: VMId
Get-VHD [-VMId] <Guid[]> [-ComputerName <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-VHD cmdlet gets the virtual hard disk object associated with a virtual hard disk.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which a virtual hard disk is to be retrieved. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.


Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DiskNumber<UInt32>

Specifies the disk number associated with the virtual hard disk to be retrieved.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

Specifies the path to the virtual hard disk file of the virtual hard disk to be retrieved. If a filename or relative path is specified, the path is calculated relative to the current working directory.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

true

-VMId<Guid[]>

Specifies the virtual machine identifier of the virtual machine whose virtual hard disks are to be retrieved.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • VHDObject[]

Examples

Example 1

Gets the virtual hard disk where the path to the virtual hard disk file is c:\test\testvhdx.vhdx.


PS C:\> Get-VHD –Path c:\test\testvhdx.vhdx

Example 2

Gets the virtual hard disk attached to the system with disk number 6.


PS C:\> Get-VHD –DiskNumber 6

Example 3

Gets the virtual hard disk objects associated with virtual machine TestVM, using the pipeline feature for the VMId parameter.


PS C:\> Get-VM -VMName TestVM | Select-Object VMId | Get-VHD

Example 4

Gets the virtual hard disk objects associated with virtual machine testvm using the pipeline feature for the path parameter.


PS C:\> Get-VM –VMName testvm | Select-Object vmid | Get-VHD

Example 5

Gets the virtual hard disk object for all the virtual hard disk files that are contained in the specified directory and its subdirectories.


PS C:\> Get-ChildItem c:\test –Recurse |% {$_.FullName} | Get-VHD –ErrorAction SilentlyContinue

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft