Set-StoragePool
Modifies the properties of the specified storage pool.
Syntax
Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-ClearOnDeallocate <Boolean>]
[-IsPowerProtected <Boolean>]
[-NewFriendlyName <String>]
[-OtherUsageDescription <String>]
[-RetireMissingPhysicalDisks <RetireMissingPhysicalDisks>]
[-ThinProvisioningAlertThresholds <UInt16[]>]
[-ThrottleLimit <Int32>]
[-Usage <Usage>]
-UniqueId <String> Set-StoragePool
[-InputObject] <CimInstance[]>
[-AsJob]
[-CimSession <CimSession[]>]
[-IsReadOnly <Boolean>]
[-ThrottleLimit <Int32>] Set-StoragePool
[-FriendlyName] <String>
[-AsJob]
[-CimSession <CimSession[]>]
[-EnclosureAwareDefault <Boolean>]
[-ProvisioningTypeDefault <ProvisioningType>]
[-ResiliencySettingNameDefault <String>]
[-ThrottleLimit <Int32>] Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-EnclosureAwareDefault <Boolean>]
[-ProvisioningTypeDefault <ProvisioningType>]
[-ResiliencySettingNameDefault <String>]
[-ThrottleLimit <Int32>]
-Name <String> Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-ClearOnDeallocate <Boolean>]
[-IsPowerProtected <Boolean>]
[-NewFriendlyName <String>]
[-OtherUsageDescription <String>]
[-RetireMissingPhysicalDisks <RetireMissingPhysicalDisks>]
[-ThinProvisioningAlertThresholds <UInt16[]>]
[-ThrottleLimit <Int32>]
[-Usage <Usage>]
-Name <String> Set-StoragePool
[-FriendlyName] <String>
[-AsJob]
[-CimSession <CimSession[]>]
[-IsReadOnly <Boolean>]
[-ThrottleLimit <Int32>] Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-IsReadOnly <Boolean>]
[-ThrottleLimit <Int32>]
-Name <String> Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-IsReadOnly <Boolean>]
[-ThrottleLimit <Int32>]
-UniqueId <String> Set-StoragePool
[-InputObject] <CimInstance[]>
[-AsJob]
[-CimSession <CimSession[]>]
[-ClearOnDeallocate <Boolean>]
[-IsPowerProtected <Boolean>]
[-NewFriendlyName <String>]
[-OtherUsageDescription <String>]
[-RetireMissingPhysicalDisks <RetireMissingPhysicalDisks>]
[-ThinProvisioningAlertThresholds <UInt16[]>]
[-ThrottleLimit <Int32>]
[-Usage <Usage>] Set-StoragePool
[-AsJob]
[-CimSession <CimSession[]>]
[-EnclosureAwareDefault <Boolean>]
[-ProvisioningTypeDefault <ProvisioningType>]
[-ResiliencySettingNameDefault <String>]
[-ThrottleLimit <Int32>]
-UniqueId <String> Set-StoragePool
[-InputObject] <CimInstance[]>
[-AsJob]
[-CimSession <CimSession[]>]
[-EnclosureAwareDefault <Boolean>]
[-ProvisioningTypeDefault <ProvisioningType>]
[-ResiliencySettingNameDefault <String>]
[-ThrottleLimit <Int32>] Set-StoragePool
[-FriendlyName] <String>
[-AsJob]
[-CimSession <CimSession[]>]
[-ClearOnDeallocate <Boolean>]
[-IsPowerProtected <Boolean>]
[-NewFriendlyName <String>]
[-OtherUsageDescription <String>]
[-RetireMissingPhysicalDisks <RetireMissingPhysicalDisks>]
[-ThinProvisioningAlertThresholds <UInt16[]>]
[-ThrottleLimit <Int32>]
[-Usage <Usage>] Description
The Set-StoragePool cmdlet modifies the properties of the specified storage pool.
Examples
Example 1: Change the friendly name
PS C:\>Set-StoragePool -FriendlyName StoragePool -NewFriendlyName StoragePool2This 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 $FalseThis 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 ThinThis example makes any new virtual disks by default use the Mirror resiliency setting and thin provisioning.
Parameters
-AsJob
ps_cimcommon_asjob
| 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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 |
-ClearOnDeallocate
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnclosureAwareDefault
Specifies that the storage enclosure used by the storage pool supports SCSI Enclosure Services.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FriendlyName
Specifies the friendly name of the storage pool on which you want to set attributes.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Accepts an object from the pipeline as input.
| Type: | CimInstance[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsPowerProtected
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsReadOnly
Sets the object to be read-only (IsReadOnly $true) or read-write (IsReadOnly $false).
Note: If the object is set to read-only (IsReadOnly $true), the object must be set to read-write (IsReadOnly $false) before using this cmdlet to set the PartitionStyle parameter.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the storage pool on which you want to set attributes.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NewFriendlyName
Specifies the new friendly name for the storage pool.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OtherUsageDescription
Specifies the OtherUsageDescription for the storage pool.
| Type: | String |
| Aliases: | NewOtherUsageDescription |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningTypeDefault
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.
| Type: | ProvisioningType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResiliencySettingNameDefault
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 Storage Spaces subsystem are Mirror, Parity, and Simple.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetireMissingPhysicalDisks
Specifies that Windows should set the Usage property of physical disks missing from a storage pool to Retired.
| Type: | RetireMissingPhysicalDisks |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThinProvisioningAlertThresholds
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.
| Type: | UInt16[] |
| Position: | Named |
| Default value: | 70 |
| 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 |
-UniqueId
Specifies the UniqueID of the storage pool for which you want to set attributes.
| Type: | String |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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.
| Type: | Usage |
| Aliases: | NewUsage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
You can pipe one or more MSFT_StoragePool objects to the InputObject parameter.
Outputs
None
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for