PowerCLI Reference

Import-CIVApp

Synopsis

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

Syntax

Import-CIVApp [-VM] <VirtualMachine> [-ComputerName <String>] [-Description <String>] [-Name <String>] [-VMName <String>] [-NoCopy] [-RunAsync] [-Server <CIServer[]>] -OrgVdc <OrgVdc> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Import-CIVApp [-VM] <VirtualMachine> [-ComputerName <String>] [-VMName <String>] [-NoCopy] [-RunAsync] [-Server <CIServer[]>] -VApp <CIVApp> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-CIVApp
Get-CloudVAppTempate
Import-CloudVAppTempate

Detailed Description

This cmdlet imports a virtual machine from the underlying vSphere to the cloud as a vApp. You can import the virtual machine to an already existing vApp or create a new vApp and import the virtual machine into it. Note: This cmdlet is only available to Provider Administrators.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachineSpecifies the virtual machine you want to import into the cloud. This parameter accepts VirtualMachine objects retrieved from a vCenter Server that has already been registered with vCloud Director.truetrue (ByValue)
ComputerNameStringSpecifies a computer name for the imported virtual machine.falsefalse
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 description for the imported virtual machine.falsefalse
InformationActionActionPreferencefalsefalse
InformationVariableStringfalsefalse
NameStringSpecifies the name of the new vApp that you want to create by importing the selected vSphere virtual machine. If you do not set a name, the newly created vApp inherits the name of the imported virtual machine.falsefalse
NoCopySwitchParameterUse this parameter if you want to import the original vSphere virtual machine. Otherwise, a copy of the virtual machine is imported in vCloud Director. Importing the original vSphere virtual machine might cause its modification.falsefalse
OrgVdcOrgVdcSpecifies the organization vDC to which you want to import the virtual machine.truetrue (ByValue)
PipelineVariableStringfalsefalse
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
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 Connect-CIServer.falsefalse
VAppCIVAppSpecifies the vApp into which you want to import the virtual machine.truetrue (ByValue)
VMNameStringSpecifies a new name for the virtual machine that you want to import into a vApp. If you do not set a name, the virtual machine is imported with its original name.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

The CIVApp object that represents the imported vApp

Notes

Examples

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

Get-OrgVdc 'MyOrganizationVdc' | Import-CIVApp -VM (Get-VM 'MyVMToImport')

Imports a virtual machine from vSphere into a new cloud virtual appliance.

Note: You must be connected to a vCenter Server and a vCloud Director server.

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

(Get-VM 'MyVMToImport') | Import-CIVApp -OrgVdc 'MyOrganizationVdc' -Name 'MyNewVApp' -Description "My New VApp Description" -ComputerName "MyComputer"

Imports a virtual machine from vSphere into a new cloud virtual appliance (Vapp) while specifying the new VApp name, its description and the virtual machine computer name.

Note: You must be connected to a vCenter Server and a vCloud Director server.

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

Import-CIVApp -VM (Get-VM 'MyVMToImport') -OrgVdc 'MyOrganizationVdc' -NoCopy

Imports a virtual machine from vSphere into a new cloud virtual appliance by moving it instead of copying it.

Note: You must be connected to a vCenter Server and a vCloud Director server.

-------------- Example 4 --------------

Import-CIVApp -VM (Get-VM 'MyVMToImport') -VApp 'MyVAppToExtend'

Imports a virtual machine from vSphere into an existing cloud virtual appliance.

Note: You must be connected to a vCenter Server and a vCloud Director server.

-------------- Example 5 --------------

Get-CIVApp "MyVAppToExtend" | Import-CIVApp (Get-VM 'MyVMToImport') -NoCopy

Imports a VM from vSphere into an existing cloud VApp by moving it instead of copying it.

Note: You must be connected to a vCenter Server and a vCloud Director server.


Copyright © VMware, Inc. All rights reserved.