Set-HpcGroup

Reference

Module:: HPCPack2016

Modifies the name or description of a node group.

Syntax

Set-HpcGroup
   -Group <HpcGroup>
   [-Name <String>]
   [-Description <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies the new description to use for the group.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	HpcGroup
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	Int32
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	Named
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 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\>

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

HpcGroup

Outputs