Add-HpcGroup

Adds a specified list of one or more nodes to one or more specified node groups.

Syntax

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

Copy Code

Parameter Set: Name-NodeName


Add-HpcGroup [-Name] <String[]> -NodeName <String[]> [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Id-Node


Add-HpcGroup [-Id] <Int32[]> -Node <HpcNode[]> [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Id-NodeName


Add-HpcGroup [-Id] <Int32[]> -NodeName <String[]> [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Name-Node


Add-HpcGroup [-Name] <String[]> -Node <HpcNode[]> [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Adds a specified list of one or more nodes to one or more specified node groups. You can specify the node groups by name or by identifier. You can specify the nodes either by name or by using HpcNode objects that you get with the Get-HpcNode cmdlet.

Parameters

-Id<Int32[]>

Specifies a list of one or more node group identifiers for the node groups to which you want to add the nodes. Use the Get-HpcGroup cmdlet to view a list of node groups for the cluster that includes their identifiers. 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 one or more names for the node groups to which you want to add the nodes. Use the Get-HpcGroup cmdlet to view a list of node groups for the cluster that includes their names. You cannot specify both the Name and Id parameters. The maximum length for the name of a node group is 64 characters.

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

-Node<HpcNode[]>

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

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

-NodeName<String[]>

Specifies a list of one or more names for the nodes that you want to add to 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?	true
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

<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

Use this cmdlet to add nodes to a node group after you create the node group by using the New-HpcGroup cmdlet.
You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Adds the node named ComputeNode1 to the node group named MyNodeGroup.

	Copy Code
Add-HpcGroup -Name MyNodeGroup -NodeName ComputeNode1

EXAMPLE 2

Adds the node named ComputeNode2 to the node group with a node group identifier of 8.

	Copy Code
Add-HpcGroup -Id 8 -NodeName ComputeNode2

EXAMPLE 3

Gets an HpcNode object for the node named ComputeNode3, then adds that node to the node group named MyNodeGroup.

	Copy Code
Get-HpcNode -Name ComputeNode3 \| Add-HpcGroup -Name MyNodeGroup

EXAMPLE 4

Adds the nodes named ComputeNode4 and ComputeNode5 to the node groups named NodeGroup1 and NodeGroup2.

	Copy Code
Add-HpcGroup -Name NodeGroup1,NodeGroup2 -NodeName ComputeNode4,ComputeNode5