Edit

Get-StorageHealthSetting

  • Reference
Module:
Storage

Gets storage health service settings.

Syntax

Get-StorageHealthSetting
   -InputObject <CimInstance>
   [-Name <String>]
   [-CimSession <CimSession>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-StorageHealthSetting cmdlet gets the storage health service settings for a specified Storage subsystem.

Examples

Example 1: Get storage health settings

PS C:\>Get-StorageSubSystem -Model "Clustered Windows Storage" | Get-StorageHealthSetting
Name                              Value
----                              -----
Platform.Rules.Document           <rules version="1.0">...

The first command uses the Get-StorageSubSystem cmdlet to get the specified StorageSubsystem object, and then uses the pipeline operator to pass it to Get-StorageHealthSetting to get its health settings.

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

-InputObject

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

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

-Name

Specifies the name of an object or setting.

Type:String
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

Inputs

CimInstance

You can pipe a storage subsystem object for which this cmdlet gets settings.

Outputs

CimInstance

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).