Skip to content

Latest commit

 

History

History
142 lines (106 loc) · 4.05 KB

Get-StorageHealthSetting.md

File metadata and controls

142 lines (106 loc) · 4.05 KB
Raw
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
StorageScripts-help.xml
Storage
12/20/2016
2.0.0
Get-StorageHealthSetting

Get-StorageHealthSetting

SYNOPSIS

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
Parameter Sets: (All)
Aliases:

Required: False
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
Parameter Sets: (All)
Aliases:

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

-InputObject

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

Type: CimInstance
Parameter Sets: (All)
Aliases:

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

-Name

Specifies the name of an object or setting.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem

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

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#MSFT_StorageHealthSetting

NOTES

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

RELATED LINKS

Get-StorageSubSystem

Remove-StorageHealthSetting

Set-StorageHealthSetting