Remove-HpcNode

  • Reference
Module:
HPCPack2016

Removes the entry for one or more nodes from the HPC cluster management database.

Syntax

Remove-HpcNode
      [-Comment <String>]
      [-Name] <String[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-HpcNode
      [-Comment <String>]
      -Node <HpcNode[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-HpcNode cmdlet removes the entry for one or more nodes from the HPC cluster management database. This cmdlet does not delete Microsoft® HPC Pack on the nodes. To delete a node completely, you must uninstall HPC Pack as well. You can use HPC Cluster Manager to add nodes that you deleted back to the cluster. HPC Cluster Manager is able to rediscover these deleted nodes.

Examples

Example 1: Remove a node

PS C:\>Remove-HpcNode -Name "Node11"

This command removes the node named Node11.

Example 2: Removes nodes by name

PS C:\>Get-HpcNode -Name "hpcr1*" | Remove-HpcNode

This command gets HpcNode objects for all of the nodes with names that start with hpcr1, and removes those nodes.

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

-Comment

Specifies a comment for the node removal.

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 names for the nodes that you want to remove. You cannot specify both the Name and the Node parameters.

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

-Node

Specifies an array of HpcNode objects for the nodes that you want to remove. Use the Get-HpcNode cmdlet to get HpcNode objects for nodes.

Type:HpcNode[]
Position:Named
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 nodes. 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

HpcNode[]

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.