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

Remove-HpcMetric

Removes one or more specified metrics from the set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Syntax

Remove-HpcMetric [-Scheduler <string>] [-Name] <string[]> [-confirm] [-whatif] [<CommonParameters>]

Detailed Description

Removes one or more specified metrics from the set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Parameters

-Name <string[]>

Specifies a list of the names of one or more metrics that you want to remove.

 

Required?

true

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

-Confirm

Prompts you for confirmation before executing the command.

 

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

 

Required?

false

Position?

named

Default Value

none

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

None.

Example 1

C:\PS>Remove-HpcMetric -Name MyCustomMetric

Removes the metric named MyCustomMetric.

Example 2

C:\PS>Remove-HpcMetric -Name CustomMetric1,CustomMetric2 -Scheduler HeadNode

Removes the metrics named CustomMetric1 and CustomMetric2 from the HPC cluster that has a head node named HeadNode.

Example 3

C:\PS>Get-HpcMetric -Type Calculated | Remove-HpcMetric

Gets HpcMetric objects for all of the metrics with a category of calculated, then removes those metrics.

See Also

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.