PowerCLI Reference

Remove-Template

Synopsis

This cmdlet removes the specified virtual machine templates from the inventory.

Syntax

Remove-Template [-Template] <Template[]> [-DeletePermanently] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-Template
New-Template
Set-Template

Detailed Description

This cmdlet removes the specified virtual machine templates from the inventory. If the value of the DeletePermanently parameter is $true, the cmdlet removes the templates from the inventory and deletes them from the disk.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TemplateTemplate[]Specifies the virtual machine templates you want to remove.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
DeletePermanentlySwitchParameterIndicates that you want to delete the templates not only from the inventory, but from the datastore as well.falseFalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

None

Notes

Examples

-------------------------- Example 1 --------------------------

Remove-Template -Template $template

Removes the virtual machine template saved in the $template variable.


Copyright © VMware, Inc. All rights reserved.