Edit

Get-StorageQosVolume

  • Reference
Module:
StorageQoS

Retrieves per-volume performance metrics on a volume that is monitored by Storage QoS.

Syntax

Get-StorageQosVolume
   [-VolumeId <Guid[]>]
   [-Mountpoint <String[]>]
   [-Status <Status[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-StorageQosVolume cmdlet retrieves per-volume storage performance metrics on a volume that services Storage Quality of Service (Storage QoS) flows. The metrics are throughput and latency averages, aggregated over all flows, and computed over a 5-minute rolling time interval.

Each file handle opened by a server that runs Hyper-V to a VHD or VHDX file is considered a flow. If a virtual machine has two virtual hard disks attached, it has 1 flow to the file server cluster per file. If a VHDX is shared with multiple virtual machines, it has 1 flow per virtual machine.

For more information about Storage QoS, see Storage Quality of Servicehttps://technet.microsoft.com/en-us/library/Mt126108 (https://technet.microsoft.com/en-us/library/Mt126108).

Examples

Example 1: Get QoS statistics for volumes at a specified path

PS C:\>
Get-StorageQosVolume -Mountpoint "C:\ClusterStorage\*"

Mountpoint                 IOPS Latency Status

----------                 ---- ------- ------

C:\ClusterStorage\Volume01\ 110  18.8469 Ok

This command gets QoS statistics for all volumes mounted under C:\ClusterStorage.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Mountpoint

Specifies the file system path of a volume.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

Specifies the status of flows on a volume.

  • Ok indicates the minimum IOPS are being met.
  • InsufficientThroughput indicates IOPS are below minimum.
Type:Status[]
Accepted values:Ok, InsufficientThroughput, LostCommunication
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VolumeId

Specifies the ID of a volume that services flows.

Type:Guid[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

CimInstance

This cmdlet outputs a Common Information Model (CIM) object of type MSFT_StorageQoSVolumehttps://msdn.microsoft.com/en-us/library/mt164596(v=vs.85).aspx (https://msdn.microsoft.com/en-us/library/mt164596(v=vs.85).aspx).

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.