VMware VCLOUD API 1.0 - TECHNICAL NOTE, Programming Manual

Page: 163 / 212

VMware, Inc. 163
Chapter 9 User API Reference
Vm
A Vm represents a virtual machine, a member of a vApp’s Children container.
Content-Type
application/vnd.vmware.vcloud.vApp+xml
Object href prototype
API ‐ URL /vAppTemplate/vm ‐ id or API ‐ URL /vApp/vm ‐ id
Section
A VAppTemplate , VApp , and Vm can contain an arbitrary number of ovf:SectionType elements. In a vApp or
Vm , some of these elements can be specified as instantiation parameters. The others are copied from the source
OVF Envelope and treated as read ‐ only by the vCloud API.
The following section types are allowed in a vApp or vAppTemplate :

LeaseSettingsSection

StartupSection

NetworkConfigSection

CustomizationSection
Section 0 n ovf:Section_Type Any of the following ovf:Section_Type elements:

LeaseSettingsSection

StartupSection

NetworkConfigSection

CustomizationSection
Children 0 n VAppChildrenType Read ‐ only container for Vm elements representing
virtual machines
Schema (Continued)
Name Min Max Type Description
Schema
Name Min Max Type Description
deployed 0 1 xs:boolean True if the Vm is deployed
status 0 1 xs:int Creation status of the Vm
name 1 1 xs:string Common object name attribute
any attribute name 0 n any Includes type , href , XML namespace identifiers
Link 0 n LinkType Action links to operations
Description 0 1 xs:string Optional description
Tasks 0 1 TasksInProgressType Read ‐ only container for Task elements. Each element
in the container represents a queued, running, or
failed task owned by this object.
VAppParent 0 1 ReferenceType Unsupported in this release
Section 0 n ovf:Section_Type Any of the following ovf:Section_Type elements:

VirtualHardwareSection

OperatingSystemSection

NetworkConnectionSection

GuestCustomizationSection
VAppScopedLocalId 0 1 xs:string Read ‐ only identifier created on import or composition