Get-HpcMetric

Gets the specified set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Syntax

	Copy Code
Parameter Set: Default Get-HpcMetric [[-Name] <String[]> ] [-MetricTarget <MetricTarget[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Get-HpcMetric [[-Name] <String[]> ] [-MetricTarget <MetricTarget[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>]

Detailed Description

Gets the specified set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts. You can specify the metrics that you want to get by any combination of the names of the metrics, the locations where the metrics are generated, and the categories for the metrics. If you do not specify any names, locations, or categories, the Get-HpcMetric cmdlet gets all of the metrics for the HPC Cluster.

Parameters

-MetricTarget<MetricTarget[]>

Specifies a list of one or more locations where the metrics that you want to get are generated. The valid locations are HeadNode, ComputeNode, and Cluster.

Aliases	none
Required?	false
Position?	named
Default Value	HeadNode,ComputeNode,Cluster
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies a list of one or more names for the metrics that you want to get.

Aliases	none
Required?	false
Position?	1
Default Value	no default
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Accept Wildcard Characters?	true

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster that includes the metrics. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Type<String[]>

Specifies one or more categories that include the metrics that you want to get. The valid categories are Performance, Hardware, and Calculated.

Aliases	none
Required?	false
Position?	named
Default Value	Performance,Hardware,Calculated
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

One or more HpcMetric objects, through their Name properties.

Outputs

The output type is the type of the objects that the cmdlet emits.

One or more HpcMetric objects.

Notes

The Get-HpcMetric cmdlet only gets information or HpcMetrics objects for the metrics, and not the values of the metrics. To get the values for the metrics, use the Get-HpcMetricValue cmdlet.
You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Gets all of the metrics for the HPC Cluster.

	Copy Code
Get-HpcMetric

EXAMPLE 2

Gets the metrics named HpcCpuUsage and HpcDiskSpace.

	Copy Code
Get-HpcMetric -Name HpcCpuUsage,HpcDiskSpace

EXAMPLE 3

Gets the metrics in the performance and hardware categories that are generated on the head node or for the entire HPC cluster.

	Copy Code
Get-HpcMetric -MetricTarget HeadNode,Cluster -Type Performance,Hardware