Get-Storage Health Report

Module:
storage
Gets a storage health report.

Syntax 

Get-StorageHealthReport
   -InputObject <CimInstance>
   [-Count <Int32>]
   [-CimSession <CimSession>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-StorageHealthReport cmdlet gets a storage health report.

Examples

Example 1: Get a storage health report 

PS C:\>Get-StorageSubSystem -Model "Clustered Windows Storage" | Get-StorageHealthReport
AverageCPUUsage           :  10.73 %
AverageLatency            :      0 ns
MemoryAvailable           :  82.84 GB
MemoryTotal               :     96 GB
PhysicalCapacityRemaining : 139.24 GB
PhysicalCapacityTotal     :  336.7 GB
PoolCapacityRemaining     : 161.25 GB
PoolCapacityTotal         :    185 GB
ReadIOPS                  :      0 /S
ReadLatency               :      0 ns
ReadThroughput            :      0 B/S
TotalIOPS                 :      0 /S
TotalThroughput           :      0 B/S
VolumeCapacityRemaining   :   4.92 GB
VolumeCapacityTotal       :   5.97 GB
WriteIOPS                 :      0 /S
WriteLatency              :      0 ns
WriteThroughput           :      0 B/S
ExtendedStatus : 
ReturnValue    : 0
PSComputerName :

This command uses the Get-StorageSubSystem cmdlet to get the specified StorageSubsystem object, and uses the pipeline operator to pass it to Get-StorageHealthReport to display its health report.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional 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
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
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Count

Specifies the number of report objects to be collected when the report runs. The default value is one (1). The maximum value is 300.

Type: Int32
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_StorageHealthReport