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
Creating, Provisioning, and Managing
Organizations 6
The VMware vCloud API supports objects and operations that an organization or a system administrator can
use to automate tasks associated with provisioning organizations with resources and users.
A successful login by an organization or system administrator returns a Session element, which contains a
link that enables the administrator to retrieve a VCloud element. This element provides access to a cloud-wide
namespace of administrative objects. See “Retrieve an Administrative View of a Cloud,” on page 47.
This chapter includes the following topics:
n
“Summary of Administrative Requests,” on page 109
n
“Administrator Credentials and Privileges,” on page 111
n
“Organization Administration,” on page 112
n
“Network Administration,” on page 118
n
“vDC Administration,” on page 139
n
“Catalog Administration,” on page 145
n
“User and Group Administration,” on page 148
n
“Working With Roles and Rights,” on page 153
n
“Controlling Access to vApps and Catalogs,” on page 157
Summary of Administrative Requests
Administrative requests retrieve or update administrative objects such as organizations, users, and vDCs.
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only. For more information about the requests and responses for each
operation, see “About the Schema Reference Downloadable Archive,” on page 19.
Table 6-1. Summary of Administrative Requests
Operation Request Request Body Response
Retrieve an administrative
view of an organization.
GET API-URL/admin/org/id None
AdminOrg
Create an organization. POST API-URL/admin/orgs
AdminOrg AdminOrg
Enable an organization. POST API-
URL/admin/org/
id/action/enable
None 204 No Content
VMware, Inc. 109