Clear-Disk

Clear-Disk [-Number*] <UInt32[]> [-CimSession <CimSession[]>] [-PassThru] [-RemoveData] [-RemoveOEM][-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]

Clear-Disk [-CimSession <CimSession[]>] [-FriendlyName <String[]>] [-PassThru] [-RemoveData] [-RemoveOEM][-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]

Clear-Disk [-CimSession <CimSession[]>] [-PassThru] [-RemoveData] [-RemoveOEM] [-ThrottleLimit <Int32>] -Path*<String[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Clear-Disk [-CimSession <CimSession[]>] [-PassThru] [-RemoveData] [-RemoveOEM] [-ThrottleLimit <Int32>] -UniqueId*<String[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Clear-Disk [-CimSession <CimSession[]>] [-PassThru] [-RemoveData] [-RemoveOEM] [-ThrottleLimit <Int32>] [-Confirm][-WhatIf] [<CommonParameters>]

The Clear-Disk cmdlet clears the disk by removing the partition and volume information.

If the disk contains active data volumes, then the RemoveData parameter is required as this will delete all data from the specified disk. This cmdlet will not clear OEM recovery partitions unless ForceOEM parameter is also specified.

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.

-FriendlyName [<String[]>]

Accepts pipeline input ByPropertyName

Specifies a friendly name of the disk to clear.

-Number <UInt32[]>

This value is required
Accepts pipeline input ByPropertyName

Specifies the disk number of the disk on which to perform the clear operation. For a list of available disks, see the Get-Disk cmdlet.

-PassThru [<SwitchParameter>]

Specifies that the cmdlet should output an object representing a disk. By default, this cmdlet does not generate any output.

-Path <String[]>

This value is required
Accepts pipeline input ByPropertyName

Specifies the path of the disk to clear.

-RemoveData [<SwitchParameter>]

Enabes the removal of all of the data on the disk.

-RemoveOEM [<SwitchParameter>]

Enables the removal of any OEM recovery partitions from the disk.

-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 PowerShellr 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.

-UniqueId <String[]>

This value is required
Accepts pipeline input ByPropertyName

Specifies the UniqueID of the disk to clear.

-Confirm [<SwitchParameter>]

Default value is false

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

-WhatIf [<SwitchParameter>]

Default value is false

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.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

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

http://msdn.microsoft.com/library/windows/desktop/Hh830493(v=vs.85).aspx You can pipe a Disk object to the InputObject parameter.

Outputs

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

http://msdn.microsoft.com/library/windows/desktop/Hh830493(v=vs.85).aspx When you specify the Passthru parameter, this cmdlet outputs an object representing the disk that you cleared.

Examples

Clear a blank disk:
```
PS C:\>  Clear-Disk -Number 1
```
This example clears disk number one only if it does not contain both data or OEM partitions.
Clear a disk with data partitions:
```
PS C:\>  Clear-Disk -Number 1 -RemoveData
```
This example clears the disk if it has data partitions, but not if it also has OEM partitions.
Clear a disk with data and OEM partitions:
```
PS C:\>  Clear-Disk -Number 1 -RemoveData -RemoveOEM
```
This example clears the disk regardless of whether it contains data or OEM partitions.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands