< Back

Remove-Template

Sun Jan 19, 2020 7:05 pm

NAME 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>]





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

-DeletePermanently [<SwitchParameter>]

Indicates that you want to delete the templates not only from the inventory, but from the datastore as well.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-RunAsync [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Server <VIServer[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Template <Template[]>

Specifies the virtual machine templates you want to remove.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Confirm [<SwitchParameter>]

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



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

None







NOTES









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



Remove-Template -Template $template



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... plate.html

Get-Template

New-Template

Set-Template