Set-CIVApp Command | Vmware PowerCLI Reference

Set-CIVApp

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[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VApp CIVApp[] named
  • pipeline
Specifies the vApp that you want to configure.
optional Description String named
Specifies a description for the vApp you want to configure.
optional Name String named
Specifies a new name for the vApp you want to configure.
optional Owner CIUser named
Specifies a new owner for the vApp you want to configure.
optional RunAsync 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 Server CIServer[] named
Specifies the cloud servers 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-CIServer.
Set-CIVApp
-DiscardSuspendedState
-VApp < CIVApp[] >
[-RunAsync ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DiscardSuspendedState SwitchParameter named
Indicates that you want to discard the suspended state of the specified vApp and all its virtual machines.
required
VApp CIVApp[] named
  • pipeline
Specifies the vApp that you want to configure.
optional RunAsync 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 Server CIServer[] named
Specifies the cloud servers 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-CIServer.
Set-CIVApp
-RenewLease
-VApp < CIVApp[] >
[-RuntimeLease < TimeSpan > ]
[-Server < CIServer[] > ]
[-StorageLease < TimeSpan > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
RenewLease SwitchParameter named
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.
required
VApp CIVApp[] named
  • pipeline
Specifies the vApp that you want to configure.
optional RuntimeLease TimeSpan named
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.
optional Server CIServer[] named
Specifies the cloud servers 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-CIServer.
optional StorageLease TimeSpan named
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.

Output

VMware.VimAutomation.Cloud.Types.V1.CIVApp

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.

Related Commands

CIVApp

This cmdlet retrieves virtual appliances in the cloud.

This cmdlet imports a virtual machine from the underlying vSphere to the cloud.

This cmdlet creates a new vApp.

This cmdlet removes vApps from the cloud.

This cmdlet restarts the specified vApp.

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

This cmdlet starts the specified vApp.

This cmdlet stops the specified vApp.

This cmdlet suspends the specified vApp.

CIVAppGuest

This cmdlet restarts the guest operating systems of all virtual machines in the specified vApp.

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

CIVAppNetwork

This cmdlet retrieves the vApp networks available on a vCloud Director server.

This cmdlet creates a new vApp network.

This cmdlet removes the specified vApp networks if they are not in use.

This cmdlet modifies the configuration of the specified vApp networks.

CIVAppStartRule

This cmdlet retrieves the start rules for virtual machines in a specified vApp.

This cmdlet modifies the start rules for virtual machines in the specified vApp.

CIVAppTemplate

This cmdlet retrieves vApp templates.

This cmdlet imports a virtual machine or an OVF package from vCenter Server to vCloud Director as a vApp template.

This cmdlet creates a new vApp template.

This cmdlet removes the specified vApp template.

This cmdlet modifies the configuration of the specified vApp template.