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 System Settings
A system administrator can retrieve or update a cloud-wide set of system properties. These properties specify
default values and behaviors for the cloud and all of the organizations in it.
The SystemSettings element includes all system settings for this cloud. The element also includes links that
allow you to retrieve these subsidiary elements, which define specific categories of settings.
GeneralSettings
Control the configuration and behavior of the entire cloud.
NotificationsSettings
Control the vCloud Director AMQP notifications service.
LdapSettings
Specify details of the system LDAP directory service.
AmqpSettings
Specify credentials and connection information for the AMQP broker that
handles notifications and blocking task messages.
EmailSettings
Define configuration and connection parameters for the system default email
service, and specifies properties of email alerts that the system sends.
License
System license serial number and related settings.
BrandingSettings
Allow you to customize the branding of the vCloud Director client UI and some
of the links that appear on the vCloud Director Home login screen.
BlockingTaskSettings
Control the behavior of blocking tasks and enable blocking extensions for
specific kinds of tasks.
PasswordPolicySettings
Specify default policies to be followed when a user in any organization enters
an incorrect password. Organization administrators can override this default
for their organization.
You can retrieve the entire SystemSettings element to view all of these settings. To update an individual
subsection, retrieve it with a GET request, modify it, and update it with a PUT request.
Prerequisites
Verify that you are logged in as a system administrator.
Procedure
1 Retrieve the SystemSettings element.
Use a request like this one.
GET https://vcloud.example.com/api/admin/extension/settings
2 Examine the response to locate the Link elements that you can use to retrieve an individual subsection.
These links have a rel attribute value of down.
3 Use the link to retrieve the subsection.
Make a GET request to the href value of the link.
4 (Optional) Modify the retrieved subsection.
Subsections that you can modify include a link where rel="edit".
5 (Optional) To update the subsection, PUT the modified subsection to the href of the link described in
Step 4.
Chapter 7 Using vCloud API Extensions to Provision and Manage a Cloud
VMware, Inc. 165