VMware vFabric Data Director API 2.0 Release Notes

Released 10 July 2012

This document contains the following information:

About the vFabric Data Director API

The VMware vFabric Data Director API allows you to extend or build a vFabric Data Director client using Representational State Transfer (REST) calls and RESTful programming conventions.

To use the vFabric Data Director API, you must already be familiar with common database terminology, the VMware vFabric Data Director product, VMware Virtual Machine technology, and web technologies such as XML, HTTP, and REST.


These release notes apply to the 2.0 Release of vFabric Data Director API.

To use the vFabric Data Director API, install:

  • vFabric Data Director API 2.0 | 10 July 2012 | Build 760442

What’s New in This Release?

This release of the vFabric Data Director API includes the following new features:

  • Support for vFabric Data Director API schema version 2.0.0 Final

Resolved Issues

This release of the vFabric Data Director API resolves the following issues:

  • No new issues were resolved in release 2.0.

Known Issues and Workarounds

  • When you use the REST API to create a db with a dbname that contains blank spaces (such as “db name”), the creation will fail with the task error message, “The database name is not valid.”

  • The new database creation REST API requires the parameterGroupSetting, but now it will not reject a request without it, and the creation will "succeed". However, this may lead to unpredictable errors with further operation on this database. For example, an update database operation might fail with the task error message, "Update db parameter failed.".

  • For the database refresh REST API, the refreshStartTime call refers to one specific time every day when you want to perform a database refresh. Currently, you have to set the format as "Month/Date/Year HH:MM AM", or "Month/Date/Year HH:MM PM", but the date is ignored by the backend engine. Eventually, it should be changed to the format, "HH:MM AM" or "HH:MM PM".

  • The catalog DB doesn't currently support PITR cloning, so you can't update the catalog DB using the cloningConfig cloneState value "ENABLE". If you try to update the catalog DB using this value, the update operation will fail with Internal Error 500.

Important Notes

Each of the following situations will result in an error message. The message will tell you how to resolve your specific issue.

  • When you boot up Data Director in User Management mode, there are Global/Organization choices.

    • Global. All users in the system are visible to all organizations. This mode is best for use within an enterprise. In Global mode, users do not need to register for an organization to get a role from that organization.

    • Organization. Users are visible only to the organizations that they have been granted access to. This mode is best for service providers that will host multiple enterprises. In this mode, users do need to register for an organization to get a role from that organization.

  • When repairing a database, the available database storage allocation must be equal to or greater than the storage that the database has used. This is because the repair procedure will clone the database before repairing it. So you must have enough storage to create a temporary additional copy of the database.

  • You can only delete a User after you have performed the disable operation on that User.

  • You can repair a database regardless of the database status. The status for each database may change as it is being repaired. The final status is Running.

  • You can use the DatabaseCreate API with a custom db parameter group. However, you need to strictly follow each parameter entity's restrictions described in the corresponding base DB template's parameter group template. For example: The maximum value for vPostgres wal-buffers in overridenDbConfEntity is 16. If you set this value larger than 16, vPostgres creation will fail.

  • You can use the database creation REST API (POST api/databases) to import an existing database VM from one vFDD management server into another running vFDD management server. In this scenario, you can use the Data Director UI to fill in the vmRefId field with the database VM reference id.

    See the vFabric Data Director Installation Guide for more information about how to set the vmRefId using the Data Director UI.

    Contact the vFabric Data Director support team for details about how to get the reference id for a VM.