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
vCloud API Programming Guide
110 VMware, Inc.
<CatalogItems>
<CatalogItem name="Ubuntu Template with vsftpd"
type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalogItem/221">
<Description>Approved template for public FTP sites</Description>
<Entity href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-111"/>
<Property key="Owner">Tech Ops</Property>
</CatalogItem>
</CatalogItems>
</Catalog>
Remove a Catalog
AnadministratorcanremoveacatalogbymakingaDELETErequesttothecatalog’srel="remove"URL.
Example 6‐23removesthecatalogcreatedinExample 6‐19.
Example 6-23. Remove a Catalog
Request:
DELETE http://vcloud.example.com/api/v1.0/admin/catalog/32
Response:
204 No Content
User Administration
UserscanbecreatedinanorganizationorimportedintotheorganizationfromanLDAPdirectoryservice.
Create or Import a User
Everyuserexistswithinthecontextofanorganization.Anadministratorcanaddausertoanorganizationby
POSTingaUserbodytotheorganization’saddURLforusers,asshowninExample 6‐24,whichaddstheuser
totheorganizationcreatedinExample 6‐3.Theresponseisa
Userelement,mostofwhichisnotshowninthe
example.Theelementincludesalinkthatanadministratorcanusetoedittheuser,andadditionalelements,
suchasIsDefaultCachedandStoredVmQuota,inheritedfromorganizationdefaults.
Example 6-24. Create a User
Request:
POST http://vcloud.example.com/api/v1.0/admin/org/26/users
Content-Type: application/vnd.vmware.admin.user+xml
<User name="ExampleUser" xmlns="http://www.vmware.com/vcloud/v1">
<FullName>Example User Full Name</FullName>
<EmailAddress>user@example.com</EmailAddress>
<IsEnabled>true</IsEnabled>
<Role type="application/vnd.vmware.admin.role+xml"
href="http://vcloud.example.com/api/v1.0/admin/role/105"/>
<Password>Pa55w0rd</Password>
</User>
NOTEModifyingcatalogmetadatadoesnotaffectCatalogItemelements.Youcannotcreateacatalogthat
hasCatalogItemelementsinit.Theymustbeaddedinaseparateoperation.Forinformationaboutadding
andremovingtheseelements,see“CatalogingvAppTemplatesandMediaImages”onpage 54.