A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.microsoft.com/en-us/powershell/module/storage/clear-disk below:

Clear-Disk (Storage) | Microsoft Learn

Clear-Disk

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

Syntax ByNumber (Default)
Clear-Disk
    [-Number] <UInt32[]>
    [-RemoveData]
    [-RemoveOEM]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
ByUniqueId
Clear-Disk
    -UniqueId <String[]>
    [-RemoveData]
    [-RemoveOEM]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
ByName
Clear-Disk
    [-FriendlyName <String[]>]
    [-RemoveData]
    [-RemoveOEM]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
ByPath
Clear-Disk
    -Path <String[]>
    [-RemoveData]
    [-RemoveOEM]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
InputObject (cdxml)
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.

Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.

Parameter properties Type:

CimSession[]

Default value: None Supports wildcards: False DontShow: False Aliases: Session Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties Type: SwitchParameter Default value: False Supports wildcards: False DontShow: False Aliases: cf Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -FriendlyName

Specifies a friendly name of the disk to clear.

Parameter properties Type:

String[]

Default value: None Supports wildcards: False DontShow: False Parameter sets ByName Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False -InputObject

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

Parameter properties Type:

CimInstance[]

Default value: None Supports wildcards: False DontShow: False Parameter sets InputObject (cdxml) Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: 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.

Parameter properties Type:

UInt32[]

Default value: None Supports wildcards: False DontShow: False Parameter sets ByNumber Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False -PassThru

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

Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -Path

Specifies the path of the disk to clear.

Parameter properties Type:

String[]

Default value: None Supports wildcards: False DontShow: False Parameter sets ByPath Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False -RemoveData

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

Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveOEM

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

Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.

Parameter properties Type: Int32 Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -UniqueId

Specifies the UniqueID of the disk to clear.

Parameter properties Type:

String[]

Default value: None Supports wildcards: False DontShow: False Aliases: Id Parameter sets ByUniqueId Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False -WhatIf

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

Parameter properties Type: SwitchParameter Default value: False Supports wildcards: False DontShow: False Aliases: wi Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4