Remove-HpcNode

Remove-HpcNode

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

Syntax

Parameter Set: Name
Remove-HpcNode [-Name] <String[]> [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Node
Remove-HpcNode -Node <HpcNode[]> [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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.

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Comment<String>

Specifies a comment for the node removal.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for the nodes that you want to remove. You cannot specify both the Name and the Node parameters.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Scheduler<String[]>

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • HpcNode[]

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: Remove a node

This command removes the node named Node11.


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

Example 2: Removes nodes by name

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


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

Related topics

Community Additions

ADD
Show: