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-1. Summary of Administrative Requests (Continued)
Operation Request Request Body Response
Delete a user. DELETE API-
URL/admin/user/id
None 204 No Content
Import a group. POST API-
URL/admin/org/id/groups
Group Group
Delete a group. DELETE API-
URL/admin/group/id
None 204 No Content
Update group properties. PUT API-
URL/admin/group/id
Group Group
Create a role. POST API-
URL/admin/org/id/roles
Role Role
Update role properties. PUT API-
URL/admin/role/id
Role Role
Delete a role. DELETE API-
URL/admin/role/id
None 204 No Content
Retrieve a list of tasks owned
by organization id.
GET API-URL/tasksList/id None
TasksList
Retrieve a task. GET API-URL/tasks/id None
Task
Cancel a task. POST API-
URL/task/id/action/cancel
None 204 No Content
Administrator Credentials and Privileges
An administrator's privileges are scoped by the organization to which the administrator authenticates.
The vCloud API defines two levels of administrative privilege:
n
Organization administrators, who have administrative privileges in a specific organization.
n
System administrators, who have superuser privileges throughout the system. System administrators are
members of the System organization, and can create, read, update, and delete all objects in a cloud. They
have organization administrator rights in all organizations in a cloud, and can operate directly on vSphere
resources to create and modify provider vDCs.
Some administrative operations, and all vSphere platform operations, are restricted to the system
administrator. Before you attempt these operations, log in to the System organization with the user name and
password of the system administrator account that was created when vCloud Director was installed. For
example, if the system administrator’s user name and password was defined as administrator and Pa55w0rd,
the system administrator login credentials are the MIME Base64 encoding of the string
administrator@System:Pa55w0rd.
The System Organization
The System organization is created automatically when vCloud Director is installed. It is not listed in an
OrgList, but can be retrieved by a system administrator can retrieve it with a GET request to the href value of
a special rel="down" link contained in the VCloud object, as shown in “Example: The System Organization,” on
page 112
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 111