vSphere PowerCLI Reference



Changes the name and the description of a virtual machine template.


Set-Template [-Template] <Template[]> [-Name <String>] [-ToVM] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version

Detailed Description

Changes the name and the description of a virtual machine template according to the provided parameters. The cmdlet can convert the template to a virtual machine if the value of the ToVM parameter is $true.


NameTypeDescriptionRequired?Pipeline InputDefault Value
TemplateTemplate[]Specify the template whose properties you want to change.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
NameStringSpecify a new name of the template.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
ToVMSwitchParameterIndicate that the template is to be converted to a virtual machine.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

Template or VirtualMachine



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

Set-Template -Template $template -Name Template2

Renames the template saved in the $template variable to Template2.

-------------- Example 2 --------------

$vm = Set-Template -Template $template -ToVM

Converts a template to a virtual machine.

Copyright © 1998 - 2011 VMware, Inc. All rights reserved.