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. 85
Chapter 5 Datacenter Operations
List Media Devices of a Virtual Machine
YoucanmakeaGETrequesttothemediaURLofaVmtoreturnalistofallmediadevicesattachedtoit.
Example 5-28. List Media Devices Attached to a Vm
Request:
GET http://vcloud.example.com/api/v1.0/vapp/vm-5/virtualHardwareSection/media
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.rasditemslist+xml
...
<RasdItemsList xmlns="http://www.vmware.com/vcloud/v1" ...
href="http://vcloud.example.com/api/v1.0/vApp/vm-5/virtualHardwareSection/media" ... >
<Item>
<rasd:Address>0</rasd:Address>
<rasd:Description>IDE Controller</rasd:Description>
<rasd:ElementName>IDE Controller 0</rasd:ElementName>
<rasd:InstanceID>1</rasd:InstanceID>
<rasd:ResourceType>5</rasd:ResourceType>
</Item>
<Item>
<rasd:AddressOnParent>0</rasd:AddressOnParent>
<rasd:Description>CD/DVD Drive</rasd:Description>
<rasd:ElementName>CD/DVD Drive 1</rasd:ElementName>
<rasd:HostResource xmlns:vcloud="http://www.vmware.com/vcloud/v1"
vcloud:connected="false"></rasd:HostResource>
<rasd:InstanceID>3000</rasd:InstanceID>
<rasd:Parent>1</rasd:Parent>
<rasd:ResourceType>15</rasd:ResourceType>
</Item>
<Item>
<rasd:AddressOnParent>0</rasd:AddressOnParent>
<rasd:Description>Floppy Drive</rasd:Description>
<rasd:ElementName>Floppy Drive 1</rasd:ElementName>
<rasd:HostResource xmlns:vcloud="http://www.vmware.com/vcloud/v1"
vcloud:connected="false"></rasd:HostResource>
<rasd:InstanceID>8000</rasd:InstanceID>
<rasd:ResourceType>14</rasd:ResourceType>
</Item>
</RasdItemsList>
Insert Media Into a Virtual Machine
AninsertMediarequestmakesavirtualmediaimagereadablebyaVm.Therequestmustspecifythe
insertMediaURLofaVm.TheMediaelementintherequestbodymustspecifythehrefofthemediaimage
toinsert.WhenprocessinganinsertMediarequest,theserverexaminesthetypeof
themediaspecifiedinthe
requestandthenattemptstoinsertitinadeviceoftheappropriatetype,startingwiththedevicethathasthe
lowestbusnumberandlowestaddressonthatbus.
Example 5-29. Insert Media Into a Virtual Machine
Request:
POST http://vcloud.example.com/api/v1.0/vapp/vm-5/media/action/insertMedia
Content-Type: application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml
<MediaInsertOrEjectParams xmlns="http://www.vmware.com/vcloud/v1">
<Media href="http://vcloud.example.com/api/v1.0/media/3"/>
</MediaInsertOrEjectParams>