vSphere PowerCLI Reference

New-VApp

Synopsis

Creates a new virtual appliance.

Syntax

New-VApp -Location <VIContainer> [-Name] <String> [-CpuExpandableReservation [<Boolean>]] [-CpuLimitMhz <Int64>] [-CpuReservationMhz <Int64>] [-CpuSharesLevel <SharesLevel>] [-MemExpandableReservation [<Boolean>]] [-MemLimitMB <Int64>] [-MemReservationMB <Int64>] [-MemSharesLevel <SharesLevel>] [-NumCpuShares <Int32>] [-NumMemShares <Int32>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]
New-VApp -Location <VIContainer> [[-Name] <String>] -VApp <VApp> [-VMHost <VMHost>] [-Datastore <Datastore>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Export-VApp
Get-VApp
Import-VApp
Remove-VApp
Set-VApp
Start-VApp
Stop-VApp
Move-VApp

Detailed Description

Creates a new virtual appliance.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a name for the new virtual appliance.truefalse
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$true
CpuExpandableReservationBooleanIndicate that the CPU reservation can grow beyond the specified value if there are available resources.falsefalse
CpuLimitMhzInt64Specify a CPU usage limit in MHz. Utilization will not exceed this limit even if there are available resources.falsefalse
CpuReservationMhzInt64Specify the CPU size in MHz that is guaranteed to be available.falsefalse
CpuSharesLevelSharesLevelSpecify the CPU allocation level for this virtual appliance. This property is used in relative allocation between resource consumers. The valid values are Custom, High, Low, and Normal.falsefalse
DatastoreDatastoreSpecify the datastore where you want to store the copied virtual appliance. If you do not specify a datastore, the cmdlet takes the first datastore of the host or cluster.falsefalse
LocationVIContainerSpecify a VApp, ResourcePool, VMHost, or Cluster object where you want to place the new virtual appliance.truetrue (ByValue)
MemExpandableReservationBooleanIf the value is $true, the memory reservation can grow beyond the specified value if there are available resources.falsefalse
MemLimitMBInt64Specify a memory usage limit in MB. Utilization will not exceed this limit even if there are available resources.falsefalse
MemReservationMBInt64Specify the size of the memory in MB that is guaranteed to be available.falsefalse
MemSharesLevelSharesLevelSpecify the memory allocation level for this virtual appliance. This property is used in relative allocation between resource consumers. The valid values are Custom, High, Low, and Normal.falsefalse
NumCpuSharesInt32Specify the CPU allocation level for this virtual appliance. This property is used in relative allocation between resource consumers. This parameter is ignored unless the CpuSharesLevel parameter is set to Custom.falsefalse
NumMemSharesInt32Specify the memory allocation level for this virtual appliance. This property is used in relative allocation between resource consumers. This parameter is ignored unless the MemSharesLevel parameter is set to Custom.falsefalse
RunAsyncSwitchParameterIndicate 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
ServerVIServer[]Specify 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
VAppVAppSpecify a virtual appliance you want to copy.falsetrue (ByValue)
VMHostVMHostSpecify the host where you want to run the copied virtual appliance.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

vApp

Notes

Examples

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

New-VApp -Name VApp -CpuLimitMhz 4000 -CpuReservationMhz 1000 -Location Host

Creates a new virtual appliance on the Host host.


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