Managed Object - VirtualApp

Returned by
CloneVApp_Task, CreateVApp
Extends
ResourcePool
See also
Datastore, Folder, HttpNfcLease, ManagedEntity, Network, ResourcePool, VAppCloneSpec, VAppConfigInfo, VAppConfigSpec, VirtualAppLinkInfo
Since
vSphere API 4.0


Managed Object Description

Properties

Name Type Description
childLink*VirtualAppLinkInfo[]

Since vSphere API 4.1
datastore* PManagedObjectReference[]
to a Datastore[]


network* PManagedObjectReference[]
to a Network[]


parentFolder* PManagedObjectReference
to a Folder


parentVApp*ManagedObjectReference
to a ManagedEntity

Since vSphere API 4.1
vAppConfig* PVAppConfigInfo


Properties inherited from ResourcePool
childConfiguration, config, namespace, 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
*May not be presentPRequired privilege - see tooltip for details

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

CloneVApp_Task

Required Privileges
VApp.Clone

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.
name Pxsd:string

Since vSphere API 4.0
target PManagedObjectReference
to a ResourcePool

Since vSphere API 4.0
spec PVAppCloneSpec

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidState
MigrationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



ExportVApp

Required Privileges
VApp.Export

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a HttpNfcLease

Faults

Type Description
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



PowerOffVApp_Task

Required Privileges
VApp.PowerOff

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.
force Pxsd:boolean

Since vSphere API 4.0
P Required privilege: force

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VAppConfigFault

Events

Type
None



PowerOnVApp_Task

Required Privileges
VApp.PowerOn

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VAppConfigFault
VmConfigFault

Events

Type
None



SuspendVApp_Task

Required Privileges
VApp.Suspend
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VAppConfigFault

Events

Type
None



unregisterVApp_Task

Required Privileges
VApp.Unregister

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
ConcurrentAccess
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdateLinkedChildren

Deprecated.

Required Privileges
None
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.
addChangeSet* PVirtualAppLinkInfo[]

Since vSphere API 4.1
removeSet* PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 4.1
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
ConcurrentAccess
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdateVAppConfig

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualApp used to make the method call.
spec PVAppConfigSpec

Since vSphere API 4.0
P Required privilege: spec

Return Value

Type Description
None

Faults

Type Description
ConcurrentAccess
DuplicateName
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None