Set-StorageTier

Set-StorageTier

Modifies a storage tier.

Syntax

Parameter Set: ByUniqueIdNewFriendlyName
Set-StorageTier -UniqueId <String> [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFriendlyNameAttributes
Set-StorageTier [-FriendlyName] <String> [-CimSession <CimSession[]> ] [-ColumnIsolation <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-FaultDomainAwareness <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-Interleave <UInt64> ] [-MediaType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.SetStorageTier.MediaType> {HDD | SSD | SCM} ] [-NumberOfColumns <UInt16> ] [-NumberOfDataCopies <UInt16> ] [-NumberOfGroups <UInt16> ] [-PhysicalDiskRedundancy <UInt16> ] [-ProvisioningType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType> {Thin | Fixed} ] [-ResiliencySettingName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFriendlyNameDescription
Set-StorageTier [-FriendlyName] <String> [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFriendlyNameNewFriendlyName
Set-StorageTier [-FriendlyName] <String> [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByObjectAttributes
Set-StorageTier [-CimSession <CimSession[]> ] [-ColumnIsolation <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-FaultDomainAwareness <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-Interleave <UInt64> ] [-MediaType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.SetStorageTier.MediaType> {HDD | SSD | SCM} ] [-NumberOfColumns <UInt16> ] [-NumberOfDataCopies <UInt16> ] [-NumberOfGroups <UInt16> ] [-PhysicalDiskRedundancy <UInt16> ] [-ProvisioningType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType> {Thin | Fixed} ] [-ResiliencySettingName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByObjectDescription
Set-StorageTier [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByObjectNewFriendlyName
Set-StorageTier [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByUniqueIdAttributes
Set-StorageTier -UniqueId <String> [-CimSession <CimSession[]> ] [-ColumnIsolation <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-FaultDomainAwareness <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-Interleave <UInt64> ] [-MediaType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.SetStorageTier.MediaType> {HDD | SSD | SCM} ] [-NumberOfColumns <UInt16> ] [-NumberOfDataCopies <UInt16> ] [-NumberOfGroups <UInt16> ] [-PhysicalDiskRedundancy <UInt16> ] [-ProvisioningType <Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType> {Thin | Fixed} ] [-ResiliencySettingName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByUniqueIdDescription
Set-StorageTier -UniqueId <String> [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]




Detailed Description

The Set-StorageTier cmdlet modifies a storage tier. Use this cmdlet to change the name and description of a storage tier, and to change the media type that is associated with storage tier.

Parameters

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ColumnIsolation<Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType>

Specifies at which level columns within a virtual disk should be isolated from each other. We recommend omitting this parameter and using the defaults. The acceptable values for this parameter are:

-- PhysicalDisk
-- StorageScaleUnit
-- StorageChassis
-- StorageEnclosure
-- StorageRack


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the storage tier.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FaultDomainAwareness<Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.FaultDomainType>

Specifies at what level you want the storage tier to be fault tolerant. The acceptable values for this parameter are:

-- PhysicalDisk
-- StorageScaleUnit
-- StorageChassis
-- StorageEnclosure
-- StorageRack

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FriendlyName<String>

Specifies the friendly name of the storage tier to modify.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-Interleave<UInt64>

Specifies the interleave value to use during the creation of a virtual disk. The interleave value represents the number of bytes that is written to a single physical disk. Therefore, Interleave * NumberOfColumns yields the size of one stripe of user data.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MediaType<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SetStorageTier.MediaType>

Specifies the media type of the storage tier. The acceptable values for this parameter are:

-- SSD
-- SCM
-- HDD

Use SCM for storage-class memory such as NVDIMMs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewFriendlyName<String>

Specifies a new friendly name for the storage tier.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NumberOfColumns<UInt16>

Specifies the number of columns to use when allocating the storage tier.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NumberOfDataCopies<UInt16>

Specifies the number of data copies to create. Specify 2 to create a two-way mirror, or 3 to specify a three-way mirror or for dual-parity.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NumberOfGroups<UInt16>

Specifies the number of groups used by Local Reconstruction Coding (LRC) with a dual parity virtual disk. We recommend omitting this parameter and using the defaults.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PhysicalDiskRedundancy<UInt16>

Specifies the physical disk redundancy value to use during the creation of a virtual disk. This value represents how many failed physical disks the virtual disk can tolerate without data loss. The redundancy values are as follows:

-- For two-way mirror spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For three-way mirror spaces, the virtual disk can tolerate 2 failed physical disks without data loss.
-- For single-parity spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For dual-parity spaces the virtual disk can tolerate 2 failed physical disks without data loss.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProvisioningType<Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType>

Specifies the type of provisioning. The acceptable values for this parameter are: Fixed and Thin. Specify Fixed for storage spaces that use storage tiers or a clustered storage pool.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ResiliencySettingName<String>

Specifies the resiliency setting, or storage layout, to use for the virtual disk. Acceptable values vary by storage subsystem.

Allowed values for the Windows Storage subsystem are: Simple, Mirror, or Parity. By default, when you specify Mirror, Storage Spaces creates a two-way mirror, and when you specify Parity, Storage Spaces creates a single-parity space.

To create a three-way mirror space, specify 3 for the NumberofDataCopies parameter or 2 for the PhysicalDiskRedundancy parameter.

To create a dual-parity space, specify 2 for the PhysicalDiskRedundancy parameter and Fixed provisioning for the ProvisioningType parameter.


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UniqueId<String>

Specifies the unique ID of the storage tier to modify.


Aliases

Id

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

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.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

  • The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

Example 1: Change the name of a storage tier

This command changes the friendly name of the storage tier that has the specified ID.


PS C:\> Set-StorageTier -UniqueId '{49dde1c4-5c34-11e2-8441-00155de88701}' -NewFriendlyName "FastTier"

Example 2: Change the description of a storage tier

This command uses the Get-StorageTier cmdlet to get the storage tier named FastTier, and then passes the storage tier to the Set-StorageTier cmdlet by using the pipeline operator. The Set-StorageTier cmdlet changes the description of the storage tier to the specified string.


PS C:\> Get-StorageTier -FriendlyName "FastTier" | Set-StorageTier -Description "This tier denotes fast media in the system"

Related topics

Community Additions

ADD
Show: