Consumption Analytics Documentation

Home > Documentation for older versions > Cloud Cruiser 3 > Setting Up Collection > Native collectors > VMware vCloud

VMware vCloud

Cloud Cruiser’s VMware vCloud Collector is based on the vCloud REST API and can collect any entity type as supported by the vCloud Director server, including entity details and custom metadata entries. This collector is intended to run several times per day to capture multiple entity snapshots. This requires an end of day job to aggregate the data collected on a particular day and load charges.

This section contains the following articles:


The collector is REST-based and responses to entity queries are XML documents. The collector takes an XML feed configuration that controls data mapping from vCloud to Cloud Cruiser. The basic XML feed configuration is extended to include an entity type and an optional filter, as well as optional flags to enable additional entity details and metadata for collection, if available. Only one entity type can be collected per configuration. The collector requires an endpoint URL and authentication to access a vCloud Director server.

Application notes

Each entity record has a different set of basic attributes. For example, a basic virtual machine record includes attributes indicating the number of CPUs or memory size of the VM, but user records do not. A filter can be applied to an entity type to only include entities with attribute values that match the specified condition. By default, only a basic set of attributes are collected. However, you can enable the VCloudSnapshotFeedConfig ’s includeDetailData property to collect more details for each entity. If there is user-entered metadata for the entity, you can enable the includeMetaData property to collect those.

Due to the varied attributes across each entity type, it is recommended running a collection for an entity type and output the XML documents to a file on disk before attempting to map the output. You can then use this file as a reference when updating the feed configuration for attribute mapping to Cloud Cruiser records. To output the XML documents to files, set the xmlOutput property on the collector ( VCloudSnapshotCollector ) with a file path. After attributes have been mapped in the feed configuration, remove the xmlOutput property from the collector.

Sample jobs

Sample jobs for data collection and data loading are located in the < install_dir >/job_samples directory.

  • vcloud-sample-collect.xml : Collects the adminVM entity type with metadata that produces basic records for virtual machines and any user-entered custom field values.
  • vcloud-sample-load.xml : Creates account IDs based on organization, vApp , and name of the VM. This also creates a lookup table mapping VM IDs to account IDs, allowing data to be correlated to vCenter data.
Last modified


This page has no custom tags.


This page has no classifications.

 (c) Copyright 2017-2020 Hewlett Packard Enterprise Development LP