Get-HpcGroup
Gets node groups.
Syntax
Get-HpcGroup
[[-Name] <String[]>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Get-HpcGroup
[-Id] <Int32[]>
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
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.
Examples
Example 1: Get all node groups in the cluster
PS C:\>Get-HpcGroup
This command gets information about all of the node groups in the HPC cluster.
Example 2: Get a node group by name
PS C:\>Get-HpcGroup -Name "MyNodeGroup"
This command gets information about the node group named MyNodeGroup.
Example 3: Get node groups by ID
PS C:\>Get-HpcGroup -Id 5,6
This command gets information about the node groups with node group identifiers of 5 and 6.
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 |
-Id
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.
Type: | Int32[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
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.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scheduler
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\>
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
HpcGroup
This cmdlet returns one or more HpcGroup objects.
Notes
- You must be a cluster administrator to run this cmdlet successfully.