powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Template



NAME
Remove-Template

SYNOPSIS
Removes the specified virtual machine templates from the inventory.

SYNTAX
Remove-Template [-Template] [-DeletePermanently] [-RunAsync] [-Server ] [-WhatIf] [-Confir
m] []


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
-Template
Specify the virtual machine templates you want to remove.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

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

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
None


NOTES




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

C:\PS>Remove-Template -Template $template


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Remove-Template.html
Get-Template
New-Template
Set-Template