Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Clear-Disk

Clear-Disk

disk.cdxml

Synopsis

Cleans a disk by removing all partition information and un-initializing it, erasing all data on the disk.

Syntax

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

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

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

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

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

Detailed Description

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

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FriendlyName <String[]>

Specifies a friendly name of the disk to clear.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the disk object to clear. Enter a Disk CIM object, which you can get by using the Get-Disk cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Number <UInt32[]>

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.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String[]>

Specifies the path of the disk to clear.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RemoveData <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RemoveOEM <SwitchParameter>

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

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-UniqueId <String[]>

Specifies the UniqueID of the disk to clear.

Aliases

Id

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.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

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

Return Type

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

Notes

None

Examples

Example 1: Clear a blank disk

This example clears disk number one only if it does not contain both data or OEM partitions.

PS C:\> Clear-Disk -Number 1

Example 2: Clear a disk with data partitions

This example clears the disk if it has data partitions, but not if it also has OEM partitions.

PS C:\> Clear-Disk -Number 1 –RemoveData

Clear a disk with data and OEM partitions

This example clears the disk regardless of whether it contains data or OEM partitions.

PS C:\> Clear-Disk -Number 1 -RemoveData –RemoveOEM

Online Version
Format-Volume
Get-Disk
Initialize-Disk
New-Partiton
Set-Disk
Update-Disk