Remove-IscsiVirtualDisk
Remove-IscsiVirtualDisk
Deletes a Virtual Disk object, without deleting the virtual hard disk (VHD) file.
Syntax
Parameter Set: DevicePath
Remove-IscsiVirtualDisk [-Path] <String> [ <CommonParameters>]
Parameter Set: __AllParameterSets
Remove-IscsiVirtualDisk [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: InputObject
Remove-IscsiVirtualDisk -InputObject <IscsiVirtualDisk> [ <CommonParameters>]
Detailed Description
The Remove-IscsiVirtualDisk cmdlet deletes the iSCSI Virtual Disk object. The virtual hard disk (VHD) file is not deleted.
Parameters
-ComputerName<String>
Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer.
Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials when connecting to a remote computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IscsiVirtualDisk>
Accepts an iSCSI virtual disk object from the input pipeline.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path of the VHD file that is associated with the iSCSI virtual disk.
Filter the iSCSI Virtual Disk object using this parameter.
Aliases |
DevicePath |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (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 (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.
- Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example deletes a virtual disk with the path E:\temp\vhd1.vhd.
PS C:\> Remove-IscsiVirtualDisk –Path "E:\temp\vhd1.vhd"