Remove-VMHardDiskDrive
Remove-VMHardDiskDrive
Deletes a hard disk drive from a virtual machine.
Syntax
Parameter Set: VMName
Remove-VMHardDiskDrive [-VMName] <String> [-ControllerType] <ControllerType> [-ControllerNumber] <Int32> [-ControllerLocation] <Int32> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMHardDiskDrive
Remove-VMHardDiskDrive [-VMHardDiskDrive] <HardDiskDrive[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-VMHardDiskDrive cmdlet deletes a hard disk drive from a virtual machine.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts from which the virtual hard disk drive is to be deleted. 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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Specifies that an object is to be passed through to be pipeline representing the virtual hard disk drive to be deleted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHardDiskDrive<HardDiskDrive[]>
Specifies the virtual hard disk drive to be deleted.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ControllerLocation<Int32>
Specifies the number of the location on the controller at which the virtual hard disk drive is to be deleted. If not specified, the number of the first available location on the controller is used.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ControllerNumber<Int32>
Specifies the number of the controller from which the virtual hard disk drive is to be deleted. If not specified, the first controller on which the specified ControllerLocation is available is used.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ControllerType<ControllerType>
Specifies the type of the controller where the virtual hard disk is to be deleted. Allowed values are IDE and SCSI.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMName<String>
Specifies the name of the virtual machine from which the virtual hard disk is to be deleted.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
- None by default; Microsoft.Virtualization.Powershell.DriveController if –PassThru is specified.
Examples
Example 1
Removes the virtual hard drive at IDE 1,0 on virtual machine TestVM.
PS C:\> Remove-VMHardDiskDrive -VMName TestVM –ControllerType IDE -ControllerNumber 1 -ControllerLocation 0
Example 2
Removes all virtual hard drives on IDE controller 1 from virtual machine TestVM.
PS C:\> Get-VMHardDiskDrive -VMName TestVM –ControllerType IDE -ControllerNumber 1 | Remove-VMHardDiskDrive