Get-HpcMetricValue

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

Syntax

	Copy Code
Parameter Set: Node Get-HpcMetricValue [[-Name] <String[]> ] [-Counter <String[]> ] [-MetricTarget <MetricTarget[]> ] [-Node <HpcNode[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>] Parameter Set: Nodename Get-HpcMetricValue [[-Name] <String[]> ] [-Counter <String[]> ] [-MetricTarget <MetricTarget[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>]

Copy Code

Parameter Set: Node


Get-HpcMetricValue [[-Name] <String[]> ] [-Counter <String[]> ] [-MetricTarget <MetricTarget[]> ] [-Node <HpcNode[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>]

Parameter Set: Nodename


Get-HpcMetricValue [[-Name] <String[]> ] [-Counter <String[]> ] [-MetricTarget <MetricTarget[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Type <String[]> ] [ <CommonParameters>]

Detailed Description

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

You can specify the metric values 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. You can specify the nodes for which you want to get the metric values by specifying the node name or an HpcNode object for the NodeName or Node parameters, respectively.

If you do not specify any names, locations, or categories, the Get-HpcMetricValue cmdlet gets the values of all of the metrics for the specified nodes, or for all of nodes in the HPC cluster if no nodes are specified.

Parameters

-Counter<String[]>

Specifies a list of one or more counters for which you want to get the current value. A single metric can contain multiple counters. For example, the HPCSchedulerJobs metric contains multiple job-related counters such as Total number of jobs and Number of canceled jobs.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-MetricTarget<MetricTarget[]>

Specifies a list of one or more locations where the metrics that you want to get values for 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 for which you want to get the current values.

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

-Node<HpcNode[]>

Specifies a list of one or more HpcNode objects that correspond to the nodes for which you want to get the values of the metrics. Use the Get-HpcNode cmdlet to get the HpcNode objects for the nodes. You cannot specify both the Node and NodeName parameters.

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

-NodeName<String[]>

Specifies a list of the names of one or more nodes for which you want to get the values of the metrics. You cannot specify both the NodeName and Node parameters. This parameter is a filter parameter, so you do not receive an error for specifying a node the does not exist in the HPC cluster as long as you specify at least one node that does exist.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster that includes the metrics for which you want to get the current values. 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 HpcNode objects, or one or more HpcMetric objects.

Outputs

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

One or more HpcMetricValue objects.

Notes

You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Gets the current values of all the counters for all of the metrics on all of the nodes in the HPC cluster.

	Copy Code
Get-HpcMetricValue

EXAMPLE 2

Gets the current values of all of the counters for the HPCCpuUsage and HPCDiskSpace metrics for the node named ComputeNode1.

	Copy Code
Get-HpcMetricValue -Name HPCCpuUsage,HPCDiskSpace -NodeName ComputeNode1

EXAMPLE 3

Gets the current values of the counters named Total number of jobs and Number of canceled jobs for the metric named HpcSchedulerJobs.

	Copy Code
Get-HpcMetricValue -Name HpcSchedulerJobs -Counters "Total number of jobs","Number of canceled jobs"

EXAMPLE 4

Gets the current values on the compute node named ComputeNode1 for all of the counters for all of the metrics that are generated on compute nodes.

	Copy Code
Get-HpcNode -Name ComputeNode1 \| Get-HpcMetricValue -MetricTarget ComputeNode