Get-FileStorageTier
Get-FileStorageTier
Gets the files assigned to a storage tier on a volume, and their status.
Syntax
Parameter Set: ByVolumeDriveLetter
Get-FileStorageTier -VolumeDriveLetter <Char> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByFilePath
Get-FileStorageTier -FilePath <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByVolume
Get-FileStorageTier -Volume <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByVolumePath
Get-FileStorageTier -VolumePath <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-FileStorageTier cmdlet gets all the files assigned to a storage tier on a tiered volume stored on a tiered storage space, and the status of each file. A file that you assign to a storage tier is called a pinned file. The possible status values are the following:
-- Not on tier
-- Completely on tier
-- Partially on 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 |
-FilePath<String>
Specifies the full path of a file. The cmdlet gets the pinned file that you specify and its status.
Aliases |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Volume<CimInstance>
Specifies a volume as a CimInstance object. The cmdlet gets the pinned files for the volume that you specify, and their status values. To obtain a volume, use the Get-Volume cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VolumeDriveLetter<Char>
Specifies the drive letter of a volume. The cmdlet gets the pinned files for the volume that you specify, and their status values.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VolumePath<String>
Specifies the path of a volume. The cmdlet gets the pinned files for the volume that you specify, and their status values.
Aliases |
none |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
This cmdlet generates a file storage tier object that contains the desired storage tier, file path, status, desired storage tier file size, and state. State includes values of Ok, Pending, and Processing.
Examples
Example 1: Get status for a file
This command gets the pinned file that you specify, and its status.
PS C:\> Get-FileStorageTier -FilePath "D:\DataFile06.txt"
Example 2: Get pinned files for a volume
This command gets the pinned files for the specified volume, and their status values.
PS C:\> Get-FileStorageTier -VolumePath "\\?\Volume{6d6e000d-6038-11e2-be6d-806e6f6e6963}\"