Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Enable-ClusterStorageSpacesDirect

Brian Lich|Last Updated: 3/28/2017

SYNOPSIS

Enables S2D.

SYNTAX

Auto

Enable-ClusterStorageSpacesDirect [-PoolFriendlyName <String>] [-Autoconfig <Boolean>]
 [-CacheState <CacheStateType>] [-CacheMetadataReserveBytes <UInt64>] [-CachePageSizeKBytes <UInt32>]
 [-SkipEligibilityChecks] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
 [<CommonParameters>]

WithXML

Enable-ClusterStorageSpacesDirect [-PoolFriendlyName <String>] [-Autoconfig <Boolean>]
 [-CacheState <CacheStateType>] [-CacheMetadataReserveBytes <UInt64>] [-CachePageSizeKBytes <UInt32>]
 [-SkipEligibilityChecks] -XML <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [-WhatIf] [-Confirm] [<CommonParameters>]

WithCacheDeviceModel

Enable-ClusterStorageSpacesDirect [-PoolFriendlyName <String>] [-Autoconfig <Boolean>]
 [-CacheState <CacheStateType>] [-CacheMetadataReserveBytes <UInt64>] [-CachePageSizeKBytes <UInt32>]
 [-SkipEligibilityChecks] -CacheDeviceModel <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Enable-ClusterStorageSpacesDirect cmdlet enables highly available Storage Spaces that use directly attached storage Storage Spaces Direct (S2D) on a cluster.

EXAMPLES

Example 1: Enable Storage Spaces Direct

PS C:\> Enable-ClusterStorageSpacesDirect -Cluster "Contoso19-C2.production.contoso.com"

This command enables S2D on the cluster named Contoso19-C2.production.contoso.com.

Example 2: Enable Storage Spaces Direct by using the pipeline

PS C:\> Get-Cluster -Cluster "Contoso19-C2.production.contoso.com" | Enable-ClusterStorageSpacesDirect

This command gets the cluster named Contoso19-C2.production.contoso.com by using the Get-Cluster cmdlet. The command passes that cluster to the current cmdlet by using the pipeline operator. That cmdlet enables S2D on the cluster.

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
Parameter Sets: (All)
Aliases: 

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

-Autoconfig

Indicates that this cmdlet that the pool should be automatically created and configured. When a pool already exists before S2D is enabled the AutoConfig parameter becomes a no-op. AutoConfig is set to true by default. If you do not want the pool to be automatically created, but created manually, you should set AutoConfig to false.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-CacheDeviceModel

Specifies a list of disk models that should be used by S2D cache. When this parameter is omitted the system will automatically determine which disks to use for the operation.

Type: String[]
Parameter Sets: WithCacheDeviceModel
Aliases: 

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

-CacheMetadataReserveBytes

Type: UInt64
Parameter Sets: (All)
Aliases: 

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

-CachePageSizeKBytes

Specifies the page size used by S2D cache. This parameter is useful to control the memory footprint used to manage the pages. To reduce the memory overhead on systems with considerably large amounts of storage the page size can be increased to 32 kilobytes (KB) or even 64 KB. The default value is 16 KB, which represents a good tradeoff on most systems.

Type: UInt32
Parameter Sets: (All)
Aliases: 
Accepted values: 8, 16, 32, 64

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

-CacheState

Specifies the S2D cache state. The acceptable values for this parameter are: Enabled or Disabled. The default value is Enabled.

Type: CacheStateType
Parameter Sets: (All)
Aliases: 
Accepted values: Disabled, Enabled

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-PoolFriendlyName

Specifies the friendly name of the S2D pool when it is created.

Type: String
Parameter Sets: (All)
Aliases: 

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

-SkipEligibilityChecks

Indicates that this cmdlet skips cache eligibility checks.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-XML

Specifies the XML file that contains the storage supported configuration information.

Type: String
Parameter Sets: WithXML
Aliases: 

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Disable-ClusterStorageSpacesDirect

Get-ClusterStorageSpacesDirect

Set-ClusterStorageSpacesDirect

Get-Cluster

© 2017 Microsoft