Redigera

Dela via

Clear-Disk

  • Reference
Module:
Storage

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

Syntax

Clear-Disk
     [-Number] <UInt32[]>
     [-RemoveData]
     [-RemoveOEM]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-Disk
     -UniqueId <String[]>
     [-RemoveData]
     [-RemoveOEM]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-Disk
     [-FriendlyName <String[]>]
     [-RemoveData]
     [-RemoveOEM]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-Disk
     -Path <String[]>
     [-RemoveData]
     [-RemoveOEM]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-Disk
     -InputObject <CimInstance[]>
     [-RemoveData]
     [-RemoveOEM]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

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 RemoveOEM parameter is also specified.

Examples

Example 1: 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.

Example 2: 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.

Example 3: 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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Specifies a friendly name of the disk to clear.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Number

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.

Type:UInt32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies the path of the disk to clear.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RemoveData

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveOEM

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UniqueId

Specifies the UniqueID of the disk to clear.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

You can pipe a Disk object to the InputObject parameter.

Outputs

CimInstance

When you specify the Passthru parameter, this cmdlet outputs an object representing the disk that you cleared.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).