Set-HpcGroup

Set-HpcGroup

Modifies the name or description of a node group.

Syntax

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

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




Detailed Description

The Set-HpcGroup cmdlet changes the name or description of the specified node group.

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

-Description<String>

Specifies the new description to use for the group.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Group<HpcGroup>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Id<Int32>

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.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the new name to use for the node group. The maximum length for the name of a node group is 64 characters.


Aliases

none

Required?

false

Position?

named

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 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>


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.

  • HpcGroup

Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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.

Examples

Example 1: Set the name of a node group

This command changes the name of the node group with an identifier of 37 to RenamedGroup.


PS C:\> Set-HpcGroup -Id 37 -Name "RenamedGroup"

Example 2: Get a node group and set its name

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.


PS C:\> Get-HpcGroup -Name "MyNdoeGruop" | Set-HpcGroup -Name "MyNodeGroup"

Example 3: Get a node group and set its description

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."


PS C:\> Get-HpcGroup -Name "RetiringNodeGroup" | Set-HpcGroup -Description "This node group has been retired." 

Related topics

Community Additions

ADD
Show: