Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-StorageTier

Set-StorageTier

storagecmdlets.cdxml

Synopsis

Modifies a storage tier.

Syntax

Set-StorageTier [-AsJob] [-CimSession] [-NewFriendlyName] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-StorageTier [-AsJob] [-CimSession] [-MediaType] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Set-StorageTier [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-StorageTier [-FriendlyName] [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [<CommonParameters>]

Set-StorageTier [-FriendlyName] [-AsJob] [-CimSession] [-MediaType] [-ThrottleLimit] [<CommonParameters>]

Set-StorageTier [-FriendlyName] [-AsJob] [-CimSession] [-NewFriendlyName] [-ThrottleLimit] [<CommonParameters>]

Set-StorageTier [-AsJob] [-CimSession] [-MediaType] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-StorageTier [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Set-StorageTier [-AsJob] [-CimSession] [-NewFriendlyName] [-ThrottleLimit] [-InputObject] [<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 <SwitchParameter>

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.

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

Input Type

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

Return Type

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

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"

Online Version
Get-StorageTier
New-StorageTier
Remove-StorageTier
Resize-StorageTier
Get-VirtualDisk