< Back

Set-StoragePool

Wed Jan 30, 2019 6:04 pm

NAME Set-StoragePool



SYNOPSIS

Modifies the properties of the specified storage pool.





SYNTAX

Set-StoragePool [-CimSession <CimSession[]>] [-ClearOnDeallocate <Boolean>] [-IsPowerProtected <Boolean>] [-NewFriendlyName <String>]

[-OtherUsageDescription <String>] [-RepairPolicy {Sequential | Parallel}] [-RetireMissingPhysicalDisks {Auto | Always | Never}]

[-ThinProvisioningAlertThresholds <UInt16[]>] [-ThrottleLimit <Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem |

ReservedAsDeltaReplicaContainer | ReservedForMigrationServices | ReservedForLocalReplicationServices | ReservedForRemoteReplicationServices |

ReservedForSparing}] -UniqueId <String> [<CommonParameters>]



Set-StoragePool [-FriendlyName] <String> [-AutoWriteCacheSize <Boolean>] [-CimSession <CimSession[]>] [-EnclosureAwareDefault <Boolean>]

[-FaultDomainAwarenessDefault {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack}] [-MediaTypeDefault {Unspecified | HDD

| SSD | SCM}] [-ProvisioningTypeDefault {Unknown | Thin | Fixed}] [-ResiliencySettingNameDefault <String>] [-ThrottleLimit <Int32>]

[-WriteCacheSizeDefault <UInt64>] [<CommonParameters>]



Set-StoragePool [-AutoWriteCacheSize <Boolean>] [-CimSession <CimSession[]>] [-EnclosureAwareDefault <Boolean>] [-FaultDomainAwarenessDefault

{PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack}] [-MediaTypeDefault {Unspecified | HDD | SSD | SCM}]

[-ProvisioningTypeDefault {Unknown | Thin | Fixed}] [-ResiliencySettingNameDefault <String>] [-ThrottleLimit <Int32>] [-WriteCacheSizeDefault <UInt64>]

-UniqueId <String> [<CommonParameters>]



Set-StoragePool [-AutoWriteCacheSize <Boolean>] [-CimSession <CimSession[]>] [-EnclosureAwareDefault <Boolean>] [-FaultDomainAwarenessDefault

{PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack}] [-MediaTypeDefault {Unspecified | HDD | SSD | SCM}]

[-ProvisioningTypeDefault {Unknown | Thin | Fixed}] [-ResiliencySettingNameDefault <String>] [-ThrottleLimit <Int32>] [-WriteCacheSizeDefault <UInt64>]

[<CommonParameters>]



Set-StoragePool [-AutoWriteCacheSize <Boolean>] [-CimSession <CimSession[]>] [-EnclosureAwareDefault <Boolean>] [-FaultDomainAwarenessDefault

{PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack}] [-MediaTypeDefault {Unspecified | HDD | SSD | SCM}]

[-ProvisioningTypeDefault {Unknown | Thin | Fixed}] [-ResiliencySettingNameDefault <String>] [-ThrottleLimit <Int32>] [-WriteCacheSizeDefault <UInt64>]

-Name <String> [<CommonParameters>]



Set-StoragePool [-CimSession <CimSession[]>] [-IsReadOnly <Boolean>] [-ThrottleLimit <Int32>] [<CommonParameters>]



Set-StoragePool [-CimSession <CimSession[]>] [-ClearOnDeallocate <Boolean>] [-IsPowerProtected <Boolean>] [-NewFriendlyName <String>]

[-OtherUsageDescription <String>] [-RepairPolicy {Sequential | Parallel}] [-RetireMissingPhysicalDisks {Auto | Always | Never}]

[-ThinProvisioningAlertThresholds <UInt16[]>] [-ThrottleLimit <Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem |

ReservedAsDeltaReplicaContainer | ReservedForMigrationServices | ReservedForLocalReplicationServices | ReservedForRemoteReplicationServices |

ReservedForSparing}] -Name <String> [<CommonParameters>]



Set-StoragePool [-FriendlyName] <String> [-CimSession <CimSession[]>] [-IsReadOnly <Boolean>] [-ThrottleLimit <Int32>] [<CommonParameters>]



Set-StoragePool [-CimSession <CimSession[]>] [-IsReadOnly <Boolean>] [-ThrottleLimit <Int32>] -Name <String> [<CommonParameters>]



Set-StoragePool [-CimSession <CimSession[]>] [-IsReadOnly <Boolean>] [-ThrottleLimit <Int32>] -UniqueId <String> [<CommonParameters>]



Set-StoragePool [-FriendlyName] <String> [-CimSession <CimSession[]>] [-ClearOnDeallocate <Boolean>] [-IsPowerProtected <Boolean>] [-NewFriendlyName

<String>] [-OtherUsageDescription <String>] [-RepairPolicy {Sequential | Parallel}] [-RetireMissingPhysicalDisks {Auto | Always | Never}]

[-ThinProvisioningAlertThresholds <UInt16[]>] [-ThrottleLimit <Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem |

ReservedAsDeltaReplicaContainer | ReservedForMigrationServices | ReservedForLocalReplicationServices | ReservedForRemoteReplicationServices |

ReservedForSparing}] [<CommonParameters>]



Set-StoragePool [-CimSession <CimSession[]>] [-ClearOnDeallocate <Boolean>] [-IsPowerProtected <Boolean>] [-NewFriendlyName <String>]

[-OtherUsageDescription <String>] [-RepairPolicy {Sequential | Parallel}] [-RetireMissingPhysicalDisks {Auto | Always | Never}]

[-ThinProvisioningAlertThresholds <UInt16[]>] [-ThrottleLimit <Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem |

ReservedAsDeltaReplicaContainer | ReservedForMigrationServices | ReservedForLocalReplicationServices | ReservedForRemoteReplicationServices |

ReservedForSparing}] [<CommonParameters>]





DESCRIPTION

The Set-StoragePool cmdlet modifies the properties of the specified storage pool.





PARAMETERS

-AutoWriteCacheSize [<Boolean>]

Indicates whether to set the size of the write-back cache to 1 GB for all types of storage spaces, which include simple, mirror, and parity, to

create from the pool. If the number or size of the solid-state drives (SSDs) or journal disks in the storage pool is not sufficient and you specify

a value of $True for this parameter, the cmdlet sets the write-back cache size to 0 for simple and mirror spaces, and to 32 MB for parity spaces.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-CimSession [<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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ClearOnDeallocate [<Boolean>]

Clears all blocks on the physical disks in the storage pool upon deallocation. Clearing all blocks is more secure, but is much slower to deallocate.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-EnclosureAwareDefault [<Boolean>]

Specifies that the storage pool should use enclosure awareness by default when creating storage spaces.



To support deployments that require an added level of fault tolerance, Storage Spaces can associate each copy of data with a particular

just-a-bunch-of-disk (JBOD) enclosure. This capability is known as enclosure awareness. With enclosure awareness, if one enclosure fails or goes

offline, the data remains available in one or more alternate enclosures.



To use enclosure awareness, you must use JBODs that are certified for use with Storage Spaces and you must have a sufficient number of JBODs and

disks to support the resiliency types of the storage spaces you create (generally you????????ll need three or four JBODs). For a list of certified JBODs,

see the Windows Server Catalog. For more information about enclosure awareness, see Software-Defined Storage Design Considerations Guide.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FaultDomainAwarenessDefault [<FaultDomainType>]

Specifies the default fault domain for new virtual disks created in this storage pool. The acceptable values for this parameter are:



-- PhysicalDisk

-- StorageScaleUnit

-- StorageChassis

-- StorageEnclosure

-- StorageRack



The fault domain specifies at what level you want to be fault tolerant. For example, specify StorageScaleUnit to store data copies on separate nodes

of a Storage Spaces Direct cluster. This cmdlet refers to nodes of a Storage Spaces Direct cluster as storage scale units because you can expand the

scale of the cluster by adding more nodes.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FriendlyName <String>

Specifies the friendly name of the storage pool on which you want to set attributes.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IsPowerProtected [<Boolean>]

Indicates whether the physical disks that belong to the storage pool have backup power systems, such as battery backup. If you specify a value of

$True for this parameter, the storage pool does not perform flush operations, and the pool removes write-through attributes from commands.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-IsReadOnly [<Boolean>]

Sets the object to be read-only (IsReadOnly $true$true) or read-write (IsReadOnly $false$false). Note: If the object is set to read-only (IsReadOnly

$true$true), the object must be set to read-write (IsReadOnly $false$false) before using this cmdlet to set the PartitionStyle parameter.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-MediaTypeDefault [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SetStoragePool.MediaType>]

Specifies the default media type to use during virtual disk creation. The acceptable values for this parameter are: HDD, SSD, and Unspecified.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Specifies the name of the storage pool on which you want to set attributes.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-NewFriendlyName [<String>]

Specifies the new friendly name for the storage pool.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-OtherUsageDescription [<String>]

Specifies the OtherUsageDescription for the storage pool.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ProvisioningTypeDefault [<ProvisioningType>]

Specifies the default type of provisioning to use for virtual disks created in the specified storage pool. The acceptable values for this parameter

are: Fixed or Thin.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-RepairPolicy [<RepairPolicy>]

Specifies how the operating system proceeds with repairing virtual disks in the specified storage pool. The acceptable values for this parameter are:

--Sequential Repair processes one allocation slab at a time. Specifying this value results in longer repair times, but smaller impact on I/O load.

--Parallel Repair processes as many allocation slabs as it can in parallel. Specifying this value results in the shortest repair time, but

significantly impacts I/O load.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ResiliencySettingNameDefault [<String>]

Specifies the default resiliency setting (also known as storage layout) to use for virtual disks the created in the specified storage pool. The

supported resiliency settings vary by storage subsystem. Acceptable values for the Windows Storage subsystem are Mirror, Parity, and Simple.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-RetireMissingPhysicalDisks [<RetireMissingPhysicalDisks>]

Specifies when Windows should set the Usage property of physical disks missing from a storage pool to Retired. The acceptable values for this

parameter are:

????????Auto This is the default setting for storage pools. When set to Auto, Windows retires missing disks, but doesn????????t automatically rebuild affected

virtual disks unless there are physical disks whose Usage value is set to HotSpare, in which case Windows rebuilds the virtual disks five minutes

after the failed write operation.

????????Always This is the recommended setting when using free pool space to rebuild storage spaces instead of using hot-spare disks. When set to Always,

Windows retires missing physical disks and automatically rebuilds affected virtual disks five minutes after the failed write operation.

????????Never When set to Never, Windows never retires missing physical disks.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ThinProvisioningAlertThresholds [<UInt16[]>]

Specifies how full a storage pool must get (in percent) before an alert is generated to add physical disks to the storage pool to support thinly

provisioned virtual disks.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-UniqueId <String>

Specifies the UniqueID of the storage pool for which you want to set attributes.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Usage [<Usage>]

Specifies the usage setting for the storage pool. The acceptable values for this parameter are:Other, ReservedAsDeltaReplicaContainer,

ReservedForComputerSystem, ReservedForLocalReplicationServices, ReservedForMigrationServices, ReservedForRemoteReplicationServices,

ReservedForSparing, and Unrestricted.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-WriteCacheSizeDefault [<UInt64>]

Specifies the default write-back cache size for virtual disks in the storage pool.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool

http://msdn.microsoft.com/library/windo ... 30551.aspx





You can use the pipeline operator to pass one or more MSFT_StoragePool objects to the InputObject parameter.





OUTPUTS

None







Example 1: Change the friendly name



PS C:\\>Set-StoragePool -FriendlyName StoragePool -NewFriendlyName StoragePool2



This example changes the friendly name of StoragePool to StoragePool2.





Example 2: Make a read-only storage pool writeable



PS C:\\>Set-StoragePool -FriendlyName "Storage Pool 1" -IsReadOnly $False



This example makes the storage pool named Storage Pool 1 writable when it is in a read-only state.





Example 3: Set the default resiliency and provisioning settings



PS C:\\>Set-StoragePool -FriendlyName "Storage Pool 1" -ResiliencySettingsNameDefault Mirror -ProvisioningTypeDefault Thin



This example makes any new virtual disks by default use the Mirror resiliency setting and thin provisioning.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816487

Get-StoragePool

New-StoragePool

Remove-StoragePool