Remove-HpcNodeTemplate

  • Reference
Module:
HPCPack2016

Deletes node templates from the HPC cluster.

Syntax

Remove-HpcNodeTemplate
      [-Name] <String[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-HpcNodeTemplate
      -Template <HpcNodeTemplate[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-HpcNodeTemplate cmdlet deletes one or more specified node templates from the HPC cluster.

Examples

Example 1: Remove a template by name

PS C:\>Remove-HpcNodeTemplate -Name "MyNodeTemplate"

This command deletes the node template named MyNodeTemplate.

Example 2: Get node templates by name and remove them

PS C:\>Get-HpcNodeTemplate -Name "MyTemplate*" | Remove-HpcNodeTemplate -WhatIf

Gets the HpcNodeTemplate objects for the node templates that have names that begin with MyTemplate, and then describes what would happen if you redirected those objects to serve as input for the Remove-HpcNodeTemplate cmdlet.

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

-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 names of the node templates that you want to delete. You cannot specify both the Name and Template parameters.

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

-Scheduler

Specifies the host name or IP address of the head node for the cluster that includes the node templates. 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

-Template

Specifies an array of HpcNodeTemplate objects for the node templates that you want to delete. Use the Get-HpcNodeTemplate cmdlet to get the HpcNodeTemplate objects for the node templates. You cannot specify both the Template and Name parameters.

Type:HpcNodeTemplate[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

HpcNodeTemplate[]

Outputs

None

Notes

  • You must remove any associations between a node template and all of the nodes in the HPC cluster before you can delete the node template. Use the Assign-HpcNodeTemplate cmdlet to assign a new node template to a node, thus removing the association between the node and the node template that was previously associated with the node.
  • The built-in ConfirmImpact setting for this cmdlet is Medium. 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.