Get-HpcMetric

Get-HpcMetric

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

Syntax

Parameter Set: Default
Get-HpcMetric [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-MetricTargets <MetricTarget[]> ] [-Scheduler <String[]> ] [-Type {Performance | Calculated}[] ] [ <CommonParameters>]




Detailed 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.

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MetricTargets<MetricTarget[]>

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

-- Cluster
-- HeadNode
-- ComputeNode
-- BrokerNode
-- WorkStationNode
-- AzureNode
-- AzureBatchPool


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<String[]>

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


Aliases

none

Required?

false

Position?

named

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.

Inputs

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

  • HpcMetric[]

Outputs

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

  • 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.

Examples

Example 1: Get all metrics for the cluster

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


PS C:\> Get-HpcMetric

Example 2: Get metrics by name

This command gets the metrics named HpcCpuUsage and HpcDiskSpace.


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

Example 3: Get metrics by location and category

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


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

Related topics

Community Additions

ADD
Show: