Programming API 1.0 Release Notes

The Programming API allows users to write scripts and programs to automate virtual machine operations. The API is high-level, easy to use, and practical for both scripters and application programmers.

New Features in This Release

This is the first release of the Programming API. The API is packaged with VMware Server, a free virtualization product from VMware..

The Programming API includes:

• C API

  The initial release of the API is available in the C language. API functions allow you to register, power on or off virtual machines, and run programs in the guest operating systems.

• Simple Perl API

  This release also includes a simplified API available in the Perl language.

• Command-line Utility

  Included with the VMware Server download is the vmrun command-line utility, based on the Programming API.

Known Issues in This Release

• Programming API VixHost_FindItems() returns lowercase path names for virtual machines on Windows hosts (KB 3983214)
• Do not use symbolic path link names in the Programming API (KB 3569536)
• Programming API might not show current value for virtual machine power state (KB 2161166)
• Programming API CopyFileFromHostToGuest() and CopyFileFromGuestToHost() reset permission bits (KB 2318633)
• Programming API returns undefined error code in some situations (KB 3460454)
• Programming API does not always report failure of VixVM_CopyFileFromGuestToHost() (KB 3656116)
• Programming API might crash if client uses an invalid host handle (KB 2416845)
• Programming API might crash if client calls VixHost_Disconnect() twice (KB 3873816)
• Programming API can crash due to power off or power on of virtual machine (KB 4386845)
• Programming API incorrectly powers on virtual machine without execute permission (KB 7266514)
• Programming API allows client to unregister a virtual machine while it is running (KB 168882)
• Programming API VixVM_Open() function leaks memory (KB 4638719)
• VMware Tools state is Running instead of Unknown while virtual machine is suspended via Programming API script (KB 157217)
• Querying the VMware Tools state before starting the virtual machine reports an unrecognized property error (KB 9427668)
• On host without VMware Server installed, script created with Programming API can't find libcrypto.so.0.9.7 and libssl.so.0.9.7 (KB 1837104)
• VixVM_UpgradeVirtualHardware() does not return if the "Local System" account does not have permissions to the virtual machine folder (KB 1858699)
• Permissions error on Windows guest file produces incorrect error report (KB 7079843)
• VixHost_UnregisterVM() hangs after failure to open virtual machine (KB 5273179)
• VixVM_Open() on an unregistered virtual machine can cause problems (KB 9240558)
• VixVM_Delete() on released virtual machine handle hangs and incorrectly deletes the virtual machine (KB 4194165)
• VIX_PROPERTY_VM_TOOLS_STATE is inconsistent with power state after calling VixVM_WaitForToolsInGuest() and VixVM_PowerOff() (KB 2667476)