Set-StorageTier
Set-StorageTier
Modifies a storage tier.
Syntax
Parameter Set: ByUniqueIdNewFriendlyName
Set-StorageTier -UniqueId <String> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByFriendlyNameDescription
Set-StorageTier [-FriendlyName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByFriendlyNameMediaType
Set-StorageTier [-FriendlyName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-MediaType <MediaType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByFriendlyNameNewFriendlyName
Set-StorageTier [-FriendlyName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByObjectDescription
Set-StorageTier -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByObjectMediaType
Set-StorageTier -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-MediaType <MediaType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByObjectNewFriendlyName
Set-StorageTier -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByUniqueIdDescription
Set-StorageTier -UniqueId <String> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByUniqueIdMediaType
Set-StorageTier -UniqueId <String> [-AsJob] [-CimSession <CimSession[]> ] [-MediaType <MediaType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
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
-AsJob
Aliases |
none |
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.
Aliases |
Session |
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 |
-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 |
-InputObject<CimInstance[]>
Specifies the StorageTier object to modify. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-MediaType<MediaType>
Specifies a media type for the storage tier. The cmdlet changes the media type that is associated with the storage tier to the media type that you specify. The acceptable values for this parameter are:
-- SSD
-- HDD
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 |
-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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem
You can use the pipeline operator to pass an array of MSFT_StorageTier objects to the InputObject parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageTier
This cmdlet returns an MSFT_StorageTier object that contains details about the tier such as tier friendly name, media type and size.
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"