< Back
Clear-Disk
Post
NAME Clear-Disk
SYNOPSIS
Cleans a disk by removing all partition information and un-initializing it, erasing all data on the disk.
SYNTAX
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>]
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
-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 of the disk to clear.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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.
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.
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.
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.
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.
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 the UniqueID of the disk to clear.
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_Disk
http://msdn.microsoft.com/library/windo ... s.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/windo ... s.85).aspx
When you specify the Passthru parameter, this cmdlet outputs an object representing the disk that you cleared.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=809333
Format-Volume
Get-DiskStorageNodeView
Initialize-Disk
New-Partition
Set-Disk
Update-Disk
SYNOPSIS
Cleans a disk by removing all partition information and un-initializing it, erasing all data on the disk.
SYNTAX
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>]
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
-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 of the disk to clear.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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.
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.
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.
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.
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.
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 the UniqueID of the disk to clear.
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_Disk
http://msdn.microsoft.com/library/windo ... s.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/windo ... s.85).aspx
When you specify the Passthru parameter, this cmdlet outputs an object representing the disk that you cleared.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=809333
Format-Volume
Get-DiskStorageNodeView
Initialize-Disk
New-Partition
Set-Disk
Update-Disk