Set-HpcNode

Changes the properties for one or more nodes, including the description, data center, rack, chassis, location, roles, and product key for the nodes.

	Copy Code
Parameter Set: Name Set-HpcNode [-Name] <String[]> [-Chassis <String> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeCommand.NodeRole[]> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: Node Set-HpcNode -Node <HpcNode[]> [-Chassis <String> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeCommand.NodeRole[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Name


Set-HpcNode [-Name] <String[]> [-Chassis <String> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeCommand.NodeRole[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: Node


Set-HpcNode -Node <HpcNode[]> [-Chassis <String> ] [-DataCenter <String> ] [-Description <String> ] [-Location <String> ] [-ManagementIpAddress <String> ] [-ProductKey <String> ] [-Rack <String> ] [-Role <NodeCommand.NodeRole[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Changes the properties for one or more nodes, including the description, data center, rack, chassis, location, roles, and product key for the nodes.

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

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DataCenter<String>

Specifies the data center in which the data center is located.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Description<String>

Specifies a description for the node.

Aliases	none
Required?	false
Position?	named
Default Value	no default
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 is supported only for Windows HPC Server 2008 R2.

Aliases	none
Required?	false
Position?	named
Default Value	no default
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	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies a list 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	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Node<HpcNode[]>

Specifies a list 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	no default
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	no default
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.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Role<NodeCommand.NodeRole[]>

Specifies a role for the node. You can set the role to one of the following values: None, ComputeNode, BrokerNode, or WorkstationNode. You need to 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	no default
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	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

The input type is the type of the objects that you can pipe to the cmdlet.

One or more HpcNode objects.

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

One or more HpcNode objects.

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.

EXAMPLE 1

Sets the description for the node named hpc01cn01 to test node.

	Copy Code
Set-HpcNode -Name hpc01cn01 -Description "test node"

EXAMPLE 2

Sets the data center to east for all nodes with names that start with hpc01.

	Copy Code
Set-HpcNode -Name hpc01* -DataCenter "east"

EXAMPLE 3

Sets the location of the node named ComputeNode2 to \center4\rack3\chassis26.

	Copy Code
Set-HpcNode -Name ComputeNode2 -Location "\center4\rack3\chassis26"

EXAMPLE 4

Gets the HpcNode objects for all nodes in the node group named broker, and sets the roles for those nodes to BrokerNode.

	Copy Code
Get-HpcNode -GroupName broker \| Set-HpcNode -Role BrokerNode

Microsoft.ComputeCluster.CCPPSH.Get-HpcNode
Microsoft.ComputeCluster.CCPPSH.Remove-HpcNode
Microsoft.ComputeCluster.CCPPSH.Set-HpcNodeState

Set-HpcNode

Syntax

Detailed Description

Parameters