Table of Contents
Advertisement
vCloud API Programming Guide
name
Every object requires a name attribute whose string value provides the display name for the object. The value
of name must be unique within a given scope, as shown in Table
Table 8-3. Requirements for Unique Object Names
Object Type
ProviderVdc
Org, AdminOrg
Vdc
Catalog
CatalogItem
vAppTemplate
vApp
Vm
Media
Network
href
Every object has unique reference encoded in the href attribute of its XML representation. See "Object
Reference Prototype" on page 142.
type
Every object allows a type attribute in its XML representation. The value of this attribute is the object type
expressed as a string, which clients should interpret as the media type (HTTP Content‐Type) of the
representation. This string is case‐insensitive in requests, and can be returned in either mixed case or lowercase
characters in responses. For more information, see "Content Type" on page 142.
status
Objects such as vAppTemplate, vApp, and Vm, that extend the ResourceEntity type have a status attribute
whose value indicates the state of the object, as shown in Table
allowed for the object listed in the column header. Status for an object, such as a vAppTemplate or vApp, whose
Children (Vm objects) each have a status of their own, is computed from the status of the Children.
N
The deployment status of an object is indicated by the value of its deployed attribute.
OTE
Table 8-4. vAppTemplate, vApp, and Vm status Attribute Values
Value
Description
‐1
The object could not be created.
0
The object is unresolved.
1
The object is resolved.
2
The object is deployed.
3
The object is suspended.
4
The object is powered on.
5
The object is waiting for user input.
6
The object is in an unknown state.
7
The object is in an unrecognized state.
144
8‐3.
Name Scope
vCloud
vCloud
Containing organization
Containing organization
Containing catalog
Not constrained
Containing organization
Containing vApp
Not constrained
Container (Org, vApp, or vCloud)
8‐4, where YES indicates that a status value is
vAppTemplate
YES
YES
YES
No
No
No
No
YES
YES
vApp
Vm
YES
YES
YES
YES
YES
YES
No
No
†
YES
YES
†
YES
YES
†
YES
YES
YES
YES
YES
YES
VMware, Inc.
Advertisement
Table of Contents
