< Back

Remove-VirtualDisk

Wed Jan 30, 2019 6:03 pm

NAME Remove-VirtualDisk



SYNOPSIS

Deletes an existing virtual disk and reclaims the used space for use by other virtual disks in the same storage pool.





SYNTAX

Remove-VirtualDisk [-FriendlyName] <String[]> [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-VirtualDisk [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -UniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-VirtualDisk [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-VirtualDisk [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-VirtualDisk cmdlet deletes an existing virtual disk and reclaims the used space for use by other virtual disks in the same StoragePool

object. This action also deletes any associated file system located on the virtual disk.





PARAMETERS

-CimSession [<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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FriendlyName <String[]>

Specifies a friendly name for a virtual disk. The friendly name may be defined by a user and is not guaranteed to be unique.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String[]>

Specifies the name of an object or setting.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.





To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is

entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the

computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-UniqueId <String[]>

Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

http://msdn.microsoft.com/library/windo ... 30584.aspx





The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The

path after the pound sign (#) provides the namespace and class name for the underlying WMI object.





OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

http://msdn.microsoft.com/library/windo ... 30584.aspx





The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The

path after the pound sign (#) provides the namespace and class name for the underlying WMI object.





EXAMPLE 1



PS C:\\>Remove-VirtualDisk -FriendlyName "Scratch-Data01"



This example permanently deletes a VirtualDisk object and all child items, such as the Disk, Partition, and Volume objects. Not a recoverable action.

This cmdlet is used to delete the VirtualDisk object, and return the space it used to the storage pool that exposes the VirtualDisk object.









RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816465

Connect-VirtualDisk

Disconnect-VirtualDisk

Get-VirtualDisk

Hide-VirtualDisk

New-VirtualDisk

Repair-VirtualDisk

Resize-VirtualDisk

Set-VirtualDisk

Show-VirtualDisk