Initialize-Disk
Initializes a RAW disk for first time use, enabling the disk to be formatted and used to store data.
Syntax
Initialize-Disk
[-Number] <UInt32[]>
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Initialize-Disk
-UniqueId <String[]>
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Initialize-Disk
[-FriendlyName <String[]>]
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Initialize-Disk
-Path <String[]>
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Initialize-Disk
[-VirtualDisk <CimInstance>]
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Initialize-Disk
-InputObject <CimInstance[]>
[-PartitionStyle <PartitionStyle>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Initialize-Disk cmdlet initializes a Disk object with the RAW partition style to either the MBR or GPT partition styles. The default partition style is GPT. Disks must be initialized before they can be formatted and used to store data.
Examples
Example 1: Initialize a disk using default values
PS C:\>Initialize-Disk -Number 1
This example initializes the first disk in the computer (disk number 1), using the default values, which initializes the disk using the GPT partition style.
Example 2: Initialize a disk using the MBR partition style
PS C:\> Initialize-Disk -Number 1 -PartitionStyle MBR
This example initializes a disk using the MBR partition style.
Example 3: Initialize a virtual disk
PS C:\>Initialize-Disk -VirtualDisk (Get-VirtualDisk -FriendlyName UserData)
This example uses the VirtualDisk parameter with the Get-VirtualDisk cmdlet to get a virtual disk with the friendly name UserData, and initialize the Disk object associated with the virtual disk.
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 the friendly name of the disk to initialize.
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 to initialize.
Type: | UInt32[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PartitionStyle
Specifies the type of the partition.
The acceptable values for this parameter are: MBR or GPT.
The disk must be set to read-write (IsReadOnly $false
) before this cmdlet will work.
Type: | PartitionStyle |
Accepted values: | Unknown, MBR, GPT |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.
To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.
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 initialize.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 initialize
Type: | String[] |
Aliases: | Id |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VirtualDisk
Specifies the VirtualDisk object for which you want to initialize the associated Disk object. The Virtual Disk CIM object is exposed by the Get-VirtualDisk cmdlet.
Type: | CimInstance |
Position: | Named |
Default value: | None |
Required: | False |
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
You can pipe an MSFT_VirtualDisk object to the VirtualDisk parameter.
You can pipe an MSFT_Disk object to the InputObject parameter.
Outputs
If you specify the Passthru parameter, this cmdlet returns an object representing the newly initialized disk.
Notes
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).