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 a PublishCatalogParams element that contains an IsPublished element with a value of true.
4 POST the PublishCatalogParams body to the catalog's rel="publish" URL.
The catalog is published and becomes available to administrators in other organizations in the cloud.
Example: Publish a Catalog
Request:
POST https://vcloud.example.com/api/admin/catalog/32/action/publish
Content-Type: application/vnd.vmware.admin.publishCatalogParams+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<PublishCatalogParams
xmlns="http://www.vmware.com/vcloud/v1.5">
<IsPublished>true</IsPublished>
</PublishCatalogParams>
Response:
204 No Content
User and Group Administration
A newly created organization has no users or groups in it. An organization administrator must create or import
them.
An organization can contain an arbitrary number of users and groups. Users can be created by the organization
administrator or imported from an LDAP directory service. Groups must be imported from the directory
service. Permissions within an organization are controlled through the assignment of rights and roles to users
and groups.
Local Users and Imported Users
Users can be created locally or imported from the organization's LDAP service if it has defined one. Local user
accounts are stored in the vCloud Director database and managed by the organization administrator. Imported
user accounts are stored in the LDAP database and managed by the LDAP administrator. If the LDAP
administrator changes the properties of an imported user account, or if an imported user changes his password,
the changes are not be visible in vCloud Director until an organization administrator imports the user again.
Modifying User or Group Metadata
An organization administrator can modify metadata such as name and description for a user or group object
by creating a modified version of the User or Group element that represents the object and updating the object
by making a PUT request to the object's rel="edit" link, supplying the modified element in the request body.
Create a User
An organization administrator can create user accounts that are local to the organization. Local user accounts
are stored in the vCloud Director database.
Every user exists within the context of an organization. An organization administrator can create a local user
in an organization by POSTing a User element to the organization’s add URL for users, as shown in “Example:
Create a Local User,” on page 149.
vCloud API Programming Guide
148 VMware, Inc.