Shutdown-HpcNode
Turns off one or more nodes.
Syntax
Name (Default)
Shutdown-HpcNode
[-Name] <String[]>
[-Comment <String>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Node
Shutdown-HpcNode
-Node <HpcNode[]>
[-Comment <String>]
[-ClusterConnectionString <String[]>]
[-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
-ClusterConnectionString
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Comment
Specifies a comment that provides a reason that you turned off the nodes.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | HpcNode[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Node
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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\>
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
HpcNode
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-Confirmor-Confirm:$True. - You must be a cluster administrator to run this cmdlet successfully.