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. 97
Chapter 6 Administrative Operations
<FullName>Finance</FullName>
...
<Settings>
...
</Settings>
</AdminOrg>
List All Tasks Owned by an Organization
AnadministrativeviewofanorganizationincludesaLinkwitharel="down"attributethattheadministrator
canusetoretrievealistofalltasksownedbyauserorobjectinanorganization.TherequestinExample 6‐5
usesthetasksListURLreturnedinExample 6‐4toreturnaTasksList
elementthatcontainsseveralTask
elements.
Example 6-5. List All Tasks Owned by an Organization
Request:
GET http://vcloud.example.com/api/v1.0/tasksList/26
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.tasksList+xml
...
<TasksList name="Tasks Lists" type="application/vnd.vmware.vcloud.tasksList+xml"
href="http://vcloud.example.com/api/v1.0/tasksList/18" ...>
<Task... status="success" ... operation="Deleted Virtual Application Template (21)" ... >
...
</Task>
<Task... status="error" ... operation="Powered On Virtual Machine WIn2K8 (15)" ... >
<Error stackTrace="com.vmware.ssdc.library.exceptions.VimInvalidStateException
The operation could not be performed because the object is in an invalid
state. Current state of the the VM is VMOn.
at com.vmware.vcloud.val.internal.impl.VC20VirtualServer.throwVimInvalidStateE
xception(VC20VirtualServer.java:292)
at ...">
...
</Task>
<Task... status="running" ... operation="Deleting Virtual Application (44)" ... >
...
</Task>
...
</TasksList>
Modify an Organization
AsshowninExample 6‐3,anAdminOrgbodyincludesrel="add"linksfornetworks,vDCs,users,groups,
andcatalogs.Anorganizationadministratorcanusetheselinkstoaddobjectsofthosetypestothe
organization.TomodifyotherattributesorelementsofanAdminOrg,anorganizationadministratorcanmake
aPUT
requesttoitsrel="edit"linkandsupplyamodifiedversionoftheAdminOrgbody.Therequestin
Example 6‐6modifiesthedefaultleasesettingsoftheorganizationcreatedinExample 6‐3.
NOTEIfyoumodifyanorganization’scatalogpublishingpolicyorLDAPoptionsormodifyarole,the
changesdonottakeeffectforlogged‐inusersuntilthecacheforthecurrentsessionexpiresortheuserlogs
outandlogsinagain.