Set-HpcNodeState
Set-HpcNodeState
Sets the state of one or more nodes to online, offline, or rejected.
Syntax
Parameter Set: Name
Set-HpcNodeState [-Name] <String[]> -State <String> [-Async] [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Node
Set-HpcNodeState -Node <HpcNode[]> -State <String> [-Async] [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Sets the state of one or more nodes to online, offline, or rejected.
Parameters
-Async
Specifies that the cmdlet should return immediately without waiting for the specified state to take effect.
This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Forces the node to go offline without going into the draining state first. You can only use this parameter when you specify Offline for the State parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies a list of the names of the nodes for which you want to change the state. 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 one or more HpcNode objects for the nodes for which you want to change the state. Use the Get-HpcNode cmdlet to get the HpcNode object for a node. You cannot specify both the Node and Name parameters.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
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 |
-State<String>
Specifies the new state that you want to assign to the nodes. The possible states that you can specify are Online, Offline, and Rejected.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
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
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- One or more HpcNode objects if the Async parameter is not specified, or one or more HpcWorkItem objects if the Async parameter is specified
Outputs
The output type is the type of the objects that the cmdlet emits.
- One or more HpcNode objects
Notes
If you set the state of a node to offline, the node can take a long time to go offline if jobs are running on the node. If any of the jobs have the Run until canceled property set, the operation to take the node offline does not return. Cancel such jobs before you set the state of the node to Offline.
The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$false. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$true.
You must be a cluster administrator to run this cmdlet successfully.
Examples
EXAMPLE 1
Sets the state of the node named MyNode to Online.
PS C:\>Set-HpcNodeState -Name MyNode -State Online
EXAMPLE 2
Forces the node named MyNode2 into the offline state, without going into the draining state first.
PS C:\>Set-HpcNodeState -Name MyNode2 -State Offline -Force
EXAMPLE 3
Sets the state for the nodes named MyNode3 and MyNode4 to Offline, and returns without waiting for the state changes to take effect.
PS C:\>Set-HpcNodeState -Name MyNode3,MyNode4 -State Offline -Async
EXAMPLE 4
Gets the HpcNode objects for the nodes in the node group named MyTestNodes, and sets the state for those nodes to Offline.
PS C:\>Get-HpcNode -GroupName MyTestNodes | Set-HpcNodeState -State Offline