Get-VHD
Gets the virtual hard disk object associated with a virtual hard disk.
Syntax
Get-VHD
[-Path] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]Get-VHD
[-DiskNumber] <UInt32>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]Get-VHD
[-VMId] <Guid[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]Description
The Get-VHD cmdlet gets the virtual hard disk object associated with a virtual hard disk.
Note
When the VHD is in use (for example by a VM or mounted in the OS) and it is on shared storage, the Get-VHD cmdlet can only access it from the host that is using it. Any other server trying to run the Get-VHD cmdlet will get an error that it is in use.
Examples
Example 1
PS C:\> Get-VHD -Path C:\test\testvhdx.vhdxGets the virtual hard disk where the path to the virtual hard disk file is C:\test\testvhdx.vhdx.
Example 2
PS C:\> Get-VHD -DiskNumber 6Gets the virtual hard disk attached to the system with disk number 6.
Example 3
PS C:\> Get-VM -VMName TestVM | Select-Object -Property VMId | Get-VHDGets the virtual hard disk objects associated with virtual machine TestVM, using the pipeline feature for the VMId parameter.
Example 4
PS C:\> Get-VM -VMName TestVM | Select-Object -Property VMId | Get-VHDGets the virtual hard disk objects associated with virtual machine TestVM using the pipeline feature for the path parameter.
Example 5
PS C:\> Get-ChildItem -Path C:\test -Recurse -Include *.vhd, *.vhdx, *.vhds, *.avhd, *.avhdx | Get-VHDGets the virtual hard disk object for all the virtual hard disk files that are contained in the specified directory and its subdirectories.
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
| Type: | PSCredential[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskNumber
Specifies the disk number associated with the virtual hard disk to be retrieved.
| Type: | UInt32 |
| Aliases: | Number |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
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.
| Type: | String[] |
| Aliases: | FullName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMId
Specifies the virtual machine identifier of the virtual machine whose virtual hard disks are to be retrieved.
| Type: | Guid[] |
| Aliases: | Id |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
Microsoft.Vhd.PowerShell.VirtualHardDisk