VMRC SDK Release Notes
Released 10 September 2012
Build 797625 is VMware vSphere 5.1 / vCloud Director 5.1
This document contains the following information:
- About the VMware vSphere VMRC SDK
- What's in this Release?
- Known Issues
About the VMware vSphere VMRC SDK
The VMRC SDK allows you to use a Web-based application to connect to a vCenter- or vCloud Director-managed virtual machine and access that virtual machine's console in a browser window. You can interact with the virtual machine console input and screen. You can also use the VMRC SDK to manage virtual and physical device connections on a vCenter-managed virtual machine.
To use the VMRC SDK, any Web application you create must be able to load the VMRC browser plug-in. The plug-in is supported for use with Microsoft Windows XP or later and the Linux operating system. The plug-in has been tested with the following Web browsers:
VMRC is supported by all vSphere 5.1 and ESX configurations.
- Microsoft Internet Explorer
- Mozilla Firefox
- Google Chrome
What's in this Release?
This is the initial release of the VMRC SDK for vSphere 5.1.
The following is a list of known issues you might encounter when using the VMRC SDK:
startup() and Advanced Configuration
- Windows VMRC provides only 32-bit builds for the VMRC browser plug-in.
- On the Linux operating system, the VMRC application may outlive its plug-in parent on plug-in crash.
- The connect() API method can succeed for a given virtual machine, but the console might fail to appear. This occurs when the client user has access to the virtual machine, but does not have sufficient privileges for the console.
- When using VMRC with vCloud Director, the startup() method only supports certain values for authentication and for identifying the target VM. See the full documentation for details.
- On the Linux operating system, the startup() API method does not support a mask of mode values. Client applications must pass either VMRC_MKS or VMRC_DEVICES as a mode value, but not both.
- The advanced startup() configuration flag "tunnelmks" is hard-coded to use port 443.
- On the Linux operating system, the advanced startup() configuration flags "autoanswerquestions" and "cacheconnections" are only supported when starting the VMRC plug-in with VMRC_DEVICES mode.
- When using VMRC with vCloud Director, you must include the "usebrowserproxy" and "tunnelmks" advanced configuration flags, both set to TRUE.
- For the connectDevice() API method to succeed, a virtual device must be configured to support client-device connections (the "clientBacking" detail must be true). Clients can use the VIM API to re-configure virtual devices to support client-device backings.
- If a virtual device is connected to a client backing, but the device detail "connectedByMe" is false, VMRC cannot determine the backing type. The API method getVirtualDeviceDetails() returns VMRC_DeviceBacking.VMRC_DB_PHYSICAL as a dummy value in such instances.
- The API method getVirtualDeviceDetails() only returns a value for the "backingKey" detail if the "connectedByMe" detail is true.
- For virtual CD-ROM and floppy devices, the API method getVirtualDeviceDetails() only returns a value for the "hostName" detail if the "connectedByMe" detail is true.
- The API method disconnectDevice() only supports the same virtual or physical device keys used when calling connectDevice(). For non-USB devices, client applications must supply the virtual device key for the remote CD-ROM or floppy device to disconnect. For USB devices, client applications must supply the physical device key of the USB device to disconnect.
- The "virtualKey" and "physicalKey" device details provided in the onDeviceStateChange() API event are incorrect for USB devices.
- vCloud Director 5.1 does not support USB devices with VMRC.