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
Retrieve or Update Organization Settings
A system or organization administrator can retrieve or update organization properties. These properties
establish default values for leases on vApps and vApp templates, email service and message properties, and
similar settings.
An AdminOrg element contains an OrgSettings element, which contains the following elements, each of which
represents a group of related organization settings.
GeneralOrgSettings
Sets limits on stored and deployed virtual machines, specifies default behaviors
for virtual machines in the organization, and controls the ability to publish
catalogs
VAppLeaseSettings
Controls storage and deployment leases for vApps.
VAppTemplateLeaseSet
tings
Controls storage and deployment leases for vApp templates.
OrgLdapSettings
Defines whether this organization is connected to an LDAP service, and
whether it uses the system default LDAP service or a custom LDAP service.
Specifies configuration and connection parameters for a custom LDAP service
if needed.
OrgEmailSettings
Defines whether this organization uses the system default email service, and
specifies properties of email alerts sent by the organization. Specifies
configuration and connection parameters for a custom email service if needed.
OrgPasswordPolicySetti
ngs
Specifies policies to be followed when a user in this organization enters an
incorrect password.
Prerequisites
Verify that you are logged in as an organization administrator or system administrator.
Procedure
1 Retrieve the list of organization settings elements.
Use a request like this one:
GET https://vcloud.example.com/api/admin/org/26/settings
The response is an OrgSettings element.
2 Examine the OrgSettings element to find the links to the sections to view or modify.
Each section is represented in the OrgSettings element with a link where rel="down". You can use that
link to retrieve the section. The retrieved section includes a link where rel="edit". You can use that link
as the target of a PUT request that modifies the settings that the element represents. The OrgSettings
element itself also has a rel="edit" link, which you can use to update multiple settings sections in one
request.
3 Retrieve the settings element to modify.
Make a GET request to the URL in the element's href attribute value.
4 Modify the retrieved settings element.
Modified sections must contain all required elements, even if you are not changing their values. Because
optional elements revert to default values if they are omitted or empty, it is a best practice to include
optional elements in updates. Link elements and href attributes from responses do not need to be included
in modified sections. Some elements and attributes might be read-only. See the schema reference for
details.
vCloud API Programming Guide
116 VMware, Inc.