Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

Get-HpcMetric [-MetricTarget <MetricTarget[]>] [-Scheduler <string>] [-Type <string[]>] [[-Name] <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.

 

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.

 

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

true (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>

 

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.

 

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.

Input and Return Types

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

 

Input Type

One or more HpcMetric objects, through their Name properties.

Return Type

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.

Example 1

C:\PS>Get-HpcMetric

Gets all of the metrics for the HPC Cluster.

Example 2

C:\PS>Get-HpcMetric -Name HpcCpuUsage,HpcDiskSpace

Gets the metrics named HpcCpuUsage and HpcDiskSpace.

Example 3

C:\PS>Get-HpcMetric -MetricTarget HeadNode,Cluster -Type Performance,Hardware

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

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.