Shutdown-HpcNode

Shutdown-HpcNode

Turns off one or more nodes.

Syntax

Parameter Set: Name
Shutdown-HpcNode [-Name] <String[]> [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Node
Shutdown-HpcNode -Node <HpcNode[]> [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




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

Parameters

-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

-Comment<String>

Specifies a comment that provides a reason that you turned off the nodes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of the names of the nodes that you want to turn off. 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 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.


Aliases

none

Required?

true

Position?

named

Default Value

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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[] objects

Outputs

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

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

Examples

Example 1: Shut down the nodes in a group

This command gets the HpcNode objects for all nodes in the node group named Old and shuts down those nodes.


PS C:\> Get-HpcNode -GroupName "Old" | Shutdown-HpcNode

Example 2: Shut down a node by name

This command shuts down the node named MyComputeNode.


PS C:\> Shutdown-HpcNode -Name "MyComputeNode"

Related topics

Community Additions

ADD
Show: