| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
From a technical perspective, a vApp container is a specialized resource pool that has been extended with the following capabilities:
Destroying a vApp
When a vApp is destroyed, all of its virtual machines are destroyed, as well as any child vApps.
The VApp.Delete privilege must be held on the vApp as well as the parent folder of the vApp. Also, the VApp.Delete privilege must be held on any child vApps that would be destroyed by the operation.
Properties
Name | Type | Description |
---|---|---|
childLink* | VirtualAppLinkInfo[] | Deprecated.
As of vSphere API 5.1.
List of linked children.
Since vSphere API 4.1 |
datastore* P | ManagedObjectReference[]
to a Datastore[] |
A collection of references to the subset of datastore objects used by this
vApp.
|
network* P | ManagedObjectReference[]
to a Network[] |
A collection of references to the subset of network objects that
is used by this virtual machine.
|
parentFolder* P | ManagedObjectReference
to a Folder |
A reference to the parent folder in the VM and Template folder hierarchy. This
is only set for a root vApp. A root vApp is a vApp that is not a child of
another vApp.
|
parentVApp* | ManagedObjectReference
to a ManagedEntity |
Reference to the parent vApp.
Since vSphere API 4.1 |
vAppConfig* P | VAppConfigInfo |
Configuration of this package.
|
Properties inherited from ResourcePool | ||
childConfiguration, config, owner, resourcePool, runtime, summary, vm | ||
Properties inherited from ManagedEntity | ||
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
CloneVApp_Task, ExportVApp, PowerOffVApp_Task, PowerOnVApp_Task, SuspendVApp_Task, unregisterVApp_Task, UpdateLinkedChildren, UpdateVAppConfig |
Methods inherited from ResourcePool |
CreateChildVM_Task, CreateResourcePool, CreateVApp, DestroyChildren, ImportVApp, MoveIntoResourcePool, QueryResourceConfigOption, RefreshRuntime, RegisterChildVM_Task, UpdateChildResourceConfiguration, UpdateConfig |
Methods inherited from ManagedEntity |
Destroy_Task, Reload, Rename_Task |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
When invoking this method, the following privilege checks occur:
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
name | xsd:string |
The name of the new vApp.
|
target | ManagedObjectReference
to a ResourcePool |
The parent entity of the new vApp. Must be of type
ResourcePool or VirtualApp.
|
spec | VAppCloneSpec |
Specifies how to clone the vApp.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if there was an error accessing one of the virtual machine files. |
InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
InvalidDatastore | Thrown if the operation cannot be performed on the target datastores. |
InvalidPowerState | Thrown if the vApp is powered on. |
InvalidState | Thrown if the operation cannot be performed because of the vApp's current state. For example, if the virtual machine configuration information is not available, or if the vApp is running. |
MigrationFault | Thrown if it is not possible to migrate one of the virtual machines to the destination. This is typically due to hosts being incompatible, such as mismatch in network polices or access to networks and datastores. Typically, a more specific subclass is thrown. |
NotSupported | Thrown if the operation is not supported by the current agent. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy. |
VmConfigFault | Thrown if one of the virtual machines are not compatible with a destination host. Typically, a specific subclass of this exception is thrown, such as IDEDiskNotSupported. |
Events
Type | |
---|---|
None |
See HttpNfcLease for information on how to use the lease.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a HttpNfcLease | The export lease on this vApp. The export task continues running until the lease is completed or aborted. |
Faults
Type | Description |
---|---|
FileFault | Thrown if there was an error accessing one of the virtual machine files. |
InvalidPowerState | Thrown if the vApp is powered on. |
InvalidState | Thrown if the operation cannot be performed because of the vApp's current state. For example, if the virtual machine configuration information is not available, or if the vApp is running or already powering on. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy. |
Events
Type | |
---|---|
None |
The virtual machines (or child vApps) will be stopped in the order specified in the vApp configuration, if force is false. If force is set to true, all virtual machines are powered-off (in no specific order and possibly in parallel) regardless of the vApp auto-start configuration.
While a vApp is stopping, all power operations performed on sub entities are disabled through the VIM API. They will throw TaskInProgress.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
force | xsd:boolean |
If force is false, the shutdown order in the vApp is
executed. If force is true, all virtual machines are powered-off
(regardless of shutdown order).
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
InvalidPowerState | Thrown if the vApp is not running |
InvalidState | Thrown if the operation cannot be performed because of the vApp's current state. For example, if the vApp is in the process of being started. |
MissingPowerOffConfiguration | Thrown if no vApp powerOff configuration has been specified. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy. |
VAppConfigFault |
Events
Type | |
---|---|
None |
The virtual machines (or sub vApps) will be started in the order specified in the vApp configuration. If the vApp is suspended (@see vim.VirtualApp.Summary.suspended), all suspended virtual machines will be powered-on based on the defined start-up order.
While a vApp is starting, all power operations performed on sub entities are disabled through the VIM API. They will throw TaskInProgress.
In case of a failure to power-on a virtual machine, the exception from the virtual machine power on is returned, and the power-on sequence will be terminated. In case of a failure, virtual machines that are already started will remain powered-on.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if there is a problem accessing the virtual machine on the filesystem. |
InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
InvalidPowerState | Thrown if the vApp is already running |
InvalidState | Thrown if it fails to power on a virtual machine due to no host availability, or unable to access the configuration file of a VM. |
MissingNetworkIpConfig | Thrown if no network configuration exists for the primary network for the vApp. |
NotEnoughLicenses | Thrown if there are not enough licenses to power on one or more virtual machines. |
NotSupported | Thrown if the vApp is marked as a template. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy |
VAppConfigFault | Thrown if a configuration issue on a vApp prevents the power-on. Typically, a more specific fault, MissingPowerOnConfiguration, is thrown. |
VmConfigFault | Thrown if a configuration issue on the vApp or a virtual machine in the vApp prevents the power-on to complete. Typically, a more specific fault, such as InvalidPropertyType is thrown. |
Events
Type | |
---|---|
None |
Suspends all powered-on virtual machines in a vApp, including virtual machines in child vApps. The virtual machines are suspended in the same order as used for a power-off operation (reverse power-on sequence).
While a vApp is being suspended, all power operations performed on sub entities are disabled through the VIM API. They will throw TaskInProgress.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
InvalidPowerState | Thrown if the vApp is not running |
InvalidState | Thrown if the operation cannot be performed because of the vApp's current state. For example, if the vApp is in the process of being started. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy. |
VAppConfigFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
InvalidPowerState | Thrown if the vApp is running. |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
A VirtualMachine and vApp can be added as a linked child as long as it is not a direct child of another vApp. In case it is a linked child, the existing link is removed and replaced with the new link specified in this call.
An InvalidArgument fault is thrown if a link target is a direct child of another vApp, or if the addition of the link will result in a vApp with a cycle. For example, a vApp cannot be linked to itself.
The removeSet must refer to managed entities that are currently linked children. Otherwise, an InvalidArgument exception is thrown.
For each entity being linked, the operation is subject to the following privilege checks:
Privilege checks for each entity in the removeSet are similar to the entities in the addChangeSet, except that there is no target vApp.
This operation is only transactional with respect to each individual link change. The changes are processed sequentially and committed one at a time. The addChangeSet is processed first, followed by the removeSet. If a failure is detected, then the method terminates with an exception.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
addChangeSet* | VirtualAppLinkInfo[] |
a set of LinkInfo objects that either add a new link
or modify an exisiting link.
|
removeSet* | ManagedObjectReference[]
to a ManagedEntity[] |
a set of entities that should no longer link to this vApp.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConcurrentAccess | Thrown if a concurrent modification happens while adding the link. |
InvalidArgument | See above description. |
NotSupported | Thrown if the target of the link is not in the same datacenter. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Updates in different areas require different privileges. See VAppConfigSpec for a full description.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call. |
spec | VAppConfigSpec |
contains the updates to the current configuration. Any set element,
is changed. All values in the spec that is left unset, will not be
modified.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConcurrentAccess | Thrown if another operation conflicted with this operation. |
DuplicateName | |
FileFault | |
InsufficientResourcesFault | |
InvalidArgument | Thrown for wrong input. |
InvalidDatastore | |
InvalidIndexArgument | Thrown if a wrong key is used in one of the arrays. For example, for duplicated entries in entityConfig. |
InvalidName | |
InvalidPowerState | Thrown if the reconfiguration is not possible given the current powerState of the vApp. |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the vApp is busy. |
VmConfigFault | Thrown for bad configuration, such as invalid property types. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |