< Back

Set-FileStorageTier

Wed Jan 30, 2019 6:03 pm

NAME Set-FileStorageTier



SYNOPSIS

Assigns a file to a storage tier.





SYNTAX

Set-FileStorageTier [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -DesiredStorageTierFriendlyName <String> -FilePath <String> [-Confirm]

[-WhatIf] [<CommonParameters>]



Set-FileStorageTier [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -DesiredStorageTierUniqueId <String> -FilePath <String> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-FileStorageTier [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -DesiredStorageTier <CimInstance> -FilePath <String> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Set-FileStorageTier cmdlet assigns a file to a specified storage tier. Assigning a file to a tier is also called pinning the file to a tier. To pin

a file to a storage tier, the file must be on a volume that is hosted by the same tiered storage space. If you pin a file that is already assigned to a

different tier, the file changes assignment the next time tier optimization takes place.





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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-DesiredStorageTier <CimInstance>

Specifies the storage tier, as a CimInstance object, to pin a file to. To obtain a storage tier object, use the Get-StorageTier cmdlet.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DesiredStorageTierFriendlyName <String>

Specifies the friendly name of a storage tier to pin a file to.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DesiredStorageTierUniqueId <String>

Specifies the unique ID, as a string, of a storage tier to pin a file to.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-FilePath <String>

Specifies the full path of a file. The cmdlet pins the file that you specify to a storage tier.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value false

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_StorageTier

http://msdn.microsoft.com/library/windo ... s.85).aspx





You can use the pipeline operator to pass an MSFT_StorageTier object to the DesiredStorageTier parameter.





OUTPUTS





This cmdlet does not generate any output.





Example 1: Pin a file to a storage tier



PS C:\\> $StorageTier = Get-StorageTier -FriendlyName "Tier07"

PS C:\\> Set-FileStorageTier -DesiredStorageTier $StorageTier -FilePath "D:\\DataFile06.txt"



The first command uses the Get-StorageTier cmdlet to get a storage tier named Tier07, and then stores the tier in the $StorageTier variable.



The second command pins the specified file to a storage tier. The command specifies the storage tier by using the object stored in the $StorageTier

variable.





Example 2: Pin a file to a storage tier by using an ID



PS C:\\> $StorageTier = Get- StorageTier -FriendlyName "Tier07"

PS C:\\> Set-FileStorageTier -DesiredStorageTierUniqueId $StorageTier.UniqueId -FilePath "D:\\DataFile06.txt"



The first command uses the Get-StorageTier cmdlet to get a storage tier named Tier07, and then stores the tier in the $StorageTier variable.



The second command pins the specified file to a storage tier. The command specifies the ID of the storage tier by using the UniqueID property of the

storage tier object stored in the $StorageTier variable.







RELATED LINKS

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

Clear-FileStorageTier

Get-FileStorageTier

Get-StorageTierSupportedSize