Export (0) Print
Expand All

Get-HpcGroup

Gets the specified list of one or more node groups.

Syntax

Get-HpcGroup [-Id <int[]>] [-Scheduler <string>] [<CommonParameters>]

Get-HpcGroup [-Scheduler <string>] [[-Name] <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 <int[]>

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.

 

Required?

false

Position?

named

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.

 

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>

 

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.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

 

Input Type

None.

Return Type

One or more HpcGroup objects.

Example 1

C:\PS>Get-HpcGroup

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

Example 2

C:\PS>Get-HpcGroup -Name MyNodeGroup

Displays information about the node group named MyNodeGroup.

Example 3

C:\PS>Get-HpcGroup -Id 5,6

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

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft