New-HpcGroup

Creates a node group.

Syntax

New-HpcGroup
   [-Name] <String>
   [-Description <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

The New-HpcGroup cmdlet creates a node group with the specified name and description.

Examples

Example 1: Create a node group

PS C:\>New-HpcGroup -Name "NewNodeGroup"

This command creates a node group named NewNodeGroup.

Example 2: Create a node group for a specified head node

PS C:\>New-HpcGroup -Name "AnotherNewNodeGroup" -Description "A new node group for my HPC cluster." -Scheduler "MyHeadNode"

Creates a new node group named AnotherNewNodeGroup on the HPC cluster that has a head node with the name MyHeadNode, and provides a description for the node group.

Parameters

-ClusterConnectionString

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the new node group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name to use for the new node group. The maximum length of the name is 64 characters.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Scheduler

Specifies the host name or IP address of the head node for the cluster to which you want to add the new node group. 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\>

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

HpcGroup

Notes

  • After you create a new node group, you can add nodes to the node group by using the Add-HpcGroup cmdlet. To change the name or description of the group after you create it, use the Set-HpcGroup cmdlet.
  • You must be a cluster administrator to run this cmdlet successfully.