1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
VMware, Inc. 145
Chapter 8 XML Representations in the vCloud API
XML Namespace Identifiers
ElementsusedasrequestorresponsebodiescontainasetofattributesthatenableXMLvalidation.Thebody
ofaPUTorPOSTrequestmustcontainallXMLnamespaceidentifiersrequiredtovalidatetheXMLit
contains.AresponsebodytypicallyincludesalltheXMLnamespaceidentifiersthattheserverused
tovalidate
it,inadditiontootherattributesthatspecifytheschemalocationssearchedduringvalidation.Table 8‐5
summarizestheseattributesandshowsthenamespaceidentifiersandprefixesusedintheexamplesinthis
guide.
XMLnamespaceidentifiersareomittedfrommostoftheexampleresponses(see“A b o u t theExamples”on
page 19).Example 8‐1showshowtheyappearinatypicalresponsebody.
Example 8-1. Response Body Showing XML Namespace Identifiers
<VApp xmlns="http://www.vmware.com/vcloud/v1" status="8" name="Linux FTP server"
type="application/vnd.vmware.vcloud.vApp+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7"
xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.vmware.com/vcloud/v1
http://vcloud.example.com/api/v1.0/schema/master.xsd">
...
</vApp>
8Theobjectispoweredoff. YES YES
†
YES
9Theobjectisinaninconsistentstate. No YES YES
10 Childrendonotallhavethesamestatus. YES Y ES No
11 Uploadinitiated,OVFdescriptorpending YES No No
12 Uploadinitiated,copyingcontents YES No No
13 Uploadinitiated,diskcontentspending YES No No
14 Uploadhasbeenquarantined YES No No
15 Uploadquarantineperiodhasexpired YES No No
† IndicatesthatallChildrenhavethisstatus
Table 8-4. vAppTemplate, vApp, and Vm status Attribute Values (Continued)
Value Description vAppTemplate vApp Vm
Table 8-5. XML Namespace Identifiers
Name Value Requirement
xmlns http://www.vmware.com/vcloud/v1.0 Requiredinallrequestbodies.
xmlns:vmext http://www.vmware.com/vcloud/extension/v1 Requiredinrequestbodiesthat
includeelementsfromthevSphere
PlatformExtensions
xmlns:ovf http://schemas.dmtf.org/ovf/envelope/1 Requiredinrequestbodiesthat
includeelementsprefixedwithovf:
xmlns:rasd http://schemas.dmtf.org/wbem/wscim/1/cim‐schema/2/
CIM_ResourceAllocationSettingData
Requiredinrequestbodiesthat
includeelementsprefixedwithrasd:
xmlns:vssd http://schemas.dmtf.org/wbem/wscim/1/cim‐schema/2/
CIM_VirtualSystemSettingData
Notrequiredinrequestbodies.
xsi:schemaLocation Aninstallation‐dependent
schemalocationsearchpath.
Formoreinformation,see
http://www.w3.org/TR/xmlschema‐0/#schemaLocation
Notrequiredinrequestbodies.
xmlns:xsi http://www.w3.org/2001/XMLSchema‐instance Notrequiredinrequestbodies.