Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-VMHardDiskDrive

Last Updated: 3/8/2017

SYNOPSIS

Gets the virtual hard disk drives attached to one or more virtual machines.

SYNTAX

VMName (Default)

Get-VMHardDiskDrive [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>]
 [-VMName] <String[]> [-ControllerLocation <Int32>] [-ControllerNumber <Int32>]
 [-ControllerType <ControllerType>] [<CommonParameters>]

VMObject

Get-VMHardDiskDrive [-VM] <VirtualMachine[]> [-ControllerLocation <Int32>] [-ControllerNumber <Int32>]
 [-ControllerType <ControllerType>] [<CommonParameters>]

VMSnapshot

Get-VMHardDiskDrive [-VMSnapshot] <VMSnapshot> [-ControllerLocation <Int32>] [-ControllerNumber <Int32>]
 [-ControllerType <ControllerType>] [<CommonParameters>]

VMDriveController

Get-VMHardDiskDrive [-ControllerLocation <Int32>] [-VMDriveController] <VMDriveController[]>
 [<CommonParameters>]

DESCRIPTION

The Get-VMHardDiskDrive cmdlet gets the virtual hard disk drives attached to one or more virtual machines.

EXAMPLES

Example 1

PS C:\> Get-VMHardDiskDrive -VMName TestVM

Gets the virtual hard drives from virtual machine TestVM.

Example 2

PS C:\> Get-VM -Name TestVM | Get-VMHardDiskDrive -ControllerType IDE -ControllerNumber 1

Gets the virtual hard drives from IDE controller 1 of virtual machine TestVM.

Example 3

PS C:\> Get-VMIdeController -VMName TestVM -ControllerNumber 1 -ComputerName Development | Get-VMHardDiskDrive

Gets the virtual hard drives from IDE controller 1 of virtual machine TestVM located on Hyper-V host Development.

Example 4

PS C:\> Get-VMSnapshot -VMName Test -Name 'Before applying updates' | Get-VMHardDrive

Gets the virtual hard drives from snapshot Before applying updates of virtual machine TestVM.

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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies one or more Hyper-V hosts from which the virtual hard disk drives are 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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ControllerLocation

Specifies the number of the location on the controller at which the virtual hard disk drives are to be retrieved. If not specified, the number of the first available location on the controller is used.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ControllerNumber

Specifies the number of the controller at which the virtual hard disk drives are to be retrieved. If not specified, the first controller on which the specified ControllerLocation is available is used.

Type: Int32
Parameter Sets: VMName, VMObject, VMSnapshot
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ControllerType

Specifies the type of the controller from which the virtual hard disk drives are to be retrieved. Allowed values are Floppy, IDE, and SCSI.

Type: ControllerType
Parameter Sets: VMName, VMObject, VMSnapshot
Aliases: 
Accepted values: IDE, SCSI

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: VMName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VM

Specifies the virtual machine from which the virtual hard disk drives are to be retrieved.

Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMDriveController

Specifies the drive controller from which the virtual hard disk drives are to be retreived.

Type: VMDriveController[]
Parameter Sets: VMDriveController
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMName

Specifies the name of the virtual machine from which the virtual hard disks drives are to be retrieved.

Type: String[]
Parameter Sets: VMName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMSnapshot

Specifies the snapshot from which the virtual hard disk drives are to be retrieved.

Type: VMSnapshot
Parameter Sets: VMSnapshot
Aliases: VMCheckpoint

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.HyperV.PowerShell.ControllerType

Microsoft.HyperV.PowerShell.VMSnapshot

Microsoft.HyperV.PowerShell.VMDriveController[]

Microsoft.HyperV.PowerShell.VirtualMachine[]

OUTPUTS

Microsoft.HyperV.PowerShell.HardDiskDrive

NOTES

© 2017 Microsoft