New-HpcGroup

New-HpcGroup

Creates a new node group with the specified name and description.

Syntax

Parameter Set: Default
New-HpcGroup [-Name] <String> [-Description <String> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Creates a new node group with the specified name and description.

Parameters

-Description<String>

Specifies a description for the new node group.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

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

Aliases

none

Required?

true

Position?

1

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

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.

  • None.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • An HpcGroup object.

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.

Examples

EXAMPLE 1

Creates a new node group named NewNodeGroup.

PS C:\>New-HpcGroup -Name NewNodeGroup

EXAMPLE 2

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.

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

Add-HpcGroup

Get-HpcGroup

Remove-HpcGroup

Set-HpcGroup