VMware HTML Console SDK Release Notes

Release date: 27 OCT 2016 | Release number: 2.1 | Build number: 4504321
For VMware vSphere and vCloud Director. Last document update: 3 FEB 2017
Check frequently for additions and updates to these release notes.


About the HTML Console SDK

The HTML Console SDK allows developers to add virtual machine console functionality to an existing web user interface running on VMware vSphere. Through the functionality enabled by this SDK, end users can interact with the virtual machine console by typing on the keyboard and moving the mouse.

The HTML Console SDK provides APIs with the following functionality:

  • Mouse and keyboard input, including mouse scroll even without VMware Tools installed
  • Send Ctrl + Alt + Delete
  • Full screen mode
  • Supports client and guest keyboards for Japanese, German, Italian, Spanish, Portuguese (pt_pt), French, Swiss-French, and Swiss-German.

Download and Installation

The SDK is available in the Download section of the VMware website, as linked on the landing page. You can log in using your VMware Store or My VMware account.

The SDK is delivered as a ZIP file. After you download and unzip the file, you can use the Javascript and CSS directly.

See compatibility notices below for browser and OS support.

Quick Start

To see how it works, place this HTML code in a folder with the unzipped SDK.

<!DOCTYPE html PUBLIC"-//W3C//DTD XHTML 1.0 Strict//EN"
<html xmlns="http://www.w3.org/1999/xhtml"> 
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="css/wmks-all.css" /> 
<script type="text/javascript" src="http://code.jquery.com/jquery-1.8.3.min.js"></script>
<script type="text/javascript" src="http://code.jquery.com/ui/1.8.16/jquery-ui.min.js"></script>
<script type="text/javascript" src="wmks.min.js"></script> 
<div id="wmksContainer" style="position:absolute;width:100%;height:100%"></div> 
var wmks = WMKS.createWMKS("wmksContainer",{})
 .register(WMKS.CONST.Events.CONNECTION_STATE_CHANGE, function(event,data){
 if(data.state == WMKS.CONST.ConnectionState.CONNECTED){
  console.log("connection state change : connected");}

Replace ESXi.host.IP.Address with the IP address or fully-qualified hostname of the ESXi host where the virtual machine resides.

To get the webmksTicket, find the vCenter Server that manages the above ESXi host. You can get a ticket using the vSphere API, or with the managed object browser:

  1. In a browser go to https://vCenter.Server.IP.Address/mob
  2. Provide your login credentials for Administrator@vsphere.local or another SSO account
  3. Click content > rootFolder > Datacenter > vmFolder
  4. Click the VM number of the virtual machine you want to connect to
  5. Under Methods, click AcquireTicket
  6. Type webmks in the value field and click Invoke Method
  7. Copy and paste the ticket string to replace webmksTicket
  8. Double-click the above HTML file to open it in your browser.

Once you know the managed object ID (moid) of the virtual machine, you can quickly get another ticket at this URL. Replace NN with the VM number:


Compatibility Notices

The HTML Console SDK has been tested with the following Web browsers on Windows, Mac OS X, and Linux:

  • Google Chrome 30+
  • Microsoft Internet Explorer 10+
  • Mozilla Firefox 24+
  • Safari 6.1+

Recently Resolved Issues

The HTML Console 2.1 release resolves the following issues.

  • More international keyboard support.

    The HTML Console 1.0 release supported only English and Japanese keyboards. Release 2.0 added support for German, Italian, Spanish, and Portuguese keyboards. This release also supports French, Swiss-French, and Swiss-German keyboards.

  • The css and img folders went too deep.

    In the 2.0 release, style sheets in the css/css folder were not able to reference the touch-sprite images in the img/img folder. In this release all css/css style sheets and img/img images are at the correct folder level.

Known Issues and Workarounds

The following issues were found in the HTML Console 2.1 release.

  • Incomplete support for international keyboards.

    In this release no other international keyboards are supported other than Japanese, German, Italian, Spanish, Portuguese (pt_pt), French, Swiss-French, and Swiss-German.

  • HTML Console support for vCloud Director.

    Version 8.0.2 of vCloud Director (vCD) supports HTML Console 2.0. Support for HTML Console 2.1 is planned for a future vCD release.