Edit

Share via


Get-VMHardDiskDrive

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

Syntax

VMName (Default)

Get-VMHardDiskDrive
    [-VMName] <String[]>
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-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
    [-VMDriveController] <VMDriveController[]>
    [-ControllerLocation <Int32>]
    [<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-VMHardDiskDrive

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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMSnapshot
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:ControllerType
Default value:None
Accepted values:IDE, SCSI
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMSnapshot
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VM

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

Parameter properties

Type:

VirtualMachine[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMDriveController

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

Parameter properties

Type:

VMDriveController[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMDriveController
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSnapshot

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

Parameter properties

Type:VMSnapshot
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VMCheckpoint

Parameter sets

VMSnapshot
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -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