Set-HpcGroup
Modifies the name or description of a node group.
Syntax
Group (Default)
Set-HpcGroup
-Group <HpcGroup>
[-Name <String>]
[-Description <String>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Id
Set-HpcGroup
[-Id] <Int32>
[-Name <String>]
[-Description <String>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Description
The Set-HpcGroup cmdlet changes the name or description of the specified node group.
Examples
Example 1: Set the name of a node group
PS C:\>Set-HpcGroup -Id 37 -Name "RenamedGroup"
This command changes the name of the node group with an identifier of 37 to RenamedGroup.
Example 2: Get a node group and set its name
PS C:\>Get-HpcGroup -Name "MyNdoeGruop" | Set-HpcGroup -Name "MyNodeGroup"
This command gets the HpcGroup object for a group named MyNdoeGruop and changes the name of the group to MyNodeGroup to fix the spelling error.
Example 3: Get a node group and set its description
PS C:\>Get-HpcGroup -Name "RetiringNodeGroup" | Set-HpcGroup -Description "This node group has been retired."
This command gets the HpcGroup object for a group named RetiringNodeGroup and changes the description for the group to "This node group has been retired."
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies the new description to use for the group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Group
Specifies the HpcGroup object for the node group for which you want to change the name or description. Use the Get-HpcGroup cmdlet to get an HpcGroup object for a node group.
Parameter properties
| Type: | HpcGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Group
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies the node group identifier for the node group for which you want to change the name or description. Use the Get-HpcGroup cmdlet to get the node group identifiers for the nodes in the HPC cluster.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Id
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the new name to use for the node group. The maximum length for the name of a node group is 64 characters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Scheduler
Specifies the host name or IP address of the head node for the cluster that includes the 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\>
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
HpcGroup
Outputs
HpcGroup
Notes
- If you do not specify either the Description or Name parameter, Set-HpcGroup behaves like the Get-HpcGroup cmdlet and just gets information about the specified node group, or gets an HpcGroup object for that node group.
- You must be a cluster administrator to run this cmdlet successfully.