SDK Versions and Compatibility

When you write plug-ins intended to interact with different versions of vCenter Server, you need to plan for compatibility between vCenter Server, the vSphere Client SDK, and your plug-in code. Version compatibility can also become an issue when you upgrade from an older version of the vSphere Client SDK.

The vSphere Client SDK team frequently updates the SDK to contain the latest tools and samples, especially to illustrate new features and capabilities. As a result, the latest version of the SDK is not always compatible with earlier versions of vCenter Server.

Plug-in extensibility features and the vSphere Client JavaScript API remain compatible between one version of vCenter Server and the next. Your plug-in can interact with different versions of vCenter Server if it uses only the extension points and API calls supported by each version.

You can refer to the following table for more information about the compatibility of the plug-ins you developed with the different versions of the vSphere Client SDK.

Note: * If you have HTML-based plug-ins that are created with the vSphere Web Client SDK 6.0, you must follow the steps for upgrading your plug-in to ensure compatibility with the 6.5 versions of the vSphere Web Client and the vSphere Client.
Table 1. Compatibility Between JavaScript APIs and vSphere Client Versions
Version of the vSphere Client vSphere 7.0/6.7/6.5 U2 JavaScript API vSphere 6.0/6.5 Bridge API
version 6.0 No Yes
version 6.5 No Yes
version 6.5 U2 Yes Yes
version 6.7 Yes Yes
version 7.0 Yes Yes
Note: The Bridge API is deprecated in the vSphere 6.7 release and the vSphere 6.5 U2 release. VMware will discontinue support for the Bridge API in a future vSphere Client release.