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
Enable-ClusterStorageSpacesDirect
This command enables S2D on the cluster.
Example 2: Enable Storage Spaces Direct specifying a Friendly Name
This command enables S2D on the cluster and sets a friendly name for the Storage Spaces Direct pool.
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.
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
-Autoconfig
Indicates that this cmdlet that the pool should be automatically created and configured. When a pool
already exists before Storage Spaces Direct is enabled the AutoConfig parameter becomes a no-op.
AutoConfig is set to true by default. If you don't want the pool to be automatically created,
but created manually, you should set AutoConfig to false.
Parameter properties
Type:
Boolean
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
-CacheDeviceModel
Specifies a list of disk models that should be used by Storage Spaces Direct cache. When this
parameter is omitted the system automatically determines which disks to use for the operation.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
WithCacheDeviceModel
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CacheMetadataReserveBytes
The Enable-ClusterStorageSpacesDirect cmdlet enables highly available Storage Spaces that use
directly attached storage Storage Spaces Direct (S2D) on a cluster.
Parameter properties
Type:
UInt64
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
-CachePageSizeKBytes
Specifies the page size used by Storage Spaces Direct 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.
Parameter properties
Type:
UInt32
Default value:
None
Accepted values:
8, 16, 32, 64
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
-CacheState
Specifies the Storage Spaces Direct cache state. The acceptable values for this parameter are:
Enabled or Disabled. The default value is Enabled.
Parameter properties
Type:
CacheStateType
Default value:
None
Accepted values:
Disabled, Enabled
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
-PoolFriendlyName
Specifies the friendly name of the Storage Spaces Direct pool when it is created.
Parameter properties
Type:
String
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
-SkipEligibilityChecks
Indicates that this cmdlet skips cache eligibility checks.
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
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't 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
-XML
Specifies the XML file that contains the storage supported configuration information.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
WithXML
Position:
Named
Mandatory:
True
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.