Virtual App APIs

Virtual App APIs

Represents a multi-tiered software solution.

A vApp is a collection of virtual machines (and potentially other vApp containers) that are operated and monitored as a unit. From a manage perspective, a multi-tiered vApp acts a lot like a virtual machine object. It has power operations, networks, datastores, and its resource usage can be configured.

From a technical perspective, a vApp container is a specialized resource pool that has been extended with the following capabilities:

Product information such as product name, vendor, properties, and licenses.
A power-on/power-off sequence specification
Support for import/export vApps as OVF packages
An OVF environment that allows for application-level customization

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.

Operations

Virtual App Clone V App Task

Creates a clone of this vApp.

Virtual App Create Child VM Task

Creates a new virtual machine in a vApp container.

Virtual App Create Resource Pool

Creates a new resource pool.

Virtual App Create V App

Creates a new vApp container.

Virtual App Destroy Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

Virtual App Destroy Children

Removes all child resource pools recursively.

Virtual App Export V App

Obtains an export lease on this vApp.

Virtual App Get Alarm Actions Enabled

Whether alarm actions are enabled for this entity.

Virtual App Get Available Field

List of custom field definitions that are valid for the object's type.

Virtual App Get Child Configuration

The resource configuration of all direct children (VirtualMachine and ResourcePool) of this resource group.

Virtual App Get Child Link

List of linked children.

Virtual App Get Config

Configuration of this resource pool.

Virtual App Get Config Issue

Current configuration issues that have been detected for this entity.

Virtual App Get Config Status

The configStatus indicates whether or not the system has detected a configuration issue involving this entity.

Virtual App Get Custom Value

Custom field values.

Virtual App Get Datastore

A collection of references to the subset of datastore objects used by this vApp.

Virtual App Get Declared Alarm State

A set of alarm states for alarms that apply to this managed entity.

Virtual App Get Disabled Method

List of operations that are disabled, given the current runtime state of the entity.

Virtual App Get Effective Role

Access rights the current session has to this entity.

Virtual App Get Name

Name of this entity, unique relative to its parent.

Virtual App Get Namespace

The namespace with which the ResourcePool is associated.

Virtual App Get Network

A collection of references to the subset of network objects that is used by this virtual machine.

Virtual App Get Overall Status

General health of this managed entity.

Virtual App Get Owner

The ComputeResource to which this set of one or more nested resource pools belong.

Virtual App Get Parent

Parent of this entity.

Virtual App Get Parent Folder

A reference to the parent folder in the VM and Template folder hierarchy.

Virtual App Get Parent V App

Reference to the parent vApp.

Virtual App Get Permission

List of permissions defined for this entity.

Virtual App Get Recent Task

The set of recent tasks operating on this managed entity.

Virtual App Get Resource Pool

The set of child resource pools.

Virtual App Get Runtime

Runtime information about a resource pool.

Virtual App Get Summary

Basic information about a resource pool.

Virtual App Get Tag

The set of tags associated with this managed entity.

Virtual App Get Triggered Alarm State

A set of alarm states for alarms triggered by this entity or by its descendants.

Virtual App Get Value

List of custom field values.

Virtual App Get V App Config

Configuration of this package.

Virtual App Get Vm

The set of virtual machines associated with this resource pool.

Virtual App Import V App

Creates a new entity in this resource pool.

Virtual App Move Into Resource Pool

Moves a set of resource pools, vApps or virtual machines into this pool.

Virtual App Power Off V App Task

Stops this vApp.

Virtual App Power On V App Task

Starts this vApp.

Virtual App Query Resource Config Option

Get a value range and default values for *ResourceConfigSpec*.

Virtual App Refresh Runtime

Refreshes the resource usage data that is available in *ResourcePoolRuntimeInfo*.

Virtual App Register Child VM Task

Adds an existing virtual machine to this resource pool or vApp.

Virtual App Reload

Reload the entity state.

Virtual App Rename Task

Renames this managed entity.

Virtual App Set Custom Value

Assigns a value to a custom field.

Virtual App Suspend V App Task

Suspends this vApp.

Virtual App Unregister V App Task

Removes this vApp from the inventory without removing any of the virtual machine's files on disk.

Virtual App Update Child Resource Configuration

Changes resource configuration of a set of children of this resource pool.

Virtual App Update Config

Updates the configuration of the resource pool.

Virtual App Update Linked Children

Reconfigure the set of linked children.

Virtual App Update V App Config

Updates the vApp configuration.