Set-HpcNode

Set-HpcNode

Changes the properties for a node.

Syntax

Parameter Set: Name
Set-HpcNode [-Name] <String[]> [-Affinity <Boolean]> ] [-Chassis <String> ] [-ClusterConnectionString <String[]> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeRole[]> ] [-Scheduler <String[]> ] [-SubscribedCores <UInt32]> ] [-SubscribedSockets <UInt32]> ] [ <CommonParameters>]

Parameter Set: Node
Set-HpcNode -Node <HpcNode[]> [-Affinity <Boolean]> ] [-Chassis <String> ] [-ClusterConnectionString <String[]> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeRole[]> ] [-Scheduler <String[]> ] [-SubscribedCores <UInt32]> ] [-SubscribedSockets <UInt32]> ] [ <CommonParameters>]




Detailed Description

The Set-HpcNode cmdlet changes the properties for one or more nodes, including the description, location, roles, and product key for the nodes.

Parameters

-Affinity<Boolean]>

Indicates how affinity is managed for tasks that run on the node. By default, the value is $Null, which means that affinity is managed according to the job scheduler affinity policy. If this property is set, node affinity overrides the job scheduler affinity settings. A value of 0 or $False specifies that affinity on the node is not managed by the HPC services, and the operating system or the application manages placement of tasks on physical cores. A value of 1 or $True specifies that the HPC Node Manager Service sets affinity for tasks (assigns tasks to specific cores).

For more information relating to affinity, see Understanding Affinity.

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Chassis<String>

Specifies the chassis in which the node is located. If you specify the Chassis parameter, you must also specify the DataCenter and Rack parameters.

This parameter is deprecated as of Microsoft® HPC Pack 2012. Use the Location parameter instead.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-DataCenter<String>

Specifies the data center in which the node is located.

This parameter is deprecated as of Microsoft® HPC Pack 2012. Use the Location parameter instead.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the node.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Location<String>

Specifies the location of the node as a string with a format of \<DataCenter>[\<Rack>[\<Chassis>]].

The location must begin with a backslash (\). If you specify the <Rack> part of the string, you must also specify the <DataCenter> part. If you specify the <Chassis> part of the string, you must also specify the <Rack> and <DataCenter> parts. Each part of the string has a maximum length of 256 characters.

If you specify a location string with more than three parts, such as \center1\rack3\chassis5\location7\sublocation9, no error occurs and the location is truncated after the third part of the string. So, the value of \center1\rack3\chassis5\location7\sublocation9 becomes \center1\rack3\chassis5.

This parameter was introduced in HPC Pack 2008 R2.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManagementIpAddress<String>

Specifies an IP address that Intelligent Platform Management Interface (IPMI) tools can use to manage power on the node. The format of the value for this parameter is the same as the format of a valid IP address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for the nodes for which you want to change the properties. You cannot specify both the Name and Node parameters.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

Specifies an array of HpcNode objects for the nodes for which you want to change the properties. Use the Get-HpcNode cmdlet to get the HpcNode object for a node. You cannot specify both the Node and the Name parameters.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ProductKey<String>

Specifies the product key for Windows Server 2008 to use when you provision the node. The product key should be in the format of xxxxx-xxxxx-xxxxx-xxxxx-xxxxx, where x is a letter of either case or a digit.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Rack<String>

Specifies a rack position for the node. If you specify the Rack parameter, you must also specify the DataCenter parameter.

This parameter is deprecated as of Microsoft® HPC Pack 2012. Use the Location parameter instead.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Role<NodeRole[]>

Specifies an array of roles for the node. Valid values are:

-- None
-- ComputeNode
-- BrokerNode
-- WorkstationNode

You muset take a node offline before you can change the role of the node. Use the Set-HpcNodeState cmdlet to take nodes offline.


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

-SubscribedCores<UInt32]>

Specifies the number of cores that you want the HPC job scheduler service to use when it is allocating tasks to the node. This value may be smaller than, or exceed the number of physical cores. To clear this property, set the value to $Null. If this value is $Null, the number of physical cores is used.

You should ensure that the number of subscribed cores is divisible by the number of subscribed sockets. Therefore, each socket must have the same number of cores (for example 4 cores and 2 sockets are valid, but 10 cores and 4 sockets are not).

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SubscribedSockets<UInt32]>

Specifies the number of sockets that the HPC job scheduler service should use when it is allocating tasks to the node. This value may be smaller than, or exceed the number of actual physical sockets. To clear this property, set the value to $Null.

You should ensure that the number of subscribed cores is divisible by the number of subscribed sockets. Therefore, each socket must have the same number of cores (for example 4 cores and 2 sockets is valid, but 10 cores and 4 sockets is not).

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.


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.

  • HpcNode[]

Outputs

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

  • HpcNode[]

Notes

  • This DataCenter, Rack, and Chassis parameters are deprecated as of HPC Pack 2012. Use the Location parameter instead.

  • If you specify the Location parameter for a node when you run Set-HpcNode, the DataCenter, Rack, and Chassis properties of the HpcNode object for the node do not get set. If you specify the DataCenter, Rack, or Chassis parameter when you run Set-HpcNode, the Location property of the HpcNode object for the node is set to the equivalent location string.

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

Examples

Example 1: Set the description for a node: Set the description for a node

This command sets the description for the node named hpc01cn01 to Test Node.


PS C:\> Set-HpcNode -Name "hpc01cn01" -Description "Test Node"

Example 2: Set the location for multiple nodes: Set the location for multiple nodes

This command sets the data center to East for all nodes with names that start with hpc01.


PS C:\> Set-HpcNode -Name "hpc01*" -DataCenter "East"

Example 3: Set the location for a node: Set the location for a node

This command sets the location of the node named ComputeNode02 to \center4\rack3\chassis26.


PS C:\> Set-HpcNode -Name "ComputeNode02" -Location "\center4\rack3\chassis26"

Example 4: Get nodes by group name and set their roles: Get nodes by group name and set their roles

This command gets the HpcNode objects for all nodes in the node group named Broker, and sets the roles for those nodes to BrokerNode.


PS C:\> Get-HpcNode -GroupName "Broker" | Set-HpcNode -Role BrokerNode

Related topics

Community Additions

ADD
Show: