PowerCLI Reference

Set-CIVApp

Synopsis

This cmdlet modifies the configuration of the specified vApps in the cloud.

Syntax

Set-CIVApp [-VApp] <CIVApp[]> [-Description <String>] [-Name <String>] [-Owner <CIUser>] [-RunAsync] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-CIVApp [-VApp] <CIVApp[]> -DiscardSuspendedState [-RunAsync] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-CIVApp [-VApp] <CIVApp[]> -RenewLease [-RuntimeLease <TimeSpan>] [-Server <CIServer[]>] [-StorageLease <TimeSpan>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-CIVApp
Import-CIVApp
New-CIVApp
Remove-CIVApp
Start-CIVApp
Stop-CIVApp
Restart-CIVApp
Suspend-CIVApp

Detailed Description

This cmdlet modifies the configuration of the specified vApps in the cloud.

Parameters

Name	Type	Description	Required?	Pipeline Input
VApp	CIVApp[]	Specifies the vApp that you want to configure.	true	True (ByValue)
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.	false	False
Description	String	Specifies a description for the vApp you want to configure.	false	False
DiscardSuspendedState	SwitchParameter	Indicates that you want to discard the suspended state of the specified vApp and all its virtual machines.	true	False
Name	String	Specifies a new name for the vApp you want to configure.	false	False
Owner	CIUser	Specifies a new owner for the vApp you want to configure.	false	False
RenewLease	SwitchParameter	Indicates that you want to renew the leases of the vApp. Specifying the RenewLease parameter resets the current values of the RuntimeLease and StorageLease parameters.	true	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.	false	False
RuntimeLease	TimeSpan	Specifies the maximum running time for the vApp before vCloud Director stops it automatically. If you do not specify this parameter, the current value is reset. To specify that the lease is unlimited, pass $null.	false	False
Server	CIServer[]	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 Connect-CIServer.	false	False
StorageLease	TimeSpan	Specifies 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. If you do not specify this parameter, the current value is reset. To specify that the lease is unlimited, pass $null.	false	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	False

Return Type

Zero or more modified CIVApp objects

Notes

Examples

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

$myVApps = Get-CIVApp -Name 'MyVApp*'
$myVApps | Set-CIVApp -Description 'This is one of my VApps.'

Retrieves all vApp with names starting with MyVapp and changes their descriptions to "This is one of my vApps."

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

Set-CIVApp -VApp 'MyVApp*' -DiscardSuspendedState

Discards the suspended state for all vApps with names starting with MyVapp.

-------------------------- Example 3 --------------------------

$runtimeTimeSpan = New-Object System.Timespan 1,2,3 #one hour, two minutes, three seconds
Set-CIVApp -VApp 'myVApp*' -RenewLease -RuntimeLease $runtimeTimeSpan

Renews the runtime lease for all vApps with names starting with MyVapp and sets the runtime lease to one hour, two minutes and three seconds.