Set-ClusterStorageSpacesDirectDisk

  • Reference
Module:
FailoverClusters

Configures the system to enable S2D to claim or not claim specific physical disks.

Syntax

Set-ClusterStorageSpacesDirectDisk
   [-CanBeClaimed <Boolean>]
   [-PhysicalDiskIds <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-ClusterStorageSpacesDirectDisk cmdlet configures the system to enable Storage Spaces Direct (S2D) to claim or not claim specific physical disks. Disks marked to be not claimed by S2D remain untouched so that they can be used for other purposes.

To avoid possible clean up and warnings, we recommend that you run this cmdlet before you enable S2D. Alternatively, you can run this cmdlet after you enable S2D.

Examples

Example 1: Configure disks not to be claimed

PS C:\> Set-ClusterStorageSpacesDirectDisk -CimSession "K0619-C1.contoso.com" -CanBeClaimed:$False -PhysicalDiskIds "55CD2E404B75A3FC","50014EE05950DD7C"

This command configures the system that physical disks that have the IDs 55CD2E404B75A3FC and 50014EE05950DD7C cannot be claimed by S2D. In this example, the CanBeClaimed parameter is explicitly specified as $False. Omitting that parameter indicates that the specified physical disks can be claimed.

Parameters

-AsJob

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.

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

-CanBeClaimed

Indicates that S2D can claim the physical disks specified by the PhysicalDiskIds parameter. If you do not specify this parameter, this cmdlet indicates that the specified physical disks can be claimed.

Type:Boolean
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

-PhysicalDiskIds

Specifies an array of unique IDs of physical disks. This cmdlet set S2D to claim or not claim the specified disks.

Type:String[]
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

-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