Export (0) Print
Expand All
Expand Minimize

Remove-HpcMetric

Updated: January 10, 2014

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

Parameter Set: Default
Remove-HpcMetric [-Name] <String[]> [-Scheduler <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.


Aliases

none

Required?

true

Position?

1

Default Value

no default

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

%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

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

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 HpcMetric objects, through their Name properties.

Outputs

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

  • None.

Notes

  • The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$false. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$true.

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

Examples

EXAMPLE 1

Removes the metric named MyCustomMetric.


PS C:\>Remove-HpcMetric -Name MyCustomMetric

EXAMPLE 2

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


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

EXAMPLE 3

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


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft