Set-Template
This cmdlet 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.
Syntax
-Template
<Template[]>
[-Name <String>]
[-RunAsync]
[-Server <VIServer[]>]
[-ToVM]
[CommonParameters]
[-Name <String>]
[-RunAsync]
[-Server <VIServer[]>]
[-ToVM]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
Template[] | named |
|
Specifies the template whose properties you want to change. | optional |
|
String | named |
|
Specifies a new name for the template. | optional |
|
SwitchParameter | named |
|
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. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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. | optional |
|
SwitchParameter | named |
|
Indicates that the template is to be converted to a virtual machine. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.Template
Examples
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.
Related Commands
Template
This cmdlet retrieves the virtual machine templates available on a vCenter Server system.
This cmdlet moves virtual machine templates to another location.
This cmdlet modifies the specified virtual machine template.
This cmdlet removes the specified virtual machine templates from the inventory.
This cmdlet creates a new virtual machine template.
