Remove-HpcGroup

Removes the association between one or more specified node groups and one or more specified nodes.

Syntax

	Copy Code
Parameter Set: Name Remove-HpcGroup [-Name] <String[]> [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: Id Remove-HpcGroup [-Id] <Int32[]> [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Copy Code

Parameter Set: Name


Remove-HpcGroup [-Name] <String[]> [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Id


Remove-HpcGroup [-Id] <Int32[]> [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Removes the association between one or more specified node groups and one or more specified nodes.

If you do not specify any nodes, the Remove-HpcGroup cmdlet removes the association between the specified node groups and all of the nodes that the node groups contain, then deletes the node groups.

If you specify all of the nodes in a specified node group, the Remove-HpcGroup cmdlet removes the association between the specified node group and all of the nodes, but does not delete the node group.

Parameters

-Id<Int32[]>

Specifies a list of node group identifiers for one or more node groups from which you want to remove the nodes. Use the Get-HpcGroup cmdlet to view the node group identifiers for node groups in the HPC cluster. You cannot specify both the Id and Name parameters.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies a list of names for one or more node groups from which you want to remove the nodes. Use the Get-HpcGroup cmdlet to view the available node groups in the HPC cluster. You cannot specify both the Name and Id parameters.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Node<HpcNode[]>

Specifies a list of HpcNode objects for one or more nodes that you want to remove from the node groups. Use the Get-HpcNode cmdlet to get HpcNode objects for nodes. You cannot specify both the Node and NodeName parameters.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-NodeName<String[]>

Specifies a list of the names of one or more nodes that you want to remove from the node groups. You cannot specify both the NodeName and Node parameters. This parameter is a filter parameter, so you do not receive an error for specifying a node the does not exist in the HPC cluster as long as you specify at least one node that does exist.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster that includes the node groups. 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 High. 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 RetiringNode from the node group named MyNodeGroup.

	Copy Code
Remove-HpcGroup -Name MyNodeGroup -NodeName RetiringNode

EXAMPLE 2

Removes the association between the node group named MyRetiringNodeGroup and all of the nodes that node group contains, then deletes the node group.

	Copy Code
Remove-HpcGroup -Name MyRetiringNodeGroup

EXAMPLE 3

Removes the node named RetiringNode2 from the node group with an identifier of 26.

	Copy Code
Remove-HpcGroup -Id 26 -NodeName RetiringNode2

EXAMPLE 4

Gets the HpcNode objects for the nodes named RetiringNode3 and RetiringNode4, then removes both of those nodes from the node groups named NodeGroup1 and NodeGroup2.

	Copy Code
Get-HpcNode -Name RetiringNode3,RetiringNode4 \| Remove-HpcGroup -Name NodeGroup1,NodeGroup2