Exports a virtual appliance to the provided destination.


Export-VApp [[-Destination] <String>] [-VApp] <VApp[]> [-Name <String>] [-Force] [-CreateSeparateFolder] [-Description <String>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands


Detailed Description

Exports a virtual appliance to the provided destination. If no destination is specified, the cmdlet creates a new folder in the current working directory and exports the virtual appliance to it. The name of the new folder is the same as the name of the virtual appliance as it appears in vCenter.


NameDescriptionRequired?Pipeline InputDefault Value
DestinationSpecify a destination path to the file system location where you want to export the virtual appliances.falsefalse
VAppSpecify the virtual appliance you want to export.truetrue (ByValue)
NameSpecify a name for the exported virtual appliances.falsefalse
ForceIndicate whether the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.falsefalse
CreateSeparateFolderIndicate that you want to create a separate folder for each virtual appliance.falsefalse
DescriptionProvide a description of the exported virtual appliance.falsefalse
ServerSpecify the vSphere 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-VIServer.falsefalse
RunAsyncIndicate 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 vSphere PowerCLI console.falsefalse
WhatIfIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse
ConfirmIndicate that the cmdlet asks for confirmation before running.falsefalse

Input Type

Return Type




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

C:\PS>Get-VApp myVApp* | Export-VApp "c:\vapps\"

Retrieves all virtual appliances whose names start with "myVApp" and exports the
m to the specified path.

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

C:\PS>Export-VApp "c:\NewFolder\" $vApp -Name "EMail_vApp" -Force

Exports the virtual appliances in the $vApp variable to the specified location a
nd assigns a name to the folder.

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

C:\PS>Export-VApp -vApp $vApp -Destination "c:\vapps\myVapp\" -Force -CreateSepa

Exports the virtual appliances in the $vApp variable to the specified location w
ithout creating a separate folder for each virtual appliance.

Copyright © 1998 - 2009 VMware, Inc. All rights reserved.