powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Template



NAME
Set-Template

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

SYNTAX
Set-Template [-Template] [-Name ] [-ToVM] [-Server ] [-RunAsync] [-WhatIf] [-Confi
rm] []


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.


PARAMETERS
-Template
Specify the template whose properties you want to change.

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

-Name
Specify a new name of the template.

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

-ToVM
Indicate that the template is to be converted to a virtual machine.

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

-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

-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
Template or VirtualMachine


NOTES




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

C:\PS>Set-Template -Template $template -Name Template2


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





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

C:\PS>$vm = Set-Template -Template $template -ToVM


Converts a template to a virtual machine.






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