Get-HpcGroup

Gets the specified list of one or more node groups.

Syntax

	Copy Code
Parameter Set: Name Get-HpcGroup [[-Name] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: Id Get-HpcGroup [-Id] <Int32[]> [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Name


Get-HpcGroup [[-Name] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Id


Get-HpcGroup [-Id] <Int32[]> [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets a list of one or more node groups, specified by the names or identifiers of the node groups. If you do not specify a node group, the Get-HpcGroup cmdlet gets all of the node groups for the HPC cluster.

Parameters

-Id<Int32[]>

Specifies a list of one or more node group identifiers for the node groups that you want to get. 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 that you want to get. 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?	false
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 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.

None.

Outputs

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

One or more HpcGroup objects.

Notes

You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Displays information about all of the node groups in the HPC cluster.

	Copy Code
Get-HpcGroup

EXAMPLE 2

Displays information about the node group named MyNodeGroup.

	Copy Code
Get-HpcGroup -Name MyNodeGroup

EXAMPLE 3

Displays information about the node groups with node group identifiers of 5 and 6.

	Copy Code
Get-HpcGroup -Id 5,6