Share via

Get-HpcMetric

  • Reference
Module:
HPCPack2016

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

Syntax

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

Description

The Get-HpcMetric cmdlet 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.

Examples

Example 1: Get all metrics for the cluster

PowerShell 
PS C:\>Get-HpcMetric

This command gets all of the metrics for the HPC cluster.

Example 2: Get metrics by name

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

This command gets the metrics named HpcCpuUsage and HpcDiskSpace.

Example 3: Get metrics by location and category

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

This command gets the metrics in the performance categories that are generated on the head node or for the entire HPC cluster.

Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.

This parameter was introduced in HPC Pack 2016.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MetricTargets

Specify an array of metric targets. The acceptable values for this parameter are:

  • Cluster
  • HeadNode
  • ComputeNode
  • BrokerNode
  • WorkStationNode
  • AzureNode
  • AzureBatchPool
Type:MetricTarget[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of names for the metrics that you want to get.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scheduler

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\>

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Type

Specifies an array of categories that include the metrics that you want to get. Valid values are: Performance, Calculated.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

HpcMetric[]

Outputs

HpcMetric[]

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.