PowerCLI Reference

Set-CIVAppTemplate

Synopsis

This cmdlet modifies the configuration of the specified vApp template.

Syntax

Set-CIVAppTemplate [-VAppTemplate] <CIVAppTemplate[]> [-Description <String>] [-Name <String>] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-CIVAppTemplate [-VAppTemplate] <CIVAppTemplate[]> [-Server <CIServer[]>] [-StorageLease <TimeSpan>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-CIVAppTemplate
New-CIVAppTemplate
Import-CIVAppTemplate
Remove-CIVAppTemplate

Detailed Description

This cmdlet modifies the configuration of the specified vApp template.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VAppTemplateCIVAppTemplate[]Specifies the vApp template you want to modify.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
DescriptionStringSpecifies a new description for the vApp template you want to modify.falseFalse
NameStringSpecifies a new name for the vApp template you want to modify.falseFalse
ServerCIServer[]Specifies the cloud 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 the Connect-CIServer cmdlet.falseFalse
StorageLeaseTimeSpanSpecifies the maximum amount of time for the vApp to remain stopped before vCloud Director automatically marks it as expired, or deletes it, depending on the organization policy. To specify that the lease is unlimited, pass $null.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more modified CIVAppTemplate objects

Notes

Examples

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

$timeSpan = New-Object System.Timespan 1,2,3 #one hour, two minutes, three seconds
Set-CIVAppTemplate -VAppTemplate 'MyVAppTemplate' -StorageLease $timeSpan

Modifies the storage lease for the specified vApp template to one hour, two minutes, and three seconds.

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

Get-CIVAppTemplate -Name 'MyVAppTemplate' | Set-CIVAppTemplate -Name 'MyNewVAppTemplateName' -Description 'The name and description of this vApp template have been modified.'

Modifies the name and description of the specified vApp template.


Copyright © VMware, Inc. All rights reserved.