VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
144 VMware, Inc.
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 8‐3.
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 8‐4,whereYESindicatesthatastatusvalueis
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.
Table 8-3. Requirements for Unique Object Names
Object Type Name Scope
ProviderVdc vCloud
Org,AdminOrg vCloud
Vdc Containingorganization
Catalog Containingorganization
CatalogItem Containingcatalog
vAppTemplate Notconstrained
vApp Containingorganization
Vm ContainingvApp
Media Notconstrained
Network Container(Org,vApp,orvCloud)
NOTEThedeploymentstatusofanobjectisindicatedbythevalueofitsdeployedattribute.
Table 8-4. vAppTemplate, vApp, and Vm status Attribute Values
Value Description vAppTemplate vApp Vm
‐1Theobjectcouldnotbecreated. YES YES YES
0Theobjectisunresolved. YES YES YES
1Theobjectisresolved. YES YES YES
2Theobjectisdeployed. No No No
3Theobjectissuspended. No YES
†
YES
4Theobjectispoweredon. No YES
†
YES
5Theobjectiswaitingforuserinput. No YES
†
YES
6Theobjectisinanunknownstate. YES YES YES
7Theobjectisinanunrecognizedstate. YES YES YES

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English