Remove-HpcNode
Syntax
![]() |
|
---|---|
Parameter Set: Name Remove-HpcNode [-Name] <String[]> [-Comment <String> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: Node Remove-HpcNode -Node <HpcNode[]> [-Comment <String> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] |
Detailed Description
Removes the entry for one of more compute nodes from the database on the head node. This cmdlet does not delete Microsoft HPC Pack 2008 on the compute nodes. To delete a node completely, you need to uninstall HPC Pack 2008 as well. You can use HPC Cluster Manager to add compute nodes that you deleted back to the cluster. HPC Cluster Manager is able to rediscover these deleted compute nodes.
Parameters
-Comment<String>
Specifies a comment for the node removal.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies a list 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 |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-Node<HpcNode[]>
Specifies a list 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 |
no default |
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 |
%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
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- One or more HpcNode objects.
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 node named node11.
![]() |
|
---|---|
Remove-HpcNode -Name "node11" |
EXAMPLE 2
Gets HpcNode objects for all of the nodes with names that start with hpcr1, and removes those nodes.
![]() |
|
---|---|
Get-HpcNode -Name hpcr1* | Remove-HpcNode |