Get-HpcMetricValueHistory

Gets the values for a specified metric during the specified time period.

Syntax

	Copy Code
Parameter Set: NodeName Get-HpcMetricValueHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Counter <String[]> ] [-MetricName <String[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: Node Get-HpcMetricValueHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Counter <String[]> ] [-MetricName <String[]> ] [-Node <HpcNode[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: NodeName


Get-HpcMetricValueHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Counter <String[]> ] [-MetricName <String[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Node


Get-HpcMetricValueHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Counter <String[]> ] [-MetricName <String[]> ] [-Node <HpcNode[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets the values for a specified metric during the specified time period. HPC Cluster Manager uses these metrics in the heat maps for the nodes and the monitoring charts. The time period is the period after the specified start date and time and before the specified end date and time.

You can specify the nodes for which you want to get the metric values by specifying the node name or by specifying an HpcNode object for the NodeName or Node parameters, respectively.

If you do not specify any metric names, the Get-HpcMetricValueHistory cmdlet gets the values for 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 values during the date range. 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

-EndDate<DateTime>

Specifies the end date and time for the time period for which you want to get value information for the metrics. Use the Get-Date cmdlet to get a DateTime object for a date and time.

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

-MetricName<String[]>

Specifies a list of one or more names for the metrics for which you want to get the current values. To view a list of the metrics that are available on the HPC cluster, use the Get-HpcMetric cmdlet.

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

-Node<HpcNode[]>

Specifies a list of one or more 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 that 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 values during the date range. 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

-StartDate<DateTime>

Specifies the start date and time for the time period for which you want to get value information for the metrics. Use the Get-Date cmdlet to get a DateTime object for a date and time.

Aliases	none
Required?	true
Position?	1
Default Value	no default
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

Outputs

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

One or more HpcMetricValueHistory objects

Notes

To get the current values for metrics, use the Get-HpcMetricValue cmdlet.
You must be a cluster administrator to run this cmdlet successfully.
This cmdlet is supported only for Windows HPC Server 2008 R2.

Examples

EXAMPLE 1

Gets the values of all of the metrics for all of the nodes in an HPC cluster for the period starting at midnight on 5/18/2010 and ending at midnight on 5/19/2010.

	Copy Code
Get-HpcMetricValueHistory –StartDate "5/18/2010 12:00:00 AM" –EndDate "5/19/2010 12:00:00 AM"

EXAMPLE 2

Gets the values of the HPCCpuUsage and HPCDiskSpace metrics for the node named ComputeNode1 for the period starting at midnight on 5/18/2010 and ending at midnight on 5/19/2010.

	Copy Code
Get-HpcMetricValueHistory –StartDate "5/18/2010 12:00:00 AM" –EndDate "5/19/2010 12:00:00 AM" -Name HPCCpuUsage,HPCDiskSpace -NodeName ComputeNode1

EXAMPLE 3

Gets the values of the _Total counter for the HPCDiskSpace metric on all nodes in the HPC cluster for the period starting at midnight on 5/18/2010 and ending at 12:02 AM on 5/18/2010.

	Copy Code
Get-HpcMetricValueHistory –StartDate "5/18/2010 12:00:00 AM" –EndDate "5/18/2010 12:02:00 AM" -Name HPCDiskSpace -Counter _Total

EXAMPLE 4

Gets the HpcNode object for the node named ComputeNode2, then gets the values of the HpcDiskQueue metric on that node for the period starting at midnight on 5/18/2010 and ending at 12:02 AM on 5/18/2010 by redirecting the HpcNode object to the input of the Get-HpcMetricValueHistory cmdlet.

	Copy Code
Get-HpcNode –Name ComputeNode2 \| Get-HpcMetricValueHistory –StartDate "5/18/2010 12:00:00 AM" –EndDate "5/18/2010 12:02:00 AM" -Name HpcDiskQueue