Remove-HpcNodeTemplate

Remove-HpcNodeTemplate

Deletes node templates from the HPC cluster.

Syntax

Parameter Set: Name
Remove-HpcNodeTemplate [-Name] <String[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Template
Remove-HpcNodeTemplate -Template <HpcNodeTemplate[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

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

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

-Name<String[]>

Specifies an array of names of the node templates that you want to delete. You cannot specify both the Name and Template parameters.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Template<HpcNodeTemplate[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

  • HpcNodeTemplate[]

Outputs

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

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

Examples

Example 1: Remove a template by name

This command deletes the node template named MyNodeTemplate.


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

Example 2: Get node templates by name and remove them

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.


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

Related topics

Community Additions

ADD
Show: