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
Table 6-3. Default Rights for the Predefined Roles (Continued)
System
Administrator
Organization
Administrator
Catalog
Author vApp Author vApp User
Console Access
Only
Organization:
Edit Password
Policy
X X
Organization
vDC: View
Organization
vDCs
X X
User: View
Group/User
X X
General: Send
Notification
X X
General:
Administrator
Control
X X
General:
Administrator
View
X X
Create a Role
An organization administrator can create a role by aggregating a set of rights in a Role element and POSTing
it to the organization's add URL for roles.
Prerequisites
Verify that you are logged in as an organization administrator or system administrator.
Procedure
1 Create a Role element that defines the role with a name and a set of rights.
To get the RightReference objects you will need to populate the Role, retrieve the administrative view of
the cloud, using a request like this one:
GET https://vcloud.example.com/api/admin
2 POST the Role element to the organization's add URL for roles.
See the request portion of “Example: Create a Role,” on page 156.
The server creates a Role element and returns its representation to the client.
Example: Create a Role
This example adds a role named vAppWrangler to the organization created in “Example: Create an
Organization,” on page 113. The response is a Role element, most of which does not appear in the example.
The response includes links that an administrator can use to edit or remove the role.
Request:
POST https://vcloud.example.com/api/admin/roles
Content-Type: application/vnd.vmware.admin.role+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<Role name="vAppWrangler" xmlns="http://www.vmware.com/vcloud/v1.5">
<Description>Create and manage vApps</Description>
vCloud API Programming Guide
156 VMware, Inc.