Restart-HpcNode

Restart-HpcNode

Restarts one or more nodes that are already turned on.

Syntax

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

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

Detailed Description

Restarts one or more nodes that are already turned on. By default, this cmdlet sends a shutdown command to the operating system, but computer vendors can change the configuration to add commands based on Intelligent Platform Management Interface (IPMI).

Parameters

-Comment<String>

Specifies a comment for restarting the node. This comment is recorded in the event log.

Aliases

none

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies a list of the names of the nodes that you want to restart. 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 the HpcNode objects for the nodes that you want to restart. 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

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

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

Restarts a node named hpc01cn01 and adds a comment for restarting.

PS C:\>Restart-HpcNode -Name hpc01cn01 -Comment "Restarting for maintenance."

EXAMPLE 2

Gets HpcNode objects for all of the nodes associated with the node template named applicationA, and restarts those nodes. When you use certain templates for provisioning, you may need to restart the nodes.

PS C:\>Get-HpcNode -TemplateName applicationA | Restart-HpcNode

Get-HpcNode

Shutdown-HpcNode

Start-HpcNode