Get-HpcGroup

Get-HpcGroup

Gets node groups.

Syntax

Parameter Set: Name
Get-HpcGroup [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: Id
Get-HpcGroup [-Id] <Int32[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id<Int32[]>

Specifies an array of node group IDs 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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of 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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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.

  • HpcGroup

    This cmdlet returns one or more HpcGroup objects.


Notes

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

Examples

Example 1: Get all node groups in the cluster

This command gets information about all of the node groups in the HPC cluster.


PS C:\> Get-HpcGroup

Example 2: Get a node group by name

This command gets information about the node group named MyNodeGroup.


PS C:\> Get-HpcGroup -Name "MyNodeGroup"

Example 3: Get node groups by ID

This command gets information about the node groups with node group identifiers of 5 and 6.


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

Related topics

Community Additions

ADD
Show: