vSphere PowerCLI Reference

Remove-Template

Synopsis

Removes the specified virtual machine templates from the inventory.

Syntax

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

Related Commands

Online version
Get-Template
New-Template
Set-Template

Detailed Description

Removes the specified virtual machine templates from the inventory. If the value of the DeletePermanently parameter is $true, the cmdlet not only removes the templates from the inventory, but also deletes them from the disk.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TemplateTemplate[]Specify 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$true
DeletePermanentlySwitchParameterIndicate that you want to delete the templates not only from the inventory, but from the datastore as well.falsefalse
RunAsyncSwitchParameterIndicate 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 vSphere PowerCLI console.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
WhatIfSwitchParameterIndicate 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 © 1998 - 2012 VMware, Inc. All rights reserved.