VMware VCLOUD API 1.0 - TECHNICAL NOTE, Programming Manual

Page: 160 / 212

vCloud API Programming Guide
160 VMware, Inc.
Protocol
The Protocol element of a VmRule element specifies the network protocol to which this rule applies. Table 9 ‐ 6
shows permitted values for element content and the results they produce.
Catalog
A Catalog element is a container for CatalogItems . An organization can contain zero or more catalogs. Users
with appropriate privileges can add or remove CatalogItem elements from a catalog.
Content-Type
application/vnd.vmware.vcloud.xml
Object href prototype
API ‐ URL /catalog/ id
CatalogItems
The CatalogItems element is a read ‐ only container for individual CatalogItem elements.
CatalogItem
The CatalogItem element contains a reference to a media image or vApp template and optional related
metadata.
Content-Type
application/vnd.vmware.vcloud.cataxml
Object href prototype
API ‐ URL /catalogItem/ id
Table 9-6. VmRule Protocol Element Values
Value Result
TCP The rule applies to the TCP protocol
UDP The rule applies to the UDP protocol
TCP_UDP The rule applies to the TCP and UDP protocols
Schema
Name Min Max Type Description
name 1 1 xs:string Common object name attribute
any attribute name 0 n any Includes type , href , XML namespace identifiers
Link 0 n LinkType Links to actions and contained objects
Description 0 1 xs:string Optional description
Tasks 0 1 TasksInProgressType Read ‐ only container for Task elements. Each
element in the container represents a queued,
running, or failed task owned by this object.
CatalogItems 0 1 CatalogItemsType Read ‐ only container for CatalogItem elements.
IsPublished 0 1 xs:boolean Read ‐ only element, true if the catalog is published
Schema
Name Min Max Type Description
Entity 1 1 ReferenceType Reference to the catalogued object
Property 0 n PropertyType Expresses a key = value relationship. (In this release,
the maximum number of these elements in a
CatalogItem is limited to ten).