Get-StorageHealthAction
Gets health-related system activities.
Syntax
ByUniqueId
Get-StorageHealthAction
-UniqueId <String[]>
[-CimSession <CimSession>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
InputObject
Get-StorageHealthAction
[-InputObject <CimInstance>]
[-CimSession <CimSession>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-StorageHealthAction cmdlet gets health-related system activities for Storage subsystems, file shares, and volumes.
Examples
Example 1: Use the pipeline to get storage health actions
PS C:\>Get-StorageSubSystem -Model "Clustered Windows Storage" | Get-StorageHealthAction
This command gets the specified Storage subsystems, and uses the pipeline operator to pass them to Get-StorageHealthAction, which gets health-related activities for the subsytems.
Example 2: Get the health actions for a volume
PS C:\>Get-StorageSubSystem -Model "Clustered Windows Storage" | Get-Volume | Get-StorageHealthAction
This command gets the specified Storage subsystem, and uses the pipeline operator to pass it to Get-Volume, which gets the volume, and then to Get-StorageHealthAction, which gets health-related activities for the volume.
Example 3: Get the health actions for a file share
PS C:\>Get-StorageSubSystem -Model "Clustered Windows Storage" | Get-FileShare | Get-StorageHealthAction
This command gets the specified Storage subsystem, and uses the pipeline operator to pass it to Get-FileShare, which gets the file share, and then to Get-StorageHealthAction, which gets health-related activities for the file share.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UniqueId
Specifies an ID used to uniquely identify a Health Action object in the system.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByUniqueId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
CimInstance
Notes
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).