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
Table 5-3. Summary of Vm Reconfiguration Requests (Continued)
Operation Request Request Body Response
Update the
VirtualHardwareSection
of a virtual machine
PUT API-URL/vApp/vm-id/
virtualHardwareSection/
VirtualHardwareSection Task
Retrieve the CPU
configuration of a virtual
machine
GET API-URL/vApp/vm-id/
virtualHardwareSection/
cpu
None
ovf:Item
Update the CPU
configuration of a virtual
machine
PUT API-URL/vApp/vm-id/
virtualHardwareSection/
cpu
ovf:Item Task
Retrieve the memory item
from the
VirtualHardwareSection
of a virtual machine
GET API-URL/vApp/vm-id/
virtualHardwareSection/
memory
None
ovf:Item
Update the memory item in
the
VirtualHardwareSection
of a virtual machine
PUT API-URL/vApp/vm-id/
virtualHardwareSection/
memory
ovf:Item Task
Retrieve virtual disk items
from the
VirtualHardwareSection
of a virtual machine
GET API-URL/vApp/vm-id/
virtualHardwareSection/
disks
None
RasdItemsList
Update virtual disk items in
the
VirtualHardwareSection
of a virtual machine
PUT API-URL/vApp/vm-id/
virtualHardwareSection/
disks
RasdItemsList Task
Retrieve network card items
from the
VirtualHardwareSection
of a virtual machine
GET API-URL/vApp/vm-id/
virtualHardwareSection/
networkCards
None
RasdItemsList
Update network card items in
the
VirtualHardwareSection
of a virtual machine
PUT API-URL/vApp/vm-id/
virtualHardwareSection/
networkCards
RasdItemsList Task
vCloud API Custom Attributes
vCloud API custom attributes extend several elements in the OVF and RASD namespaces. You can use these
attributes to provide additional detail about virtual NIC and hard disk controller devices, or to specify the
guest operating system type.
With the exception of osType, custom attributes are scoped to ovf:Item elements based on the elements' RASD
resource type. The osType attribute applies to the ovf:OperatingSystemSection element. All of the elements to
which these custom attributes apply are contained in the VirtualHardwareSection of a Vm.
Table 5-4. vCloud API Custom Attributes for OVF and RASD Elements
Element Name
RASD
Resource
Type Attribute Name Attribute Type Description
rasd:Connection 10
(Network
adapters)
ipAddressingMode xs:string IP addressing mode to use for this
connection. One of NONE, MANUAL,
DHCP, POOL.
rasd:Connection 10
(Network
adapters)
ipAddress xs:string If ipAddressingMode="MANUAL",
set the IP address here
Chapter 5 Deploying and Operating vApps
VMware, Inc. 93