Get-Metrics
SYNOPSIS
Gets performance, space, copy and wear metrics of various entities on the PowerStore cluster.
SYNTAX
Get-Metrics [-Cluster] <Cluster> [-Entity] <String> [-EntityId] <String> [[-Interval] <String>]
[<CommonParameters>]
DESCRIPTION
Gets performance, space, copy and wear metrics of various entities on the PowerStore cluster.
EXAMPLES
Example 1
PS C:\> Get-Metrics -Cluster $cluster -Entity performance_metrics_by_vg -EntityId vgId
Where $cluster is a PowerStore cluster instance. Returns a list of performance metrics for volume group with ID vgId.
Example 2
PS C:\> Get-Metrics -Cluster $cluster -Entity space_metrics_by_cluster -EntityId clusterId -Interval One_Hour
Where $cluster is a PowerStore cluster instance. Returns a list of space metrics with one hour interval for cluster with ID clusterId.
PARAMETERS
-Cluster
A PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Entity
Entity type.
Types with or without underscore are supported, case insensitive, e.g., performance_metrics_by_appliance or performancemetricsbyappliance, performance_metrics_by_volume, space_metrics_by_volume, copy_metrics_by_volume, wear_metrics_by_drive and so on.
For a complete list of supported entities, refer to the PowerStore API documentation or the MetricsEntityEnum values at https://
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EntityId
Entity ID. For instance, a volume ID or cluster ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Interval
Intervals of which metrics can be provided. Intervals with or without underscore are supported, case insensitive, e.g., Twenty_Sec or TwentySec, Five_Mins, One_Hour, One_Day. Please note that some intervals may not be supported for all entity types.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
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.