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. 75
Chapter 5 Datacenter Operations
Example 5‐12showsarepresentativecollectionoftheselinks.(Thisexampledoesnotshowtheconfiguration
linksfortheparentvApp.Toseethem,refertoExample 5‐9onpage 70.)
Example 5-12. Configuration Links for a Vm
Request:
GET http://vcloud.example.com/api/v1.0/vApp/vapp-7
Response:
200 OK
Content-type: application/vnd.vmware.vcloud.vApp+xml
...
<VApp name="Linux FTP server" status="8" href="http://vcloud.example.com/api/v1.0/vApp/vapp-7"
...>
<Description>Example FTP Server</Description>
...
<Children>
<Vm status="8" name="ubuntu10-x86" href="http://vcloud.example.com/api/v1.0/vApp/vm-4"
...>
<Link rel="power:reboot" href="http://vcloud.example.com/api/v1.0/vApp/vm-4/power/
action/reboot"/>
...
<Link rel="media:ejectMedia"
type="application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vm-4/media/
action/ejectMedia"/>
<Description/>
<ovf:VirtualHardwareSection ... ">
<ovf:System>
...
</ovf:System>
<ovf:Item vcloud:href="http://vcloud.example.com/api/v1.0/vApp/vm-4/
virtualHardwareSection/cpu" ... >
...
<rasd:Description>Number of Virtual CPUs</rasd:Description>
<rasd:ResourceType>3</rasd:ResourceType>
...
<Link rel="edit" type="application/vnd.vmware.vcloud.rasdItem+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vm-4/
virtualHardwareSection/cpu"/>
</ovf:Item>
<ovf:Item vcloud:href="http://vcloud.example.com/api/v1.0/vApp/vm-4/
virtualHardwareSection/memory" ...>
...
<rasd:Description>Memory Size</rasd:Description>
<rasd:ResourceType>4</rasd:ResourceType>
...
<Link rel="edit" type="application/vnd.vmware.vcloud.rasdItem+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vm-4/
virtualHardwareSection/memory"/>
</ovf:Item>
<ovf:Item>
...
<rasd:Description>SCSI Controller</rasd:Description>
<rasd:ResourceType>6</rasd:ResourceType>
...
</ovf:Item>
<ovf:Item>
...
<rasd:Description>Hard disk</rasd:Description>
<rasd:ElementName>Hard disk 1</rasd:ElementName>
<rasd:ResourceType>17</rasd:ResourceType>
...
</ovf:Item>