Export (0) Print
Expand All

Remove-HpcGroup

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

Syntax

Remove-HpcGroup [-Node <HpcNode[]>] [-NodeName <string[]>] [-Scheduler <string>] -Id <int[]> [-confirm] [-whatif] [<CommonParameters>]

Remove-HpcGroup [-Node <HpcNode[]>] [-NodeName <string[]>] [-Scheduler <string>] [-Name] <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 <int[]>

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.

 

Required?

true

Position?

named

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.

 

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.

 

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.

 

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>

 

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.

Input and Return Types

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

 

Input Type

One or more HpcNode objects.

Return Type

None.

Example 1

C:\PS>Remove-HpcGroup -Name MyNodeGroup -NodeName RetiringNode

Removes the node named RetiringNode from the node group named MyNodeGroup.

Example 2

C:\PS>Remove-HpcGroup -Name MyRetiringNodeGroup

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

Example 3

C:\PS>Remove-HpcGroup -Id 26 -NodeName RetiringNode2

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

Example 4

C:\PS>Get-HpcNode -Name RetiringNode3,RetiringNode4 | Remove-HpcGroup -Name NodeGroup1,NodeGroup2

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.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft