# 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* P | ManagedObjectReference[] to a Datastore[] |
network* P | ManagedObjectReference[] to a Network[] |
parentFolder* P | ManagedObjectReference to a Folder |
parentVApp* | ManagedObjectReference to a ManagedEntity | Since vSphere API 4.1
vAppConfig* P | VAppConfigInfo |
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 present P Required 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.
name P | xsd:string | Since vSphere API 4.0
target P | ManagedObjectReference to a ResourcePool | Since vSphere API 4.0
spec P | VAppCloneSpec | Since vSphere API 4.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidState |
MigrationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.
force P | xsd:boolean | Since vSphere API 4.0

P Required privilege: force

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
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 |
VAppConfigFault |

Events

Type
None

# PowerOnVApp_Task

Required Privileges
  VApp.PowerOn

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
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 |
VAppConfigFault |

Events

Type
None

# unregisterVApp_Task

Required Privileges
  VApp.Unregister

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
ConcurrentAccess |
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

# UpdateLinkedChildren

Deprecated.

Required Privileges
  None
Since
  vSphere API 4.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.
addChangeSet* P | VirtualAppLinkInfo[] | Since vSphere API 4.1
removeSet* P | ManagedObjectReference[] to a ManagedEntity[] | Since vSphere API 4.1

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
ConcurrentAccess |
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

# UpdateVAppConfig

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualApp used to make the method call.
spec P | VAppConfigSpec | Since vSphere API 4.0

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
ConcurrentAccess |
DuplicateName |
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidName |
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 |
VmConfigFault |

Events

Type
None