Remove-HpcMetric

  • Reference
Module:
HPCPack2016

Removes 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
      [-Name] <String[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-HpcMetric cmdlet 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.

Examples

Example 1: Remove a metric by name

PS C:\>Remove-HpcMetric -Name "MyCustomMetric"

This command removes the metric named MyCustomMetric.

Example 2: Remove metrics for a head node

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

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

Example 3: Get metrics by category and remove them

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

This command gets HpcMetric objects for all of the metrics with a category of Calculated, and then removes those metrics.

Parameters

-ClusterConnectionString

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Scheduler

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\>

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

HpcMetric[]

Outputs

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.