Restart-HpcNode

  • Reference
Module:
HPCPack2016

Restarts a node that is already turned on.

Syntax

Restart-HpcNode
       [-Comment <String>]
       [-Name] <String[]>
       [-ClusterConnectionString <String[]>]
       [-Scheduler <String[]>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restart-HpcNode
       [-Comment <String>]
       -Node <HpcNode[]>
       [-ClusterConnectionString <String[]>]
       [-Scheduler <String[]>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Restart-HpcNode cmdlet 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).

Examples

Example 1: Restart a node by name

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

This command restarts a node named hpc01cn01 and adds a comment for restarting.

Example 2: Get nodes by template and restart them

PS C:\>Get-HpcNode -TemplateName "ApplicationA" | Restart-HpcNode

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

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Comment

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

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

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

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.