PowerCLI Reference

Remove-VApp

Synopsis

This cmdlet removes vApps from the server.

Syntax

Remove-VApp [-VApp] <VApp[]> [-DeletePermanently] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Export-VApp
Get-VApp
Import-VApp
New-VApp
Set-VApp
Start-VApp
Stop-VApp
Move-VApp

Detailed Description

This cmdlet removes vApps from the server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VAppVApp[]Specifies the vApp you want to remove.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
DeletePermanentlySwitchParameterIndicates that you want not only to remove the vApps from the inventory, but also to delete the virtual machines they contain from the datastore.falseFalse
RunAsyncSwitchParameterIndicates 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.falseFalse
ServerVIServer[]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.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

None

Notes

Examples

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

Get-VMHost -Name MyVMHost1 | Get-VApp | Remove-VApp

Retrieves and removes all vApps available on the MyVMHost1 host.


Copyright © VMware, Inc. All rights reserved.