.png)
Remove-HpcNodeTemplate
Deletes one or more specified node templates from the HPC cluster.
Syntax
Remove-HpcNodeTemplate [-Scheduler <string>] [-Name] <string[]> [-confirm] [-whatif] [<CommonParameters>] Remove-HpcNodeTemplate [-Scheduler <string>] -Template <HpcNodeTemplate[]> [-confirm] [-whatif] [<CommonParameters>]
Detailed Description
Deletes one or more specified node templates from the HPC cluster.
Parameters
-Name <string[]>
Specifies a list of one or more names of the node templates that you want to delete. You cannot specify both the Name and Template parameters.
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-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>
|
Required? |
false |
|
Position? |
named |
|
Default Value |
%CCP_SCHEDULER% |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Template <HpcNodeTemplate[]>
Specifies a list of one or more 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.
|
Required? |
true |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
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 |
none |
|
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.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
|
Input Type |
One or more HpcNodeTemplate objects. |
|
Return Type |
None. |
Notes
You need to 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.
Example 1
C:\PS>Remove-HpcNodeTemplate -Name MyNodeTemplate
Deletes the node template named MyNodeTemplate.
Example 2
C:\PS>Get-HpcNodeTemplate -Name MyTemplate* | Remove-HpcNodeTemplate -WhatIf
Gets the HpcNodeTemplate objects for the node templates that have names that begin with MyTemplate, then describes what would happen if you redirected those objects to serve as input for the Remove-HpcNodeTemplate cmdlet.
