Shutdown-HpcNode
Turns off one or more nodes.
Syntax
Shutdown-HpcNode
[-Comment <String>]
[-Name] <String[]>
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Shutdown-HpcNode
[-Comment <String>]
-Node <HpcNode[]>
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Shutdown-HpcNode cmdlet turns off one or more nodes. If you do not have an Intelligent Platform Management Interface (IPMI) script that your computer vendor configured, you may not be able to start the node again remotely. By default, this cmdlet sends a shutdown command to the operating system, but computer vendors can change the configuration to add IPMI-based commands.
Examples
Example 1: Shut down the nodes in a group
PS C:\>Get-HpcNode -GroupName "Old" | Shutdown-HpcNode
This command gets the HpcNode objects for all nodes in the node group named Old and shuts down those nodes.
Example 2: Shut down a node by name
PS C:\>Shutdown-HpcNode -Name "MyComputeNode"
This command shuts down the node named MyComputeNode.
Parameters
-Comment
Specifies a comment that provides a reason that you turned off the nodes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies an array of the names of the nodes that you want to turn off. You cannot specify both the Name and Node parameters.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Node
Specifies an array of HpcNode objects that correspond to the nodes that you want to turn off. Use the Get-HpcNode cmdlet to get an HpcNode object for a node. You cannot specify both the Node and Name parameters.
Type: | HpcNode[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scheduler
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\>
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
HpcNode[] objects
Outputs
None
Notes
- The built-in ConfirmImpact setting for this cmdlet is High. 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.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for