Remove-HpcGroup

Remove-HpcGroup

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

Syntax

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

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




Detailed Description

The Remove-HpcGroup cmdlet removes the association between one or more specified node groups and one or more specified nodes.

If you do not specify any nodes, Remove-HpcGroup 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, Remove-HpcGroup removes the association between the specified node group and all of the nodes, but does not delete the node group.

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

-Id<Int32[]>

Specifies an array of node group IDs for node groups from which you want to remove the nodes. Use the Get-HpcGroup cmdlet to view the node group IDs for node groups in the HPC cluster. You cannot specify both the Id and Name parameters.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for 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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

Specifies an array of HpcNode objects for 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

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-NodeName<String[]>

Specifies an array of the names of 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

none

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

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[]

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

This command removes the node named RetiringNode from the node group named MyNodeGroup.


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

Example 2: Remove the association between a node group and its nodes and remove the node group

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


PS C:\> Remove-HpcGroup -Name "MyRetiringNodeGroup"

Example 3: Remove a node by its ID

This command removes the node named RetiringNode2 from the node group with an identifier of 26.


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

Example 4: Remove nodes from node groups

This command 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.


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

Related topics

Community Additions

ADD
Show: