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
3 Create an AdminOrg element that specifies the properties of the organization.
See the request portion of “Example: Create an Organization,” on page 113.
4 POST the AdminOrg element you created in Step 3 to the URL described in Step 2.
See the request portion of “Example: Create an Organization,” on page 113.
The server creates and enables the organization, and returns an AdminOrg element that includes the contents
you POSTed, along with a set of Link elements that you can use to access, remove, disable, or modify it. vCloud
API users can log in to this organization using the URL specified in the href attribute of the Link where
rel="alternate". Users of the vCloud Director Web console can log in to the organization at a URL of the form
cloud-url/org/name, where cloud-url is a URL of the form https://vcloud.example.com/cloud and name is the
value of the name attribute of the AdminOrg element. To log in to the organization created by “Example: Create
an Organization,” on page 113, a user opens a browser and navigates to
https://vcloud.example.com/cloud/org/Finance.
Example: Create an Organization
This request creates an organization and specifies its required properties. For a list of all required and optional
elements that an AdminOrg contains, see the schema reference.
Request:
POST https://vcloud.example.com/api/admin/orgs
Content-Type: application/vnd.vmware.admin.organization+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<AdminOrg
xmlns="http://www.vmware.com/vcloud/v1.5"
name="Finance"
type="application/vnd.vmware.admin.organization+xml">
<Description>Example Corporation’s Finance Organization</Description>
<FullName>Finance</FullName>
<Settings>
<GeneralOrgSettings>
<CanPublishCatalogs>true</CanPublishCatalogs>
</GeneralOrgSettings>
<OrgLdapSettings>
<OrgLdapMode>SYSTEM</OrgLdapMode>
</OrgLdapSettings>
<OrgEmailSettings>
<IsDefaultSmtpServer>true</IsDefaultSmtpServer>
<IsDefaultOrgEmail>true</IsDefaultOrgEmail>
<FromEmailAddress>vcloud@example.com</FromEmailAddress>
<DefaultSubjectPrefix>Attention</DefaultSubjectPrefix>
<IsAlertEmailToAllAdmins>true</IsAlertEmailToAllAdmins>
</OrgEmailSettings>
</Settings>
</AdminOrg>
The response echoes the request, and includes links that an administrator can use to manage the organization
and its settings, and to add resources such as vDCs, catalogs, and users. On creation, AdminOrg objects are
disabled by default. A system administrator must enable the AdminOrg before users can log into it. See
“Example: Enable an Organization,” on page 118
The response also includes elements inherited from system defaults, such as a OrgPasswordPolicySettings,
VAppLeaseSettings, and VAppTemplateLeaseSettings. The full content of these elements appears in the actual
response. This example shows only place-holders.
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 113