1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
<RightReferences>
<RightReference
type="application/vnd.vmware.admin.right+xml"
name="vApp: View"
href="https://vcloud.example.com/api/admin/right/16"/>
<RightReference
type="application/vnd.vmware.admin.right+xml"
name="vApp: Power Operations"
href="https://vcloud.example.com/api/admin/right/9"/>
<RightReference
type="application/vnd.vmware.admin.right+xml"
name="vApp: Download"
href="https://vcloud.example.com/api/admin/right/11"/>
</RightReferences>
</Role>
Response:
201 Created
Content-Type: application/vnd.vmware.admin.role+xml
...
<Role
name="vAppWrangler"
id="urn:vcloud:role:102"
xmlns="http://www.vmware.com/vcloud/v1.5"
href="https://vcloud.example.com/api/admin/role/102" ...>
<Link
rel="edit"
type="application/vnd.vmware.admin.role+xml"
href="https://vcloud.example.com/api/admin/role/102"/>
<Link
rel="remove"
href="https://vcloud.example.com/api/admin/role/102"/>
<Description>Create and manage vApps</Description>
<RightReferences>
...
</RightReferences>
</Role>
Controlling Access to vApps and Catalogs
An organization administrator can use controlAccess links to control access to vApps and catalogs.
Catalogs and vApps include two types of access control links:
n
Links where rel="down".
<Link
rel="down"
type="application/vnd.vmware.vcloud.controlAccess+xml"
href="https://vcloud.example.com/api/
object-type
/
id
/controlAccess/"/>
Use this kind of link to retrieve the access control settings for the object identified in the href value.
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 157