< Back
Set-Template
Post
NAME Set-Template
SYNOPSIS
This cmdlet modifies the specified virtual machine template.
SYNTAX
Set-Template [-Template] <Template[]> [-Name <String>] [-RunAsync] [-Server <VIServer[]>] [-ToVM] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Name <String>
Specifies a new name for the template.
Required? false
Position? named
Default value None
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 given 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 template whose properties you want to change.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-ToVM [<SwitchParameter>]
Indicates that the template is to be converted to a virtual machine.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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
Zero or more modified Template objects or zero or more VirtualMachine objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... plate.html
Get-Template
Get-Template
New-Template
Remove-Template
SYNOPSIS
This cmdlet modifies the specified virtual machine template.
SYNTAX
Set-Template [-Template] <Template[]> [-Name <String>] [-RunAsync] [-Server <VIServer[]>] [-ToVM] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Name <String>
Specifies a new name for the template.
Required? false
Position? named
Default value None
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 given 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 template whose properties you want to change.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-ToVM [<SwitchParameter>]
Indicates that the template is to be converted to a virtual machine.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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
Zero or more modified Template objects or zero or more VirtualMachine objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... plate.html
Get-Template
Get-Template
New-Template
Remove-Template